EnableKeyword
Enables a global shader keyword.
Read time 2 minutesLast updated 4 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
EnableKeyword(string)
Enables a global shader keyword.
public static void EnableKeyword(string keyword)
Parameters
The GlobalKeyword to enable.
Remarks
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 the given name does not exist, this function automatically creates it.
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.
The keyword is case-sensitive.
The following example creates a struct with the name , and caches it. It provides functions to enable and disable it.
GlobalKeywordEXAMPLE_FEATURE_ONusing UnityEngine;using UnityEngine.Rendering;public class GlobalKeywordExample : MonoBehaviour{ private GlobalKeyword exampleFeatureKeyword; private void Start() { exampleFeatureKeyword = GlobalKeyword.Create("EXAMPLE_FEATURE_ON"); } public void EnableExampleFeature() { Shader.EnableKeyword(exampleFeatureKeyword); } public void DisableExampleFeature() { Shader.DisableKeyword(exampleFeatureKeyword); }}
Additional Resources: Shader variants and keywords, LocalKeyword, GlobalKeyword, Shader.DisableKeyword, Shader.SetKeyword, Shader.IsKeywordEnabled, Shader.enabledGlobalKeywords, Shader.globalKeywords.
EnableKeyword(GlobalKeyword)
Enables a global shader keyword.
public static void EnableKeyword(in GlobalKeyword keyword)
Parameters
The GlobalKeyword to enable.
Remarks
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 the given name does not exist, this function automatically creates it.
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.
The keyword is case-sensitive.
The following example creates a struct with the name , and caches it. It provides functions to enable and disable it.
GlobalKeywordEXAMPLE_FEATURE_ONusing UnityEngine;using UnityEngine.Rendering;public class GlobalKeywordExample : MonoBehaviour{ private GlobalKeyword exampleFeatureKeyword; private void Start() { exampleFeatureKeyword = GlobalKeyword.Create("EXAMPLE_FEATURE_ON"); } public void EnableExampleFeature() { Shader.EnableKeyword(exampleFeatureKeyword); } public void DisableExampleFeature() { Shader.DisableKeyword(exampleFeatureKeyword); }}
Additional Resources: Shader variants and keywords, LocalKeyword, GlobalKeyword, Shader.DisableKeyword, Shader.SetKeyword, Shader.IsKeywordEnabled, Shader.enabledGlobalKeywords, Shader.globalKeywords.