Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

SetKeyword(in LocalKeyword, bool)

Sets the state of a local shader keyword for this compute shader.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule

SetKeyword(LocalKeyword, bool)

public void SetKeyword(in LocalKeyword keyword, bool value)

Parameters

keyword

LocalKeyword
The LocalKeyword keyword to enable or disable.

value

bool
The desired keyword state.

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.
When 
value
is 
true
, this function calls ComputeShader.EnableKeyword. Otherwise, it calls ComputeShader.DisableKeyword.
If the LocalKeyword does not exist in the ComputeShader.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);        }    }}
Additional Resources: Shader variants and keywords, LocalKeyword, GlobalKeyword, ComputeShader.EnableKeyword, ComputeShader.DisableKeyword, ComputeShader.keywordSpace, ComputeShader.IsKeywordEnabled, ComputeShader.enabledKeywords, ComputeShader.shaderKeywords.