Represents a shader keyword declared in a shader source file.
Shader keywords determine which shader variants Unity uses. You can use a LocalKeyword
to enable, disable, or check the state state of a local 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.
When you declare a shader keyword in the source file for a Shader or ComputeShader, Unity represents the keyword with a LocalKeyword
and stores it in a LocalKeywordSpace.
For a Shader:
To set the state of a local shader keyword, use Material.SetKeyword, Material.EnableKeyword, or Material.DisableKeyword.
To check the state of a local shader keyword, use Material.IsKeywordEnabled or Material.enabledKeywords.
To access the LocalKeywordSpace
, use Material.shader to access the Shader that the material uses, and then use Shader.keywordSpace.
For a ComputeShader:
To set the state of a local shader keyword, use ComputeShader.SetKeyword, ComputeShader.EnableKeyword, or ComputeShader.DisableKeyword.
To check the state of a local shader keyword, use ComputeShader.IsKeywordEnabled or ComputeShader.enabledKeywords.
To access the LocalKeywordSpace
, use ComputeShader.keywordSpace.
In addition to this, you can also enable or disable a local or global keyword with a CommandBuffer
. To do this, use CommandBuffer.SetKeyword, CommandBuffer.EnableKeyword, or CommandBuffer.DisableKeyword.
Note: A LocalKeyword
is specific to a single Shader or ComputeShader instance. You cannot use it with other Shader or ComputeShader instances, even if they declare keywords with the same name
.
See Also: Shader variants and keywords, GlobalKeyword.
isOverridable | Whether this shader keyword was declared with global scope. (Read Only). |
isValid | Specifies whether this local shader keyword is valid (Read Only). |
name | The name of the shader keyword (Read Only). |
type | The type of the shader keyword (Read Only). |
LocalKeyword | Initializes and returns a LocalKeyword struct that represents an existing local shader keyword for a given Shader. |
operator != | Returns true if the shader keywords are not the same. Otherwise, returns false. |
operator == | Returns true if the shader keywords are the same. Otherwise, returns false. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.