Version: 2022.3
LanguageEnglish
  • C#

Shader.DisableKeyword

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Declaration

public static void DisableKeyword(ref Rendering.GlobalKeyword keyword);

Declaration

public static void DisableKeyword(string keyword);

Parameters

keyword The GlobalKeyword to disable.
keyword The name of the GlobalKeyword to disable.

Description

Disables a global shader keyword.

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.

If you pass a string and a GlobalKeyword with the given name does not exist, this function has no effect.

The version of this function that takes a string as a parameter is slower than the version that takes a GlobalKeyword. If you call this function more than once, it is best practice to create a GlobalKeyword struct, cache it, and use that.

The following example creates a GlobalKeyword struct with the name EXAMPLE_FEATURE_ON, and caches it. It provides functions to enable and disable it.

using UnityEngine;
using UnityEngine.Rendering;

public class GlobalKeywordExample : MonoBehaviour { private GlobalKeyword exampleFeatureKeyword;

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

public void EnableExampleFeature() { Shader.EnableKeyword(exampleFeatureKeyword); }

public void DisableExampleFeature() { Shader.DisableKeyword(exampleFeatureKeyword); } }
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961