Version: 2021.2
  • C#


Suggest a change


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.


Submission failed

For 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.



Switch to Manual


public void DisableKeyword(ref Rendering.LocalKeyword keyword);


public void DisableKeyword(string keyword);


keyword The LocalKeyword to disable.
keyword The name of the LocalKeyword to disable.


Disables a local shader keyword for this compute shader.

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 keywordSpace, this function has no effect. If you pass a string and a LocalKeyword with that name does not exist in the keywordSpace, this function has no effect.

The 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 LocalKeyword 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.

The following example creates a LocalKeyword struct with the name EXAMPLE_FEATURE_ON, and caches it. It provides functions to enable and disable it.

using 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); } }