Material.IsKeywordEnabled

Unity · Версия 2020.3 LTS · Scripting · Material

Material.IsKeywordEnabled

Объявление

public bool IsKeywordEnabled(ref Rendering.LocalKeyword keyword);

public bool IsKeywordEnabled(string keyword);

Параметры

keyword LocalKeyword для проверки.
keyword Имя LocalKeyword для проверки..

Возвращает

bool Возвращает true, если для этого материала включено LocalKeyword с заданным именем.

Описание

Проверяет, включено ли локальное ключевое слово шейдера для этого материала.

Ключевые слова шейдера определяют, какие варианты шейдера использует Unity. Информацию о работе с ключевыми словами локального шейдера и глобальном ключевом слове шейдера и о том, как они взаимодействуют, см. в разделе Использование ключевых слов шейдера со сценариями C#.

Если вы передаете LocalKeyword, но его нет в Shader.keywordSpace для шейдера что этот материал использует, эта функция не имеет никакого эффекта. Если вы передаете строку, а LocalKeyword с таким именем не существует в Shader.keywordSpace для шейдера, который использует этот материал, эта функция не действует.

Версия этой функции, принимающая в качестве параметра строку, работает медленнее, чем версия, принимающая LocalKeyword. Если вы вызываете эту функцию более одного раза, рекомендуется создать структуру LocalKeyword, кэшировать ее и использовать.

Примечание. LocalKeyword относится к одному Shader или ComputeShader. Вы не можете использовать его с другими экземплярами Shader или ComputeShader, даже если они объявляют ключевые слова с тем же именем.

В этом примере перебираются локальные ключевые слова шейдера в локальном пространстве ключевых слов для материала. Он определяет, переопределены ли они глобальным ключевым словом шейдера, и выводит их состояние.

using UnityEngine;
using UnityEngine.Rendering;

public class KeywordExample : MonoBehaviour
{
    public Material material;

    void Start()
    {
        CheckShaderKeywordState();
    }

    void CheckShaderKeywordState()
    {
        // Get the instance of the Shader class that the material uses
        var shader = material.shader;

        // Get all the local keywords that affect the Shader
        var keywordSpace = shader.keywordSpace;

        // Iterate over the local keywords
        foreach (var localKeyword in keywordSpace.keywords)
        {
            // If the local keyword is overridable,
            // and a global keyword with the same name exists and is enabled,
            // then Unity uses the global keyword state
            if (localKeyword.isOverridable && Shader.IsKeywordEnabled(localKeyword.name))
            {
                Debug.Log("Local keyword with name of " + localKeyword.name + " is overridden by a global keyword, and is enabled");
            }
            // Otherwise, Unity uses the local keyword state
            else
            {
                var state = material.IsKeywordEnabled(localKeyword) ? "enabled" : "disabled";
                Debug.Log("Local keyword with name of " + localKeyword.name + " is " + state);
            }
        }
    }
}

Смотрите так же: Shader variants and keywords, LocalKeyword, GlobalKeyword, EnableKeyword, DisableKeyword, SetKeyword, Shader.keywordSpace, enabledKeywords, shaderKeywords.

Обновлено 17 ноября 2026 г.