Version: 2022.2
LanguageEnglish
  • C#

GlobalKeyword Constructor

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

Declaration

public GlobalKeyword(string name);

Parameters

name The name of the global shader keyword.

Description

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

If a global shader keyword with the given name exists in Unity's internal list of global shader keywords, Unity creates and returns a GlobalKeyword struct to represent it. Otherwise, Unity still creates a struct, but throws an error.

To add a new global shader keyword to Unity's internal list at the same time as creating a GlobalKeyword to represent it, use GlobalKeyword.Create instead.

To get all the global shader keywords that already exist, use Shader.globalKeywords.

See Also: Shader variants and keywords, LocalKeyword, GlobalKeyword, EnableKeyword, DisableKeyword, SetKeyword, IsKeywordEnabled, enabledGlobalKeywords, globalKeywords.