Version: 2021.2
LanguageEnglish
  • C#

GlobalKeyword

struct in UnityEngine.Rendering

/

Implemented in:UnityEngine.CoreModule

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

Description

Represents a global shader keyword.

Shader keywords determine which shader variants Unity uses. You can use a GlobalKeyword to enable, disable, or check the state state of a global shader keyword. For information on working with local shader keywords and global shader keywords and how they interact, see Using shader keywords with C# scripts.

To set the state of a global shader keyword, use Shader.SetKeyword, Shader.EnableKeyword, or Shader.DisableKeyword. To get all the global shader keywords that exist, use Shader.globalKeywords. To get all the global shader keywords that are enabled, use Shader.enabledGlobalKeywords.

In addition to this, you can also enable or disable a local or global keyword with a CommandBuffer. To do this, use CommandBuffer.SetKeyword, CommandBuffer.EnableKeyword, or CommandBuffer.DisableKeyword.

See Also: Shader variants and keywords, LocalKeyword.

Properties

nameThe name of the shader keyword. (Read Only)

Constructors

GlobalKeywordCreates and returns a GlobalKeyword struct that represents an existing global shader keyword.

Static Methods

CreateCreates and returns a GlobalKeyword that represents a new or existing global shader keyword.