Skip to content

Commit 352bd31

Browse files
svc-reach-platform-supportEvergreen
authored andcommitted
[Port] [6000.3] Document Shader Graph template browser
1 parent d28df3a commit 352bd31

File tree

5 files changed

+48
-25
lines changed

5 files changed

+48
-25
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
* [My first Shader Graph](First-Shader-Graph.md)
99
* [Create a new shader graph from a template](create-shader-graph-template.md)
1010
* [Shader Graph UI reference](ui-reference.md)
11+
* [Shader Graph template browser](template-browser.md)
1112
* [Shader Graph Window](Shader-Graph-Window.md)
1213
* [Blackboard](Blackboard.md)
1314
* [Main Preview](Main-Preview.md)
Lines changed: 10 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,20 @@
11
# Create a new shader graph from a template
22

3-
To create a shader graph from a template, use the Template Browser window. You can then adapt the shader graph to your needs.
3+
To create a new shader graph from a template, follow these steps:
44

5-
You can also share custom templates with your team through the Template Browser window, to maintain consistency across shaders in a project. This feature is particularly useful for projects with unique lighting setups or specific shader requirements.
5+
1. In the **Project** window, right-click and select **Create** > **Shader Graph** > **From Template**.
66

7-
The Template Browser window displays only templates that are compatible with the current project.
7+
The [template browser](template-browser.md) opens.
88

9-
# Create a new shader graph using a template
9+
1. Select the desired template and click **Create**.
1010

11-
To create a new shader graph using a template:
11+
Unity creates a new shader graph asset in your project.
1212

13-
1. In the **Project** window, right-click and select **Create** > **Shader Graph** > **From Template...**.
13+
1. Name the shader graph asset.
1414

15-
The Template Browser window opens.
15+
You can now edit the graph in the [Shader Graph window](Shader-Graph-Window.md).
1616

17-
1. Select the desired template.
17+
## Additional resources
1818

19-
Unity creates a new shader graph asset.
20-
21-
1. Name the shader graph asset and edit it.
22-
23-
## Create a custom shader graph template
24-
25-
To create a custom shader graph template:
26-
27-
1. Select a shader graph asset in your project.
28-
29-
1. In the **Inspector** window, enable **Use As Template**.
30-
31-
1. Expand the **Template** foldout (triangle).
32-
33-
1. Set the metadata that describes the template in the Template Browser window.
34-
35-
1. Click anywhere in the **Project** window to preview and save the template metadata.
19+
* [Shader Graph template browser](template-browser.md)
20+
* [Create a custom shader graph template](template-browser.md#create-a-custom-shader-graph-template)
273 KB
Loading
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Shader Graph template browser
2+
3+
The Shader Graph template browser allows you to create a new shader graph from an existing template.
4+
5+
To access the Shader Graph template browser, right-click in your Project window and select **Create** > **Shader Graph** > **From Template**.
6+
7+
![The template browser](images/template-browser.png)
8+
9+
| Label | Name | Description |
10+
| :--- | :--- | :--- |
11+
| **A** | Template list | Lists all the available templates you can select and start from to create a new shader graph. |
12+
| **B** | Template details | Displays a picture and description of the selected template. |
13+
| **C** | Action buttons | Finish the asset creation flow. The options are:<ul><li>**Create**: Creates a new shader graph asset based on the selected template.</li><li>**Cancel**: Closes the window and cancels the shader graph asset creation.</li></ul> |
14+
15+
**Note**: The template browser displays only templates that are compatible with the current project.
16+
17+
### Create a custom shader graph template
18+
19+
You can create your own shader graph templates to have them available in the template browser. You can share these templates with your team to maintain consistency across shaders, for example in projects with unique lighting setups or specific shader requirements.
20+
21+
To create a custom shader graph template, follow these steps:
22+
23+
1. In the **Project** window, select the shader graph asset you want to use as a template.
24+
25+
1. In the **Inspector** window, select **Use As Template**.
26+
27+
1. Expand the **Template** section.
28+
29+
1. Optional: Set the metadata that describes the template in the template browser: **Name**, **Category**, **Description**, **Icon**, and **Thumbnail**.
30+
31+
> [!NOTE]
32+
> By default, when you convert an existing shader graph asset into a template, you can no longer assign it to any materials through the [Material Inspector](https://docs.unity3d.com/Manual/class-Material.html). However, it remains active for materials that were already using it. To make the shader graph asset available again for any materials, enable the **Expose As Shader** option in the shader graph asset Inspector.
33+
34+
## Additional resources
35+
36+
* [Create a new shader graph from a template](create-shader-graph-template.md)

Packages/com.unity.shadergraph/Documentation~/ui-reference.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Explore the main user interface elements you need to know to create and configur
44

55
| Topic | Description |
66
| :--- | :--- |
7+
| [Shader Graph template browser](template-browser.md) | Browse the list of available templates to create your shader graphs from. |
78
| [Shader Graph Window](Shader-Graph-Window.md) | Display and edit your shader graph assets in Unity, including the Blackboard, the Main Preview, and the Graph Inspector. |
89
| [Create Node Menu](Create-Node-Menu.md) | Create nodes in your graph and create block nodes in the Master Stack. |
910
| [Graph Settings Tab](Graph-Settings-Tab.md) | Change settings that affect your shader graph as a whole. |

0 commit comments

Comments
 (0)