Skip to content

Commit 66725cd

Browse files
sebastienduverneEvergreen
authored andcommitted
[Port] [6000.5] Document template search, filtering, and sorting options for Shader Graph and VFX Graph
1 parent d02b3ea commit 66725cd

7 files changed

Lines changed: 116 additions & 77 deletions

File tree

Packages/com.unity.shadergraph/Documentation~/Create-Shader-Graph.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,5 @@ You can now open the asset and edit the graph in the [Shader Graph window](Shade
5555
* [Shader Graph template browser](template-browser.md)
5656
* [Create a custom shader graph template](template-browser.md#create-a-custom-shader-graph-template)
5757
* [Shader Graph window](Shader-Graph-Window.md)
58+
* [Shader Graph Asset reference](Shader-Graph-Asset.md)
59+
-54.8 KB
Loading

Packages/com.unity.shadergraph/Documentation~/template-browser.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,20 @@ The Shader Graph template browser allows you to create a new shader graph from a
44

55
To access the Shader Graph template browser, right-click in your Project window and select **Create** > **Shader Graph** > **From Template**.
66

7+
**Note**: The template browser displays only templates that are compatible with the current project.
8+
79
![The template browser](images/template-browser.png)
810

911
| Label | Name | Description |
1012
| :--- | :--- | :--- |
1113
| **A** | Template list | Lists all the available templates you can select and start from to create a new shader graph. |
1214
| **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.
15+
| **C** | Search and filtering tool | Filters the template list using the [Unity Search](https://docs.unity3d.com/Manual/search-overview.html) functionality. Type text to search templates by name or select **Add** (+) to filter templates based on specific characteristics.<br/>In addition to some of the default Unity Search options, Shader Graph includes the following filters:<ul><li>**Category**: Filters by template grouping category.</li><li>**material**: Filters by the target material type.</li><li>**renderpipeline**: Filters by render pipeline.</li><li>**vfx**: Filters by Visual Effect Graph support.</li></ul> |
16+
| **D** | Sorting tool | Sorts the templates within their respective categories. The categories remain listed in alphabetical order. The options are:<ul><li>**Sort By Name**: Lists templates in alphabetical order.</li><li>**Sort By Order**: Lists templates in Shader Graph's default order. </li><li>**Sort By Modification Date**: Lists the last modified templates first.</li><li>**Sort By Last Used**: Lists the last used templates first.</li><li>**Sort By Favorite**: Lists templates marked as favorites first.</li></ul>**Note**: To mark a template as a favorite, hover over the template in the list and select the gray star that appears. To remove a template as a favorite, select the star again. |
17+
| **E** | **Cancel** | Closes the window and cancels the shader graph asset creation. |
18+
| **F** | **Create** | Creates a new shader graph asset based on the selected template. |
1619

17-
### Create a custom shader graph template
20+
## Create a custom shader graph template
1821

1922
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.
2023

@@ -34,3 +37,4 @@ To create a custom shader graph template, follow these steps:
3437
## Additional resources
3538

3639
* [Create a new shader graph](Create-Shader-Graph.md)
40+
* [Shader Graph Asset reference](Shader-Graph-Asset.md)

Packages/com.unity.visualeffectgraph/Documentation~/GettingStarted.md

Lines changed: 31 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ For information on system requirements for the Visual Effect Graph, see [Require
1111
To install the Visual Effect Graph package:
1212

1313
1. Open a Unity project.
14-
1. Open the **Package Manager** window (**Window > Package Manager**).
14+
1. Open the **Package Manager** window (**Window** > **Package Manager**).
1515
1. In the Package Manager window, in the **Packages** field, select **Unity Registry**.
1616
1. Select **Visual Effect Graph** from the list of packages.
1717
1. In the bottom right corner of the Package Manager window, select **Install**. Unity installs Visual Effect Graph into your Project.
1818

19-
__Note:__ When using [HDRP](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@17.0/manual/index.html), VFX Graph is included with [HDRP Package](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@17.0/manual/install-hdrp.html#install-the-high-definition-rp-package) and doesn't need to be manually installed
19+
**Note:** When using [HDRP](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@17.0/manual/index.html), VFX Graph is included with [HDRP Package](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@17.0/manual/install-hdrp.html#install-the-high-definition-rp-package) and doesn't need to be manually installed
2020

2121
### Using the correct version of Visual Effect Graph
2222
Every Visual Effect Graph package works with a Scriptable Render Pipeline package of the same version. If you want to upgrade the Visual Effect Graph package, you must also upgrade the render pipeline package that you’re using.
@@ -25,28 +25,28 @@ For example, the Visual Effect Graph package version 6.5.3-preview in Package Ma
2525
version 6.5.3-preview.
2626

2727
## Creating Visual Effect Graphs
28-
To use Visual Effect Graph, you must first create a [Visual Effect Graph Asset](VisualEffectGraphAsset.md) .
2928

30-
To create a Visual Effect Graph Asset:
29+
To use Visual Effect Graph, you must first create a [Visual Effect Graph asset](VisualEffectGraphAsset.md).
3130

32-
1. In Unity, click __Assets__ &gt; __Create__ &gt; __Visual Effects__ &gt; __Visual Effect Graph__.
33-
1. Select a Template as a starting point for your new visual effect.
34-
1. Click the Create button in the bottom right corner.
31+
### From the Editor menu
3532

36-
It is also possible to create a Visual Effect Graph Asset from a [GameObject](https://docs.unity3d.com/Manual/class-GameObject.html) in the scene:
37-
1. Select the GameObject and add a [Visual Effect Component](VisualEffectComponent.md).
38-
1. Click on the "New" button next to the Asset Template field.
39-
1. Select a Template as a starting point for your new visual effect and click the create button.
33+
1. From the main menu, select **Assets** > **Create** > **Visual Effects** > **Visual Effect Graph**.
34+
1. Select a template as a starting point for your new visual effect.
35+
1. Select **Create**.
4036

41-
Finally, you can create a new Visual Effect Asset from the Visual Effect Graph window.
42-
1. Open the Visual Effect Graph window in __Window__ &gt; __Visual Effect__ &gt; __Visual Effect Graph__.
43-
1. Click on the __Create New Visual Effect Graph__ button.
44-
1. Select a Template as a starting point for your new visual effect and click the create button.
37+
### From a GameObject
4538

46-
To make a copy of a Visual Effect Graph Asset:
39+
1. Select the GameObject and add a [Visual Effect component](VisualEffectComponent.md).
40+
1. Next to the **Asset Template** property, Select **New**.
41+
1. Select a template as a starting point for your new visual effect.
42+
1. Select **Create**.
4743

48-
1. In the Project window, select the Visual Effect Asset you want to make a copy of.
49-
2. In the top navigation bar, select __Edit__ &gt; __Duplicate__. You’ve now created a copy.
44+
### From the Visual Effect Graph window
45+
46+
1. From the main menu, select **Window** > **Visual Effect** > **Visual Effect Graph** to open the Visual Effect Graph window.
47+
1. Select the **Create New Visual Effect Graph** button.
48+
1. Select a template as a starting point for your new visual effect.
49+
1. Select **Create**.
5050

5151
## Using Visual Effect Graphs in Scenes
5252

@@ -62,9 +62,9 @@ If you created a Visual Effect Asset directly from the Visual Effect Component i
6262
## Editing a Visual Effect Graph
6363
To edit Visual Effect Graph Assets in the [Visual Effect Graph window](VisualEffectGraphWindow.md) :
6464

65-
* Open the Visual Effect Graph window (menu: __Window__ &gt; __Visual Effects__) with an empty graph. This prompts you to open a Visual Effect Graph Asset.
66-
* Select an existing Visual Effect Graph Asset, and click the __Edit__ button in the Inspector. This opens the Visual Effect Graph window with the graph contained in this Asset.
67-
* Select the Visual Effect component (menu: next to the Asset template, click __Edit__). This opens the Visual Effect Graph window and with the graph contained in the referenced Asset.
65+
* Open the Visual Effect Graph window (menu: **Window** > **Visual Effects**) with an empty graph. This prompts you to open a Visual Effect Graph Asset.
66+
* Select an existing Visual Effect Graph Asset, and click the **Edit** button in the Inspector. This opens the Visual Effect Graph window with the graph contained in this Asset.
67+
* Select the Visual Effect component (menu: next to the Asset template, click **Edit**). This opens the Visual Effect Graph window and with the graph contained in the referenced Asset.
6868

6969
## Previewing a graph’s effect
7070
To preview an effect, you can:
@@ -82,8 +82,8 @@ When you attach a Visual Effect in your scene to the current graph, you can use
8282
This also allows Unity to display the correct gizmos in the scene, which makes some aspects of your effect easier to edit.
8383

8484
To attach a Visual Effect to the opened graph, you can either select the GameObject in the hierarchy, or follow these steps:
85-
1. In the matching graph, open the __Auto Attach Panel__ from the [Toolbar](VisualEffectGraphWindow.md#Toolbar).
86-
1. Click on the **Select a target** field to select a compatible GameObject that exists in the current open scene.
85+
1. In the matching graph, open the **Auto Attach Panel** from the [Toolbar](VisualEffectGraphWindow.md#Toolbar).
86+
1. Click on the**Select a target** field to select a compatible GameObject that exists in the current open scene.
8787

8888
## Manipulating graph elements
8989
When you open an Asset inside the Visual Effect Graph window, you can see and edit the graph for that specific Asset.
@@ -95,9 +95,15 @@ When you link several Blocks together, these form a Context. For more informatio
9595
Every change you make to a graph has immediate consequences on the behavior of your effect, and you can preview the changes in real time. Every time you add, remove, or connect a Node, the graph recompiles all the elements that have changed, and restarts the effect. However, changing values (for example, editing a curve) does not make Unity recompile anything and affects the simulation in real time.
9696
To add Nodes, you can either:
9797

98-
* Right-click in the graph, and select __Create Node__.
98+
* Right-click in the graph, and select **Create Node**.
9999
* Press the spacebar on your keyboard.
100100
* Click and drag an edge from an existing port, and release the click in an empty space.
101101
* Drag and drop an element from the [Blackboard](Blackboard.md) into the graph.
102102

103-
When you do any of the above actions, the __Create Node__ menu appears. Here, you can see the Nodes, Blocks, and Contexts that are compatible with that specific location in the graph.
103+
When you do any of the above actions, the **Create Node** menu appears. Here, you can see the Nodes, Blocks, and Contexts that are compatible with that specific location in the graph.
104+
105+
## Additional resources
106+
107+
* [VFX Graph template window reference](Templates-window.md)
108+
* [Visual Effect Graph window reference](VisualEffectGraphWindow.md)
109+
* [Visual Effect Graph Asset reference](VisualEffectGraphAsset.md)
-12.8 KB
Loading
Lines changed: 55 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,68 @@
1-
# VFX Graph Templates window
2-
Use the template window to create a VFX Graph asset with a predefined effect. You can use these templates as a starting point for your own effects.
3-
Each template has a description and an image to describe its behavior.
4-
This window is displayed when you create a new Visual Effect Graph from the `Create` context menu in the project browser.
1+
# VFX Graph template window
52

6-
![Template-Window](Images/templates-window.png)
3+
The VFX Graph template window allows you to create a new VFX graph from an existing template with a predefined effect. You can use these templates as a starting point for your own effects.
4+
5+
There are multiple ways to [access the VFX Graph template window](#access-the-vfx-graph-template-window).
6+
7+
**Note**: The template browser displays only templates that are compatible with the current project.
8+
9+
![The template window](Images/templates-window.png)
10+
11+
| Label | Name | Description |
12+
| :--- | :--- | :--- |
13+
| **A** | Template list | Lists all the available templates you can select and start from to create a new VFX graph.<br/><br/>**Note**: the **Install Learning Templates** button imports the [Learning Templates sample](sample-learningTemplates.md) from the Visual Effect Graph package. |
14+
| **B** | Template details | Displays a picture and description of the selected template. |
15+
| **C** | Search and filtering tool | Filters the template list using the [Unity Search](https://docs.unity3d.com/Manual/search-overview.html) functionality. Type text to search templates by name or select **Add** (+) to filter templates based on specific characteristics.<br/>In addition to some of the default Unity Search options, Visual Effect Graph allows you to filter the list by template grouping using **Category**. |
16+
| **D** | Sorting tool | Sorts the templates within their respective categories. The categories remain listed in alphabetical order. The options are:<ul><li>**Sort By Name**: Lists templates in alphabetical order.</li><li>**Sort By Order**: Lists templates in VFX Graph's default order. </li><li>**Sort By Modification Date**: Lists the last modified templates first.</li><li>**Sort By Last Used**: Lists the last used templates first.</li><li>**Sort By Favorite**: Lists templates marked as favorites first.</li></ul>**Note**: To mark a template as a favorite, hover over the template in the list and select the gray star that appears. To remove a template as a favorite, select the star again. |
17+
| **E** | **Cancel** | Closes the window and cancels the VFX graph asset creation. |
18+
| **F** | **Create** | Creates a new VFX graph asset based on the selected template. |
19+
20+
## Access the VFX Graph template window
21+
22+
### From the Project window
23+
24+
1. Right-click in your Project window.
25+
26+
1. Select **Create** > **Visual Effects** > **Visual Effect Graph**.
27+
28+
### From the VFX Graph editor toolbar
729

8-
## Open from VFX Graph editor toolbar
930
![toolbar](Images/templates-window-toolbar.png)
1031

11-
You can open the templates window from the **Add** (+) button in the VFX Graph editor toolbar. This button includes a drop-down to either `insert` a template in the current graph, or `create` a new asset file from a template.
32+
1. In the VFX Graph window's toolbar, select the drop-down arrow besides the **Add** (+) button.
1233

13-
When you insert a template, Unity places it at the center of the screen.
34+
1. Select one of the available options:
35+
* **Create from template** to create a new asset file from a template.
36+
* **Insert template** to insert a template in the current graph.
37+
38+
Once you complete a template insertion, Unity places it at the center of the VFX Graph window's workspace.
1439

1540
> [!TIP]
16-
> If you hold the `CTRL` key while you click on the **Add** (+) button, the templates window opens to create a new VFX asset.
41+
> To create a new VFX graph asset, you can also hold the `CTRL` key while you directly select **Add** (+) in the toolbar.
42+
43+
### From the VFX Graph workspace
44+
45+
1. Right-click in the VFX Graph window's workspace.
46+
47+
1. Select **Insert template**.
48+
49+
Once you complete the VFX graph asset creation, Unity inserts the template at the right-click position.
50+
51+
## Create a custom VFX graph template
52+
53+
You can create your own VFX graph templates to have them available in the template browser.
54+
55+
To create a custom VFX graph template, follow these steps:
1756

18-
## Open from the VFX Graph context menu
19-
When you right click in the VFX Graph editor window, the context menu shows the **Insert template** option, which inserts the template at the mouse position.
57+
1. In the **Project** window, select the VFX graph asset you want to use as a template.
2058

21-
## Search and filter templates
22-
The template window includes a search field to filter templates according to various criteria.
23-
The search field works the same way as with the main [Unity search window](https://docs.unity3d.com/Manual/search-window-reference.html), although there are fewer filters available.
59+
1. In the **Inspector** window, select **Use as Template**.
2460

25-
## Sort templates
26-
Next to the search field, a dropdown allows to sort templates by:
27-
- Name
28-
- Order
29-
- Modification date
30-
- Last used
31-
- Favorite
61+
1. Expand the **Template** section.
3262

33-
> [!NOTE]
34-
> The sorting is applied inside each category, but categories are always sorted by name.
63+
1. Optional: Set the metadata that describes the template in the template browser: **Name**, **Category**, **Description**, **Icon**, and **Thumbnail**.
3564

36-
## VFX Graph template Editor
65+
## Additional resources
3766

38-
When you select a [Visual Effect Asset](VisualEffectGraphAsset.md) in the Project window, the inspector displays a section dedicated to template description.
39-
To make a Visual Effect asset become a template, activate the **Use as Template** option.
40-
By default the template name is the asset name, but you can override it by editing the `Name` field.
41-
The description, icon and thumbnail fields are optional, but can help to understand the purpose of the template when browsing in the template window.
67+
* [Create a new VFX graph](GettingStarted.md)
68+
* [Visual Effect Graph Asset reference](VisualEffectGraphAsset.md)

0 commit comments

Comments
 (0)