Skip to content

Commit ea4f4f5

Browse files
PBU3DEvergreen
authored andcommitted
Added documentation for Shader Graph Project Settings and related changes
Added documentation to fix [DOCATT-4884](https://jira.unity3d.com/browse/DOCATT-4884). New Shader Graph project settings and changes to Shader Graph preferences.
1 parent 3af6e09 commit ea4f4f5

File tree

3 files changed

+51
-6
lines changed

3 files changed

+51
-6
lines changed
Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
11
# Shader Graph Preferences
22

3-
To access the Shader Graph Project-wide settings, click **Edit** > **Preferences**, and then select **Shader Graph**.
3+
Use the Shader Graph preferences to define shader graph settings for your system. To access the Shader Graph system preferences, do the following:
4+
5+
1. From the main menu select **Edit** > **Preferences** (macOS: **Unity** > **Settings**). The **Preferences** window is displayed.
6+
2. Select **Shader Graph**.
47

58
## Settings
69

7-
| Name | Description |
8-
|:------- |:----------- |
9-
|Shader Variant Limit| Enter a value to set the maximum number of shader variants. If your graph exceeds this maximum value, Unity throws the following error: _Validation: Graph is generating too many variants. Either delete Keywords, reduce Keyword variants or increase the Shader Variant Limit in Preferences > Shader Graph._ For more information about shader variants, see [Making multiple shader program variants](https://docs.unity3d.com/Manual/SL-MultipleProgramVariants.html). |
10-
| Automatically Add or Remove Block Nodes | Toggle either on or off. If this option is on, when changing Graph Settings any needed Block nodes will be added to the Master Stack. Any incompatible Block nodes that have no incoming connections will be removed from the Master Stack. If this option is off, no Block nodes will be added to or removed from the Master Stack. |
11-
Enable Deprecated Nodes | Enable this setting to turn off warnings for deprecated nodes and properties, which also allows you to create older versions of nodes and properties. If you don't enable this setting, Shader Graph displays warnings for deprecated nodes and properties, and any new nodes and properties you create use the latest version. |
10+
| Name | Description |
11+
|:--------------------------|:----------------------------------------|
12+
| **Preview Variant Limit** | Set the maximum number of variants allowed in local projects. This is a local version of the **Shader Variant Limit** in the project settings. If your graph exceeds this maximum value, Unity returns the following error:</br> _Validation: Graph is generating too many variants. Either delete Keywords, reduce Keyword variants or increase the **Shader Variant Limit** in Preferences > Shader Graph._ </br>For more information about shader variants, refer to [Making multiple shader program variants](https://docs.unity3d.com/Manual/SL-MultipleProgramVariants.html). For more information about the Shader Variant Limit, refer to [Shader graph project settings](Shader-Graph-Project-Settings.md)|
13+
| **Automatically Add and Remove Block Nodes** | Automatically add [Block nodes](Block-Node.md) to, or remove them from, the [Master Stack](Master-Stack.md) as needed. If you select this option, any [Block nodes](Block-Node.md) that your Shader graph needs are added to the [Master Stack](Master-Stack.md) automatically. Any incompatible [Block nodes](Block-Node.md) that have no incoming connections will be removed from the [Master Stack](Master-Stack.md). If you don't select this option, no [Block nodes](Block-Node.md) are added to, or removed from, the [Master Stack](Master-Stack.md) automatically. |
14+
| **Enable Deprecated Nodes** | Disable warnings for deprecated nodes and properties. If you select this option, Shader Graph doesn't display warnings if your graph contains deprecated nodes or properties. If you don't select this option, Shader Graph displays warnings for deprecated nodes and properties, and any new nodes and properties you create use the latest version. |
15+
| **Zoom Step Size** | Control how much the camera in Shader Graph zooms each time you roll the mouse wheel. This makes it easier to control the difference in zoom speed between the touchpad and mouse. A touchpad simulates hundreds of steps, which causes very fast zooms, whereas a mouse wheel steps once with each click. |
16+
17+
## Additional resources
18+
19+
- [Making multiple shader program variants](https://docs.unity3d.com/Manual/SL-MultipleProgramVariants.html)
20+
- [Master Stack](Master-Stack.md)
21+
- [Shader graph project settings](Shader-Graph-Project-Settings.md)
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Shader Graph project settings reference
2+
3+
Use the Shader Graph project settings to define shader graph settings for your entire project. To access the Shader Graph project settings, do the following:
4+
5+
1. From the main menu select **Edit** > **Project Settings**. The **Project Settings** window is displayed.
6+
2. Select **ShaderGraph**.
7+
8+
9+
| Property | Description |
10+
|:-------------------------|:----------- |
11+
| **Shader Variant Limit** | Set the maximum number of variants allowed in the project. If your graph exceeds this maximum value, Unity returns the following error:<br/> Validation: Graph is generating too many variants. Either delete Keywords, reduce Keyword variants or increase the Shader Variant Limit in Preferences > Shader Graph. <br/>For more information about shader variants, refer to [Making multiple shader program variants](https://docs.unity3d.com/Manual/SL-MultipleProgramVariants.html). |
12+
13+
14+
## Custom Interpolator Channel Settings
15+
16+
It's impossible to limit the number of channels users can create in a Shader Graph. Use **Custom Interpolator Channel Settings** to create alerts that let users know when they're close to, or have exceeded, the channel limit for the target platform. Unity uses these settings to help Shader Graph users maintain compatibility with target platforms when using custom interpolators. For more information, refer to [Custom interpolators](Custom-Interpolators.md).
17+
18+
| Property | Description |
19+
|:-------------------------|:-----------------------------------|
20+
| **Error Threshold** | Specify the number of channels at which users are notified that they're at, or have surpassed, the channel limit. This property has a minimum value of 8 channels and must be higher than **Warning Threshold**. |
21+
| **Warning Threshold** | Specify the number of channels at which users are warned that they are close to the channel limit. This property must be lower than **Error Threshold** and between 8 and 32 channels. |
22+
23+
## Heatmap Color Mode Settings
24+
25+
You can create multiple customized heatmap values assets and swap them in and out based on the current needs of your project. Use **Heatmap Color Mode Settings** to specify which custom heatmap values asset to use for your project.
26+
27+
| Property | Description |
28+
|:------------------|:-------------------------------------------|
29+
| **Custom Values** | Specify which set of customized heatmap values to use for your project. |
30+
31+
## Additional resources
32+
33+
- [Custom interpolators](Custom-Interpolators.md)
34+
- [Making multiple shader program variants](https://docs.unity3d.com/Manual/SL-MultipleProgramVariants.html)

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
* [Preview Mode Control](Preview-Mode-Control)
1717
* [Custom Function Node](Custom-Function-Node)
1818
* [Shader Graph Preferences](Shader-Graph-Preferences)
19+
* [Shader Graph Project Settings](Shader-Graph-Project-Settings.md)
1920
* [Shader Graph Keyboard Shortcuts](Keyboard-shortcuts)
2021
* [Samples](ShaderGraph-Samples.md)
2122
* [Feature Examples](Shader-Graph-Sample-Feature-Examples.md)

0 commit comments

Comments
 (0)