struct in UnityEngine.Rendering
/
Implemented in:UnityEngine.CoreModule
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseRepresents an identifier for a specific code path in a shader.
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.
| Property | Description |
|---|---|
| index | The index of the shader keyword. |
| name | The name of the shader keyword. (Read Only) |
| Constructor | Description |
|---|---|
| ShaderKeyword | Initializes a new instance of the ShaderKeyword class from a shader global keyword name. |
| Method | Description |
|---|---|
| IsValid | Checks whether the global shader keyword exists. |
| Method | Description |
|---|---|
| GetGlobalKeywordType | Returns the type of global keyword: built-in or user defined. |
| IsKeywordLocal | Returns true if the keyword is local. |
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.