GlobalKeyword
Represents a global shader keyword.
Read time 1 minuteLast updated 5 days ago
Definition
- Type: Struct
- Namespace: UnityEngine.Rendering
- Assembly: UnityEngine.CoreModule
public readonly struct GlobalKeyword
Remarks
Shader keywords determine which shader variants Unity uses. You can use a to enable, disable, or check the state of a global shader keyword. For information on working with local shader keywords and global shader keywords and how they interact, see Using shader keywords with C# scripts.
GlobalKeywordTo set the state of a global shader keyword, use Shader.SetKeyword, Shader.EnableKeyword, or Shader.DisableKeyword. To get all the global shader keywords that exist, use Shader.globalKeywords. To get all the global shader keywords that are enabled, use Shader.enabledGlobalKeywords.
In addition to this, you can also enable or disable a local or global keyword with a . To do this, use CommandBuffer.SetKeyword, CommandBuffer.EnableKeyword, or CommandBuffer.DisableKeyword.
CommandBufferAdditional Resources: Shader variants and keywords, LocalKeyword.
Constructors
Constructor | Description |
|---|---|
| GlobalKeyword(System.String) | Creates and returns a GlobalKeyword struct that represents an existing global shader keyword. |
Properties
Property | Description |
|---|---|
| name | The name of the shader keyword. (Read Only) |
Static Methods
Method | Description |
|---|---|
| Create | Creates and returns a GlobalKeyword that represents a new or existing global shader keyword. |