Skip to content

Commit d27743e

Browse files
sebastienduverneEvergreen
authored andcommitted
[Port] [6000.0] Shader Graph sample documentation structure from DOCG-7573
1 parent ca74e88 commit d27743e

12 files changed

Lines changed: 61 additions & 56 deletions

Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-Feature-Examples.md

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

33
The Shader Graph Feature Examples sample content is a collection of Shader Graph assets that demonstrate how to achieve common techniques and effects in Shader Graph. The goal of this sample pack is to help users see what is required to achieve specific effects and provide examples to make it easier for users to learn.
44

5+
Each sample contains notes that describe what the shader does. Most of the shaders have their core functionality in a subgraph, so you can copy and paste them into your own shader graphs.
6+
57
The sample content is broken into the following categories:
68

79
- **Blending Masks** - these samples generate masks based on characteristics of the surface - such as height, facing angle, or distance from the camera.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Node Reference sample
2+
3+
This set of Shader Graph assets provides reference material for the nodes available in the Shader Graph node library.
4+
5+
Each graph contains a description for a specific node, examples of how it can be used, and useful tips. Some example assets also show a break-down of the math that the node is doing. You can use these samples along with the documentation to learn more about the behavior of individual nodes.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Procedural Patterns sample
2+
3+
This collection of Assets showcases various procedural techniques possible with Shader Graph. Use them directly in your Project, or edit them to create other procedural patterns.
4+
5+
This collection includes the following patterns:
6+
7+
* Bacteria
8+
* Brick
9+
* Dots
10+
* Grid
11+
* Herringbone
12+
* Hex Lattice
13+
* Houndstooth
14+
* Smooth Wave
15+
* Spiral
16+
* Stripes
17+
* Truchet
18+
* Whirl
19+
* Zig Zag

Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-Production-Ready.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
# Production Ready Shaders
1+
# Production Ready Shaders sample
22

3-
The Shader Graph Production Ready Shaders sample is a collection of Shader Graph shader assets that are ready to be used out of the box or modified to suit your needs. You can take them apart and learn from them, or just drop them directly into your project and use them as they are. The sample also includes a step-by-step tutorial for how to combine several of the shaders to create a forest stream environment.
4-
5-
The sample content is broken into the following categories:
3+
The Shader Graph Production Ready Shaders sample is a collection of Shader Graph shader assets that are ready to be used out of the box or modified to suit your needs. You can take them apart and learn from them, or just drop them directly into your project and use them as they are. The sample includes the Shader Graph versions of the HDRP and URP Lit shaders. It also includes a step-by-step tutorial for how to combine several of the shaders to create a forest stream environment.
64

75
| Topic | Description |
86
|:------|:--------------|

Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-UGUI-Shaders.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
# UGUI Shaders
2-
![The Shader Graph UGUI Shaders: A collection of Shader Graph subgraphs that serve as building blocks for building user interface elements.](images/UIToolsSample.png)
1+
# UGUI Shaders sample
32

4-
The Shader Graph UGUI Shaders sample is a collection of Shader Graph subgraphs that serve as building blocks for building user interface elements. They speed up the process of building widgets, buttons, and backgrounds for the user interface of your project. Using these tools, you can build dynamic, procedural UI elements that don’t require any texture memory and scale correctly for any resolution screen.
3+
The Shader Graph UGUI Shaders sample is a collection of Shader Graph subgraphs that you can use to build user interface elements. They speed up the process of building widgets, buttons, and backgrounds for the user interface of your project. With these tools, you can build dynamic, procedural UI elements that don’t require any texture memory and scale correctly for any resolution screen.
54

65
In addition to the subgraphs, the sample also includes example buttons, indicators, and backgrounds built using the subgraphs. The examples show how the subgraphs function in context and help you learn how to use them.
76

8-
We have two main objectives with this sample set:
7+
This sample set covers two main objectives:
98

109

1110
- Demonstrate Shader Graph’s ability to create dynamic, resolution-independent user interface elements in a wide variety of shapes and styles.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Import Shader Graph samples
2+
3+
To import a Shader Graph sample to your project:
4+
5+
1. In the main menu, go to **Window** > **Package Management** > **Package Manager**.
6+
7+
1. Select **Shader Graph** from the list of packages.
8+
9+
1. In the **Samples** section, select **Import** next to a sample.
10+
11+
To open a sample, go to the `Assets/Samples/Shader Graph/<your version>/` folder.
12+
13+
## Additional resources
14+
15+
* [Shader Graph samples](ShaderGraph-Samples.md)
Lines changed: 10 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,12 @@
11
# Shader Graph samples
22

