Skip to content

Commit 8187d6c

Browse files
svc-reach-platform-supportEvergreen
svc-reach-platform-support
authored and
Evergreen
committed
[Port] [2021.3] [Port] [2022.3] DOCG-6833 Add missing landing pages to VFX Graph manual
1 parent 1d341c1 commit 8187d6c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+823
-64
lines changed

‎Packages/com.unity.visualeffectgraph/Documentation~/Arithmetic.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Arithmetic Operators
2+
3+
Perform mathematical calculations on input data.
4+
5+
| **Page** | **Description** |
6+
| --- | --- |
7+
| [Absolute](Operator-Absolute.md) | Calculate the absolute value of an input. |
8+
| [Add](Operator-Add.md) | Calculate the sum of all inputs. |
9+
| [Divide](Operator-Divide.md) | Divide the first input sequentially by all other inputs. |
10+
| [Fractional](Operator-Fractional.md) | Extract the fractional part of an input. |
11+
| [Inverse Lerp](Operator-InverseLerp.md) | Calculate the fraction representing how far a value is between two values. |
12+
| [Lerp](Operator-Lerp.md) | Calculate a linear interpolation between two values. |
13+
| [Modulo](Operator-Modulo.md) | Calculate the remainder of dividing of one value by another. |
14+
| [Multiply](Operator-Multiply.md) | Multiply all inputs together. |
15+
| [Negate](Operator-Negate.md) | Multiply an input value by -1 to invert its sign. |
16+
| [One Minus](Operator-OneMinus.md) | Subtract an input value from one. |
17+
| [Power](Operator-Power.md) | Raise one input to the power of another input. |
18+
| [Reciprocal](Operator-Reciprocal.md) | Calculate the result of dividing 1 by an input value. |
19+
| [Sign](Operator-Sign.md) | Return whether an input is positive, negative, or 0. |
20+
| [Smoothstep](Operator-Smoothstep.md) | Calculate smooth Hermite interpolation between two values. |
21+
| [Square Root](Operator-SquareRoot.md) | Calculate the square root of an input. |
22+
| [Step](Operator-Step.md) | Compare an input value to a threshold and return whether an input is above or below the threshold |
23+
| [Subtract](Operator-Subtract.md) | Subtract one or more inputs from another input. |
24+
25+
## Additional resources
26+
27+
- [Clamp](Clamp.md)
28+
- [Remap](Remap.md)
29+
- [Math](Math.md)
30+
31+

‎Packages/com.unity.visualeffectgraph/Documentation~/Attribute.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Attribute Blocks
2+
3+
Write values to the [Attributes](Attributes.md) of particles.
4+
5+
| **Page** | **Description** |
6+
| --- | --- |
7+
| [Curve](Block-SetAttributeFromCurve.md) | Write values to an attribute based on a sample from an Animation Curve or Gradient. |
8+
| [Derived > Calculate Mass from Volume](Block-CalculateMassFromVolume.md) | Set the mass of a particle based on its scale and density. |
9+
| [Map](Block-SetAttributeFromMap.md) | Sample data from textures and store them in attributes. |
10+
| [Set](Block-SetAttribute.md) | Write values to an attribute directly, or use random modes to set attributes to random values. |
11+
12+
## Additional resources
13+
14+
- [Attributes](Attributes.md)
15+
- [Standard Attribute Reference](Reference-Attributes.md)

‎Packages/com.unity.visualeffectgraph/Documentation~/Bitwise.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Bitwise Operators
2+
3+
Perform bitwise logical operations on inputs.
4+
5+
| **Page** | **Description** |
6+
| --- | --- |
7+
| [And](Operator-BitwiseAnd.md) | Perform a bitwise AND operation, which outputs 1 if both bits are 1. |
8+
| [Complement](Operator-BitwiseComplement.md) | Perform a bitwise NOT operation to invert each bit. |
9+
| [Left Shift](Operator-BitwiseLeftShift.md) | Shift an input value left by a specified number of bits. |
10+
| [Or](Operator-BitwiseOr.md) | Perform a bitwise OR operation, which outputs 1 if either bit is 1. |
11+
| [Right Shift](Operator-BitwiseRightShift.md) | Shift an input value right by a specified number of bits. |
12+
| [Xor](Operator-BitwiseXor.md) | Perform a bitwise XOR operation, which outputs 1 if only one bit is 1. |
13+
14+
## Additional resources
15+
16+
- [Logic Operators](Logic.md)
17+
- [Math Operators](Math.md)
18+

