Shader.IsKeywordEnabled

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

Shader.IsKeywordEnabled

Объявление

public static bool IsKeywordEnabled(ref Rendering.GlobalKeyword keyword);

Параметры

keyword GlobalKeyword для проверки.

Возвращает

bool Возвращает true, если заданное ключевое слово глобального шейдера включено. В противном случае возвращает ложь.

Описание

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

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

Если вы передаете строку, а GlobalKeyword с таким именем не существует в keywordSpace, эта функция возвращает false.

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

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

using UnityEngine;
using UnityEngine.Rendering;

public class GlobalKeywordExample : MonoBehaviour
{
    private GlobalKeyword exampleFeatureKeyword;

    private void Start()
    {
        exampleFeatureKeyword = GlobalKeyword.Create("EXAMPLE_FEATURE_ON");

        if (Shader.IsKeywordEnabled(exampleFeatureKeyword))
        {
            Debug.Log("Global shader keyword " + exampleFeatureKeyword.name + " is currently enabled");
        }
    }
}

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


Объявление

public static bool IsKeywordEnabled(string keyword);

Параметры

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

Возвращает

bool Возвращает true, если глобальное ключевое слово шейдера с заданным именем существует и включено. В противном случае возвращает ложь.

Описание

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

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

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