Represents the local keyword space of a Shader or ComputeShader.
Shader keywords determine which shader variants Unity uses. 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, access the LocalKeywordSpace
with Shader.keywordSpace. It contains:
All keywords declared in the source file. For more information, see Declaring shader keywords.
All keywords declared in dependencies of that source file. This comprises all Shaders that are included via the Fallback command, and all keywords declared in all Passes that are included via the UsePass command.
All keywords that Unity adds automatically. For more information, see Unity's predefined shader keywords.
For a ComputeShader, access the LocalKeywordSpace
with ComputeShader.keywordSpace. It contains all keywords declared in the source file. For more information, see Declaring shader keywords.
See Also: Shader variants and keywords, LocalKeyword, GlobalKeyword, ComputeShader.keywordSpace, Shader.keywordSpace.
keywordCount | The number of local shader keywords in this local keyword space. (Read Only) |
keywordNames | An array containing the names of all local shader keywords in this local keyword space. (Read Only) |
keywords | An array containing all LocalKeyword structs in this local keyword space. (Read Only) |
FindKeyword | Searches for a local shader keyword with a given name in the keyword space. |
operator != | Returns true if the local shader keyword spaces are not the same. Otherwise, returns false. |
operator == | Returns true if the local shader keyword spaces 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.