ShaderKeyword
Represents an identifier for a specific code path in a shader.
Read time 1 minuteLast updated 2 days ago
Definition
- Type: Struct
- Namespace: UnityEngine.Rendering
- Assembly: UnityEngine.CoreModule
public struct ShaderKeyword
Remarks
Unity now provides the LocalKeyword and GlobalKeyword APIs which are more performant than ShaderKeyword. It is best practice to use these APIs instead.
Additional Resources: LocalKeyword, GlobalKeyword, ShaderKeywordSet, Shader.EnableKeyword, Shader variants and keywords, Declaring and using shader keywords in HLSL.
Constructors
Constructor | Description |
|---|---|
| ShaderKeyword(System.String) | Initializes a new instance of the ShaderKeyword class from a shader global keyword name. |
| ShaderKeyword(UnityEngine.ComputeShader,System.String) | Initializes a new instance of the ShaderKeyword class from a local shader keyword name, and the compute shader that defines that local keyword. |
| ShaderKeyword(UnityEngine.Shader,System.String) | Initializes a new instance of the ShaderKeyword class from a local shader keyword name. |
Properties
Property | Description |
|---|---|
| index | The index of the shader keyword. |
| name | The name of the shader keyword. (Read Only) |
Methods
Method | Description |
|---|---|
| IsValid | Checks whether the global shader keyword exists. |
Static Methods
Method | Description |
|---|---|
| GetGlobalKeywordType | Returns the type of global keyword: built-in or user defined. |
| IsKeywordLocal | Returns true if the keyword is local. |