keyword | The GlobalKeyword to check. |
bool Returns true if the given global shader keyword is enabled. Otherwise, returns false.
Checks whether a global shader keyword is enabled.
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.
If you pass a string and a GlobalKeyword with that name
does not exist in the keywordSpace, this function returns false
.
The version of this function that takes a string as a parameter is slower than the version that takes a GlobalKeyword. If you call this function more than once, it is best practice to create a GlobalKeyword struct, cache it, and use that.
This example checks whether a global shader keyword with the name EXAMPLE_FEATURE_ON
is enabled.
using UnityEngine; using UnityEngine.Rendering;
public class GlobalKeywordExample : MonoBehaviour { private GlobalKeyword exampleFeatureKeyword;
private void Start() { exampleFeatureKeyword = GlobalKeyword.Create("EXAMPLE_FEATURE_ON");
if (Shader.IsKeywordEnabled(exampleFeatureKeyword)) { Debug.Log("Global shader keyword " + exampleFeatureKeyword.name + " is currently enabled"); } } }
See Also: Shader variants and keywords, LocalKeyword, GlobalKeyword, EnableKeyword, DisableKeyword, SetKeyword, enabledGlobalKeywords, globalKeywords.
keyword | The name of the GlobalKeyword to check. |
bool Returns true if a global shader keyword with the given name exists, and is enabled. Otherwise, returns false.
Checks whether a global shader keyword is enabled.
If a global shader keyword with the given name does not exist, this function returns false. Otherwise, this version of IsKeywordEnabled
behaves the same as the version that has a GlobalKeyword as its parameter.
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.