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 SetKeyword(ref Rendering.LocalKeyword keyword, bool value);


keyword The LocalKeyword keyword to enable or disable.
value The desired keyword state.


Sets the state of 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.

When value is true, this function calls EnableKeyword. Otherwise, it calls DisableKeyword.

If the LocalKeyword does not exist in the keywordSpace, this function has no effect.

The following example toggles the state of all local shader keywords in a compute shader.

using UnityEngine;
using UnityEngine.Rendering;

public class Example : MonoBehaviour { public ComputeShader computeShader;

void Start() { // Get all the local keywords that affect the Compute Shader var keywordSpace = computeShader.keywordSpace;

// Iterate over the local keywords foreach (var localKeyword in keywordSpace.keywords) { // Get the current state of the local keyword bool state = computeShader.IsKeywordEnabled(localKeyword);

// Toggle the state computeShader.SetKeyword(localKeyword, !state); } } }