Skip to content

Commit 5fc843d

Browse files
Lewis Jordanjulienf-unity
authored andcommitted
Vfx/docs/new operator docs (#50)
* Added documentation for new operators * Changed bullet format.
1 parent 4d05d31 commit 5fc843d

File tree

3 files changed

+58
-0
lines changed

3 files changed

+58
-0
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Get Texture Dimensions
2+
3+
Menu Path : **Operator > Sampling > Get Texture Dimensions**
4+
5+
The Get Texture Dimensions Operator allows you to get the dimensions of a given texture.
6+
7+
This Operator handles every supported texture type in the Visual Effect Graph. It infers the input type automatically when you attach a texture to the input property. You can also manually specify the input type in the [Operator configuration](#operator-configuration).
8+
9+
## Operator properties
10+
11+
| **Input** | **Type** | **Description** |
12+
| --------- | ---------------------------------------- | --------------------------------------- |
13+
| **Tex** | [Configurable](#operator-configuration). | The texture to get the dimensions from. |
14+
15+
| **Output** | **Type** | **Description** |
16+
| ---------- | -------- | ------------------------------------------------------------ |
17+
| **width** | uint | The width of the texture. |
18+
| **height** | uint | The height of the texture. |
19+
| **depth** | uint | The depth of the texture 3D (for Texture3D types only). |
20+
| **count** | uint | The layer count in the texture array (for Texture2DArray and TextureCubeArray only). |
21+
22+
## Operator configuration
23+
24+
To view the Operator's configuration, click the **cog** icon in the Operator's header. Use the drop-down to select the type for the **Tex** port. For the list of types this property supports, see [Available types](#available-types).
25+
26+
### Available types
27+
28+
All types of textures are available for your **Texture** ports:
29+
30+
- **Texture2D**
31+
- **Texture3D**
32+
- **Texture2DArray**
33+
- **TextureCube**
34+
- **TextureCubeArray**
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Transform (Vector4)
2+
3+
Menu Path : **Operator > Math > Geometry > Transform (Vector4)**
4+
5+
The **Transform (Vector4)** Operator applies a transformation to a Vector4.
6+
7+
## Operator properties
8+
9+
| **Input** | **Type** | **Description** |
10+
| ------------- | --------- | -------------------------------------------------- |
11+
| **Transform** | Transform | The Transform this Operator applies to the Vector. |
12+
| **Vec** | Vector4 | The Vector4 this Operator transforms. |
13+
14+
| **Output** | **Type** | **Description** |
15+
| ---------- | -------- | ------------------------ |
16+
| **tVec** | Vector4 | The transformed Vector4. |

com.unity.visualeffectgraph/Documentation~/TableOfContents.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,13 @@
2727
* [Point Cache Bake Tool](PointCacheBakeTool.md)
2828
* [Spawner Callbacks](SpawnerCallbacks.md)
2929
* [Mesh Sampling](MeshSampling.md)
30+
* Node Library
31+
* Context
32+
* Operator
33+
* Math
34+
* Geometry
35+
* [Transform (Vector4)](Operator-Transform(Vector4).md)
36+
* Sampling
37+
* [Get Texture Dimensions](Operator-GetTextureDimensions.md)
3038
* Reference
3139
* [Standard Attributes](Reference-Attributes.md)

0 commit comments

Comments
 (0)