3-
## Description
4-
5-
The Shader Graph package offers sample Assets, which you can download through **Package Manager**. When you import these samples, Unity places the files in your Project's Asset folder. The files contain examples that demonstrate how to use Shader Graph features.
6-
7-
## Add samples
8-
9-
To add samples to your project:
10-
11-
1. In the main menu, go to **Window** > **Package Management** > **Package Manager**.
12-
13-
1. Select **Shader Graph** from the list of packages.
14-
15-
1. In the **Samples** section, select **Import** next to a sample.
16-
17-
1. Open the sample assets from the `Assets/Samples/Shader Graph/<your version>/` folder.
18-
19-
## Available samples
20-
21-
The following samples are currently available for Shader Graph.
22-
23-
| Procedural Patterns |
24-
|:--------------------|
25-
|![A visual overview of Procedural Patterns](images/Patterns_Page.png) |
26-
| This collection of Assets showcases various procedural techniques possible with Shader Graph. Use them directly in your Project, or edit them to create other procedural patterns. The patterns in this collection are: Bacteria, Brick, Dots, Grid, Herringbone, Hex Lattice, Houndstooth, Smooth Wave, Spiral, Stripes, Truchet, Whirl, Zig Zag. |
27-
28-
29-
| Node Reference |
30-
|:--------------------|
31-
|![A visual overview of Node Reference](images/NodeReferenceSamples.png) |
32-
| This set of Shader Graph assets provides reference material for the nodes available in the Shader Graph node library. Each graph contains a description for a specific node, examples of how it can be used, and useful tips. Some example assets also show a break-down of the math that the node is doing. You can use these samples along with the documentation to learn more about the behavior of individual nodes. |
33-
34-
| [Feature Examples](Shader-Graph-Sample-Feature-Examples.md) |
35-
|:--------------------|
36-
|![A visual overview of Feature Examples](images/FeatureExamplesSample.png) |
37-
| This is a collection of over 30 Shader Graph files. Each file demonstrates a specific shader technique such as angle blending, triplanar projection, parallax mapping, and custom lighting. While you won’t use these shaders directly in your project, you can use them to quickly learn and understand the various techniques, and recreate them into your own work. Each file contains notes that describe what the shader is doing, and most of the shaders are set up with the core functionality contained in a subgraph that’s easy to copy and paste directly into your own shader. The sample also has extensive documentation describing each of the samples to help you learn.
38-
39-
| [Production Ready Shaders](Shader-Graph-Sample-Production-Ready.md) |
40-
|:--------------------|
41-
|![A visual example of Production Ready Shaders](images/ProductionReadySample.png) |
42-
| The Shader Graph Production Ready Shaders sample is a collection of Shader Graph shader assets that are ready to be used out of the box or modified to suit your needs. You can take them apart and learn from them, or just drop them directly into your project and use them as they are. The sample includes the Shader Graph versions of the HDRP and URP Lit shaders. It also includes a step-by-step tutorial for how to combine several of the shaders to create a forest stream environment.
43-
44-
| [UGUI Shaders](Shader-Graph-Sample-UGUI-Shaders.md) |
45-
|:--------------------|
46-
|![A visual example of UGUI Shaders](images/UIToolsSample.png) |
47-
| The Shader Graph UGUI Shaders sample is a collection of Shader Graph subgraphs that you can use to build user interface elements. They speed up the process of building widgets, buttons, and backgrounds for the user interface of your project. With these tools, you can build dynamic, procedural UI elements that don’t require any texture memory and scale correctly for any resolution screen. In addition to the subgraphs, the sample also includes example buttons, indicators, and backgrounds built with the subgraphs. The examples show how the subgraphs function in context and help you learn how to use them.
48-
3+
The Shader Graph package offers many different samples that demonstrate how to use Shader Graph features in various contexts.
4+
5+
| Topic | Description |
6+
| :--- | :--- |
7+
| [Import Shader Graph samples](ShaderGraph-Samples-Import.md) | Learn how to import the Shader Graph samples to your project. |
8+
| [Procedural Patterns sample](Shader-Graph-Sample-Procedural-Patterns.md) | Learn how to generate patterns procedurally with Shader Graph. |
9+
| [Node Reference sample](Shader-Graph-Sample-Node-Reference.md) | Learn in context about the nodes from the Shader Graph [node library](Node-Library.md). |
10+
| [Feature Examples sample](Shader-Graph-Sample-Feature-Examples.md) | Learn about shader techniques such as angle blending, triplanar projection, parallax mapping, and custom lighting. |
11+
| [Production Ready Shaders sample](Shader-Graph-Sample-Production-Ready.md) | Learn how to create production ready shader graphs that emulate terrain vegetation, rock details, water effects, weather effects, and other post-processing effects. |
12+
| [UGUI Shaders sample](Shader-Graph-Sample-UGUI-Shaders.md) | Learn how to build user interface elements with Shader Graph. |

Packages/com.unity.shadergraph/Documentation~/TableOfContents.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
* [Add a Sub Graph to a shader graph](Add-Sub-Graph-To-Shader-Graph.md)
3131
* [Add inputs and outputs to a Sub Graph](Add-Inputs-Outputs-Sub-Graph.md)
3232
* [Set default inputs for a Sub Graph](Sub-Graph-Default-Property-Values.md)
33-
* [Change the behaviour of a Sub Graph](Change-Behaviour-Sub-Graph-Dropdown.md)
33+
* [Change the behavior of a Sub Graph](Change-Behaviour-Sub-Graph-Dropdown.md)
3434
* [Sub Graph asset](Sub-graph-Asset.md)
3535
* [Sticky Notes](Sticky-Notes.md)
3636
* [Color Modes](Color-Modes.md)
@@ -311,6 +311,9 @@
311311
* [Block Nodes](Block-Node.md)
312312
* [Built In Blocks](Built-In-Blocks.md)
313313
* [Samples](ShaderGraph-Samples.md)
314+
* [Import Shader Graph samples](ShaderGraph-Samples-Import.md)
315+
* [Procedural Patterns](Shader-Graph-Sample-Procedural-Patterns.md)
316+
* [Node Reference](Shader-Graph-Sample-Node-Reference.md)
314317
* [Feature Examples](Shader-Graph-Sample-Feature-Examples.md)
315318
* [Production Ready Shaders](Shader-Graph-Sample-Production-Ready.md)
316319
* [Lit Shaders](Shader-Graph-Sample-Production-Ready-Lit.md)
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)