‎Packages/com.unity.visualeffectgraph/Documentation~/Block-Collision-LandingPage.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Collision Blocks reference
2+
3+
Configure how particles collide with shapes or the depth buffer.
4+
5+
| **Page** | **Description** |
6+
| --- | --- |
7+
| [Collide with AABox](Block-CollideWithAABox.md) | Define an axis-aligned box volume that particles collide with. |
8+
| [Collide with Cone](Block-CollideWithCone.md) | Define a truncated cone volume that particles collide with. |
9+
| [Collide with Depth Buffer](Block-CollideWithDepthBuffer.md) | Make particles collide with the depth buffer of a camera. |
10+
| [Collide with Plane](Block-CollideWithPlane.md) | Define a flat plane with infinite extents that particles collide with. |
11+
| [Collide with Signed Distance Field](Block-CollideWithSignedDistanceField.md) | Create a complex shape that particles collide with. |
12+
| [Collide with Sphere](Block-CollideWithSphere.md) | Define a spherical volume that particles collide with. |
13+
14+
## Additional resources
15+
16+
- [Signed Distance Fields in the Visual Effect Graph](sdf-in-vfx-graph.md)
17+
- [VFX Graph Learning Templates](https://www.youtube.com/watch?v=DKVdg8DsIVY) on the Unity YouTube channel

‎Packages/com.unity.visualeffectgraph/Documentation~/Block-SetPositionShape-LandingPage.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Set Position Blocks reference
2+
3+
Configure particle positions based on an input.
4+
5+
| **Page** | **Description** |
6+
|-|-|
7+
| [Set Position (Depth)](Block-SetPosition(Depth).md) | Explore the properties of the Set Position (Depth) block. |
8+
| [Set Position (Mesh)](Block-SetPosition(Mesh).md) | Calculate a position based on mesh vertex data. |
9+
| [Set Position (Signed Distance Field)](Block-SetPosition(SignedDistanceField).md) | Explore the properties of the Set Position (Signed Distance Field) block. |
10+
| [Set Position (Skinned Mesh)](Block-SetPosition(Mesh).md) | Calculate a position based on skinned mesh vertex data. |
11+
| [Set Position (Sequential : Circle)](Block-SetPosition(Sequential).md) | Use the Set Position (Sequential) block with a circle. |
12+
| [Set Position (Sequential : Line)](Block-SetPosition(Sequential).md) | Use the Set Position (Sequential) block with a line. |
13+
| [Set Position (Sequential : ThreeDimensional)](Block-SetPosition(Sequential).md) | Use the Set Position (Sequential) block with a 3D shape. |
14+
| [Set Position (Shape : AABox)](Block-SetPosition(AABox).md) | Calculate a position based on an axis-aligned box. |
15+
| [Set Position (Shape : Circle)](Block-SetPosition(Circle).md) | Calculate a position based on a circle. |
16+
| [Set Position (Shape : Cone)](Block-SetPosition(Cone).md) | Calculate a position based on a cone. |
17+
| [Set Position (Shape : Line)](Block-SetPosition(Line).md) | Calculate a position based on a line. |
18+
| [Set Position (Shape : Sphere)](Block-SetPosition(Sphere).md) | Calculate a position based on a sphere. |
19+
| [Set Position (Sequential)](Block-SetPosition(Sequential).md) | Explore the properties of the Set Position (Sequential) block. |
20+
| [Tile/Warp Positions](Block-TileWarpPositions.md) | Explore the properties of the Tile/Warp Positions block. |
21+
22+
## Additional resources
23+
24+
- [Signed Distance Fields in the Visual Effect Graph](sdf-in-vfx-graph.md)
25+
- [VFX Graph Learning Templates](https://www.youtube.com/watch?v=DKVdg8DsIVY) on the Unity YouTube channel

‎Packages/com.unity.visualeffectgraph/Documentation~/Block-UpdatePosition.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
Menu Path : **Implicit > Integration : Update Position**
44

5-
The **Integration : Update Position** Block updates particle positions based on their velocity. If the system uses the velocity attribute and you enable **Update Position** in the Update Context's Inspector, Unity implicitly adds this Block to the Context and hides it.
5+
The **Integration : Update Position** Block updates particle positions based on their velocity.
6+
7+
**Note:** If the system uses the velocity attribute and you enable **Update Position** in the Update Context's Inspector, Unity implicitly adds this Block to the Context and hides it. If you add your own **Integration : Update Position** Block too, Unity updates positions twice.
68

79
![](Images/Block-UpdatePositionInspector.png)
810

‎Packages/com.unity.visualeffectgraph/Documentation~/Block-UpdateRotation.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
Menu Path : **Implicit > Integration : Update Rotation**
44

5-
The **Integration : Update Rotation** Block updates particle orientation based on their angular velocity. If the system uses the angular velocity attribute and you enable **Update Rotation** in the Update Context's Inspector, Unity implicitly adds this Block to the Context and hides it.
5+
The **Integration : Update Rotation** Block updates particle orientation based on their angular velocity.
6+
7+
**Note:** If the system uses the angular velocity attribute and you enable **Update Rotation** in the Update Context's Inspector, Unity implicitly adds this Block to the Context and hides it. If you add your own **Integration : Update Rotation** Block too, Unity updates rotation twice.
68

79
![](Images/Block-UpdateRotationInspector.png)
810

‎Packages/com.unity.visualeffectgraph/Documentation~/Block.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Blocks
2+
3+
Control the behavior, appearance, and simulation of particles.
4+
5+
| **Page** | **Description** |
6+
| --- | --- |
7+
| [Attribute Blocks](Attribute.md) | Write values to the attributes of particles. |
8+
| [Collision Blocks](Block-Collision-LandingPage.md) | Configure how particles collide with shapes or the depth buffer. |
9+
| [Flipbook Player](Block-FlipbookPlayer.md) | Create animated particles using flipbook textures. |
10+
| [Force Blocks](Force.md) | Apply and control forces on particles, such as gravity and turbulence. |
11+
| [GPU Event](GPUEventLandingPage.md) | Spawn new particles from Trigger Blocks in Update or Initialize Contexts. |
12+
| [Implicit Integration Blocks](Implicit.md) | Explore the hidden Blocks that Visual Effect Graph uses to update the position and rotation of particles. |
13+
| [Kill Blocks](Kill.md) | Destroy particles inside or outside a shape. |
14+
| [Orientation Blocks](Orientation.md) | Change the direction that particles face. |
15+
| [Output Blocks](Output.md) | Control particle output and rendering. |
16+
| [Set Position Blocks](Block-SetPositionShape-LandingPage.md) | Configure particle positions based on an input shape. |
17+
| [Size > Screen Space Size](Block-ScreenSpaceSize.md) | Calculate the scale needed for a particle to reach a specific size. |
18+
| [Spawn Blocks](Spawn.md) | Customize behavior for spawning particles. |
19+
| [Velocity Blocks](Velocity.md) | Dynamically adjust the velocity of particles. |
20+
21+
## Additional resources
22+
23+
- [Blocks](Blocks.md)
24+
- [Graph logic and philosophy](GraphLogicAndPhilosophy.md)
25+
- [Output event handlers](OutputEventHandlers.md)
26+

‎Packages/com.unity.visualeffectgraph/Documentation~/Builtin.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Built-in Operators
2+
3+
Operators that output time, frame indices, and coordinates.
4+
5+
| **Page** | **Description** |
6+
| --- | --- |
7+
| [Delta Time](Operator-DeltaTime.md) | Get the time in seconds between the current and previous frames. |
8+
| [Frame Index](Operator-FrameIndex.md) | Get the current frame index. |
9+
| [Local to World](Operator-LocalToWorld.md) | Get a matrix that transforms a point from local space to world space. |
10+
| [System Seed](Operator-SystemSeed.md) | Get the seed used to generate random numbers. |
11+
| [Total Time](Operator-TotalTime.md) | Get the total time since the effect started. |
12+
| [World to Local](Operator-WorldToLocal.md) | Get a matrix that transforms a point from world space to local space. |
13+
14+
## Additional resources
15+
16+
- [Math Operators](Math.md)
17+
- [Attribute Blocks](Attribute.md)
18+

‎Packages/com.unity.visualeffectgraph/Documentation~/Camera.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Camera Operators
2+
3+
Output information about cameras, and convert between view space and world space.
4+
5+
| **Page** | **Description** |
6+
| --- | --- |
7+
| [Main Camera](Operator-MainCamera.md) | Get information about the current main camera, including integration with the active Scriptable Render Pipeline. |
8+
| [Viewport to World Point](Operator-ViewportToWorldPoint.md) | Transform a position from viewport space to world space |
9+
| [World to Viewport Point](Operator-WorldToViewportPoint.md) | Transform a position from world space to view space. |
10+
11+
## Additional resources
12+
13+
- [Coordinates](Coordinates.md)
14+
- [Geometry](Geometry.md)
15+
- [Built-in Operators](Builtin.md)

0 commit comments

Comments
 (0)