ComputeShader.DisableKeyword

参数

描述

为该计算着色器禁用本地着色器关键字。

着色器关键字决定 Unity 使用哪些着色器变体。有关使用 本地着色器关键字 和 全局着色器关键字 以及它们如何交互的信息，请参阅 使用 C# 脚本中的着色器关键字。

如果您传入一个 LocalKeyword 并且它不存在于 keywordSpace 中，则此函数无效。如果您传入一个字符串并且一个具有该 name 的 LocalKeyword 不存在于 keywordSpace 中，则此函数无效。

采用字符串作为参数的函数版本比采用 LocalKeyword 的版本速度慢。如果您多次调用此函数，最佳实践是创建一个 LocalKeyword 结构体，将其缓存，并使用它。

注意: LocalKeyword 特定于单个 Shader 或 ComputeShader 实例。您不能将其与其他 Shader 或 ComputeShader 实例一起使用，即使它们声明了具有相同名称的关键字。

以下示例创建了一个名为 EXAMPLE_FEATURE_ON 的 LocalKeyword 结构体，并将其缓存。它提供启用和禁用它的函数。

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

其他资源：着色器变体和关键字，LocalKeyword，GlobalKeyword，EnableKeyword，SetKeyword，keywordSpace，IsKeywordEnabled，enabledKeywords，shaderKeywords。