DisableKeyword
Disables a local shader keyword for this compute shader.
Read time 3 minutesLast updated 4 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
DisableKeyword(string)
Disables a local shader keyword for this compute shader.
public void DisableKeyword(string keyword)
Parameters
The LocalKeyword to disable.
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 in a LocalKeyword and it does not exist in the ComputeShader.keywordSpace, this function has no effect. If you pass a string and a LocalKeyword with that does not exist in the ComputeShader.keywordSpace, this function has no effect.
nameThe version of this function that takes a string as a parameter is slower than the version that takes a LocalKeyword. If you call this function more than once, it is best practice to create a LocalKeyword struct, cache it, and use that.
Note: A 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.
LocalKeywordThe following example creates a struct with the name , and caches it. It provides functions to enable and disable it.
LocalKeywordEXAMPLE_FEATURE_ONusing UnityEngine;using UnityEngine.Rendering;public class ComputeKeywordExample : MonoBehaviour{ public ComputeShader computeShader; private LocalKeyword exampleFeatureKeyword; void Start() { // Create and cache the LocalKeyword exampleFeatureKeyword = new LocalKeyword(computeShader, "EXAMPLE_FEATURE_ON"); } public void EnableExampleFeature() { computeShader.EnableKeyword(exampleFeatureKeyword); } public void DisableExampleFeature() { computeShader.DisableKeyword(exampleFeatureKeyword); }}
Additional Resources: Shader variants and keywords, LocalKeyword, GlobalKeyword, ComputeShader.EnableKeyword, ComputeShader.SetKeyword, ComputeShader.keywordSpace, ComputeShader.IsKeywordEnabled, ComputeShader.enabledKeywords, ComputeShader.shaderKeywords.
DisableKeyword(LocalKeyword)
Disables a local shader keyword for this compute shader.
public void DisableKeyword(in LocalKeyword keyword)
Parameters
The LocalKeyword to disable.
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 in a LocalKeyword and it does not exist in the ComputeShader.keywordSpace, this function has no effect. If you pass a string and a LocalKeyword with that does not exist in the ComputeShader.keywordSpace, this function has no effect.
nameThe version of this function that takes a string as a parameter is slower than the version that takes a LocalKeyword. If you call this function more than once, it is best practice to create a LocalKeyword struct, cache it, and use that.
Note: A 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.
LocalKeywordThe following example creates a struct with the name , and caches it. It provides functions to enable and disable it.
LocalKeywordEXAMPLE_FEATURE_ONusing UnityEngine;using UnityEngine.Rendering;public class ComputeKeywordExample : MonoBehaviour{ public ComputeShader computeShader; private LocalKeyword exampleFeatureKeyword; void Start() { // Create and cache the LocalKeyword exampleFeatureKeyword = new LocalKeyword(computeShader, "EXAMPLE_FEATURE_ON"); } public void EnableExampleFeature() { computeShader.EnableKeyword(exampleFeatureKeyword); } public void DisableExampleFeature() { computeShader.DisableKeyword(exampleFeatureKeyword); }}
Additional Resources: Shader variants and keywords, LocalKeyword, GlobalKeyword, ComputeShader.EnableKeyword, ComputeShader.SetKeyword, ComputeShader.keywordSpace, ComputeShader.IsKeywordEnabled, ComputeShader.enabledKeywords, ComputeShader.shaderKeywords.