From faac7cf359a948b84f5cfa0603e39058cfcb0f1e Mon Sep 17 00:00:00 2001 From: yuantianle Date: Tue, 8 Oct 2024 23:33:45 -0700 Subject: [PATCH] Formated unity shader graph module and added svg for main page. --- source/_posts/unity-shader-graph.md | 364 +++++++++++++++++++--- source/assets/icon/unity-shader-graph.svg | 1 + 2 files changed, 319 insertions(+), 46 deletions(-) create mode 100644 source/assets/icon/unity-shader-graph.svg diff --git a/source/_posts/unity-shader-graph.md b/source/_posts/unity-shader-graph.md index 63cadcf..ac4c1d3 100644 --- a/source/_posts/unity-shader-graph.md +++ b/source/_posts/unity-shader-graph.md @@ -1,5 +1,5 @@ --- -title: Unity Shader Graph +title: 🕹️ Unity Shader Graph date: 2024-08-10 12:15:05 background: bg-[#7c7c7c] label: @@ -14,74 +14,346 @@ intro: | This is a visual cheat-sheet for the Unity Shader Graph. This tool is used to create custom shaders material in Unity, a popular game engine. --- -## Shader Graph Nodes +## Shader Graph Nodes {.cols-2} -### Basic Nodes +We are using **SAIT** to indicate the output type is "same as the input type". {.col-span-2} -| Node | Action | -| ------------- | ----------------------------------------- | -| `Position` | Provides vertex position | -| `Normal` | Supplies surface normal direction | -| `Time` | Outputs time values | -| `Multiply` | Multiplies two values | -| `Lerp` | Linear interpolation between two values | -| `Step` | Creates a step between two thresholds | +### Basic Nodes -{.shortcuts} +Position - provides vertex position {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | None | No inputs | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Vector3`| Provides vertex position| +{.shortcuts .marker-round .cols-2} + +Normal - supplies surface normal direction {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | None | No inputs | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Vector3`| Provides surface normal | +{.shortcuts .marker-round .cols-2} + +Time - outputs time values {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | None | No inputs | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Float` | Outputs time values | +{.shortcuts .marker-round .cols-2} + +Multiply - multiplies two values {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | `Float`, `Vector`, `Matrix` | First value | + | `Float`, `Vector`, `Matrix` | Second value| +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | SAIT | The product of the two inputs | +{.shortcuts .marker-round .cols-2} + +Lerp - linear interpolation between two values {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | `Float` | Start value | + | `Float` | End value | + | `Float` | Interpolation factor (T)| +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Float` | Interpolated result | +{.shortcuts .marker-round .cols-2} + +Step - creates a step between two thresholds {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | `Float` | Threshold | + | `Float` | Input | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Float` | Step result | +{.shortcuts .marker-round .cols-2} ### Math Nodes -| Node | Action | -| -------------- | ----------------------------------------- | -| `Add` | Adds two values | -| `Subtract` | Subtracts one value from another | -| `Sin` | Outputs sine of input | -| `Cos` | Outputs cosine of input | -| `Power` | Raises input to a power | +Add - adds two values {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | `Float` or `Vector` | First value | + | `Float` or `Vector` | Second value | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | SAIT | Sum of the two inputs | +{.shortcuts .marker-round .cols-2} + +Subtract - subtracts one value from another {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | `Float` or `Vector` | Minuend | + | `Float` or `Vector` | Subtrahend | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | SAIT | Difference of the two inputs | +{.shortcuts .marker-round .cols-2} + +Sin - outputs sine of input {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | `Float` | Input in radians | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Float` | Sine of the input | +{.shortcuts .marker-round .cols-2} + +Cos - outputs cosine of input {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | `Float` | Input in radians | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Float` | Cosine of the input | +{.shortcuts .marker-round .cols-2} + +Power - raises input to a power {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | `Float` | Base | + | `Float` | Exponent | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Float` | Result of base raised to the power of the exponent | +{.shortcuts .marker-round .cols-2} + +Sqrt - square root of input {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | `Float` | Input value | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Float` | Square root of the input | +{.shortcuts .marker-round .cols-2} + +Abs - outputs absolute value {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | `Float` or `Vector` | Input value | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | SAIT | Absolute value of the input | +{.shortcuts .marker-round .cols-2} + -{.shortcuts} ### Texture Nodes -| Node | Action | -| ----------------- | ---------------------------------------- | -| `Sample Texture` | Retrieves color data from texture | -| `UV` | Provides UV coordinates for texture | -| `Tiling Offset` | Adjusts tiling and offset of texture | +Sample Texture - retrieves color data from texture {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | Texture (sampler) | Texture input | + | `Vector2` | UV coordinates | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Vector4` | Color data from the texture | +{.shortcuts .marker-round .cols-2} + +UV - provides UV coordinates for texture mapping {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | None | No inputs | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Vector2` | UV coordinates | +{.shortcuts .marker-round .cols-2} + +Tiling Offset - adjusts tiling and offset of texture {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | `Vector2` | Tiling values | + | `Vector2` | Offset values | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Vector2` | Modified UV coordinates | +{.shortcuts .marker-round .cols-2} + -{.shortcuts} ### Effects Nodes -| Node | Action | -| --------------- | --------------------------------------- | -| `Fresnel Effect`| Creates a glow effect on object edges | -| `Dissolve` | Generates a dissolve transition effect | -| `Distortion` | Warps object surface | +Fresnel Effect - creates a glow effect on object edges {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | `Vector3` | View direction | + | `Float` | Power of the effect | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Float` | Fresnel effect value | +{.shortcuts .marker-round .cols-2} -{.shortcuts} +Dissolve - generates a dissolve transition effect {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | Texture (sampler) | Input texture | + | `Float` | Dissolve threshold | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Vector4` | Dissolve effect output | +{.shortcuts .marker-round .cols-2} -## Custom Function Node +Distortion - warps the surface of the object {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | `Float` | Distortion strength | + | `Vector2` | UV coordinates | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Vector2` | Warped UV coordinates | +{.shortcuts .marker-round .cols-2} -### Steps to Create a Custom Function Node: +Reflection - reflects based on surface normal direction {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | `Vector3` | Incident direction | + | `Vector3` | Surface normal | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Vector3` | Reflected direction | +{.shortcuts .marker-round .cols-2} + + + +### Advanced Nodes + +World Position - returns the object's world space position {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | None | No inputs | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Vector3` | World space position | +{.shortcuts .marker-round .cols-2} + +Object Position - returns the object's local space position {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | None | No inputs | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Vector3` | Local space position | +{.shortcuts .marker-round .cols-2} + +Screen Position - returns the object's screen space position {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | None | No inputs | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Vector4` | Screen space position | +{.shortcuts .marker-round .cols-2} + +Parallax - simulates depth using parallax mapping {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | Texture (sampler) | Input texture | + | `Vector2` | UV coordinates | + | `Float` | Depth value | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Vector2` | Adjusted UV coordinates| +{.shortcuts .marker-round .cols-2} + +Camera Position - returns the camera's world space position {.cols-2} +- **Inputs** + - |-|-| + | -------- | ---------------------- | + | None | No inputs | +- **Outputs** + - |-|-| + | -------- | ---------------------- | + | `Vector3` | Camera world space position | +{.shortcuts .marker-round .cols-2} + + +### Custom Function Node + +#### Steps to Create a Custom Function Node: + +- **Add Custom Function Node** - **Step 1. Add Custom Function Node** - - Right-click in Shader Graph and choose **"Create Node"** > **"Custom Function"**. - **Step 2. Configure Node** - - Set a name for the node and choose between **"String"** (inline code) or **"File"** (external HLSL file). +- **Configure the Node** + - Set a name and choose between **"String"** (inline code) or **"File"** (external HLSL file). - **Step 3. Add Inputs/Outputs** - - Define inputs (e.g., float, vector) and outputs as needed. +- **Add Inputs/Outputs**: Define inputs (e.g., float, vector) and outputs. Example: + - **Inputs**: Float (time), Vector3 (position) + - **Outputs**: Vector3 (new position) - **Step 4. Write Shader Code** - - Enter the custom HLSL code in the appropriate field. +- **Write Shader Code**: Enter the custom HLSL code. Example: - **Step 5. Utilize the Node** - - Integrate the custom node into your shader graph for custom behavior. + ```hlsl + float3 CustomPosition(float time, float3 position) { + return position + float3(sin(time), cos(time), 0.0); + } + ``` + +- **Use the Node**: Integrate the custom node into your shader graph. + +{.marker-timeline} ## Also see {.cols-1} -- [Unity Shader Graph documentation](https://docs.unity3d.com/Manual/shader-graph-overview.html) - _(docs.unity3d.com)_ \ No newline at end of file +- [Unity Shader Graph documentation](https://docs.unity3d.com/Manual/shader-graph-overview.html) _(docs.unity3d.com)_ +- [Tianle Yuan's Unity Visual Effect notes](https://yuantianle.github.io/11_Game_Development/Unity/) + _(yuantianle.com)_ diff --git a/source/assets/icon/unity-shader-graph.svg b/source/assets/icon/unity-shader-graph.svg new file mode 100644 index 0000000..4706a30 --- /dev/null +++ b/source/assets/icon/unity-shader-graph.svg @@ -0,0 +1 @@ + \ No newline at end of file