ComputeShader.SetKeyword

Parameters

Description

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

Additional resources: Shader variants and keywords, LocalKeyword, GlobalKeyword, EnableKeyword, DisableKeyword, keywordSpace, IsKeywordEnabled, enabledKeywords, shaderKeywords.