ShaderKeyword

struct in UnityEngine.Rendering

/

Implemented in:UnityEngine.CoreModule

Description

Represents an identifier for a specific code path in a shader.

Unity now provides the LocalKeyword and GlobalKeyword APIs which are more performant than ShaderKeyword. It is best practice to use these APIs instead.

Additional resources: LocalKeyword, GlobalKeyword, ShaderKeywordSet, Shader.EnableKeyword, Shader variants and keywords, Declaring and using shader keywords in HLSL.

Properties

indexThe index of the shader keyword.
nameThe name of the shader keyword. (Read Only)

Constructors

ShaderKeywordInitializes a new instance of the ShaderKeyword class from a shader global keyword name.

Public Methods

IsValidChecks whether the global shader keyword exists.

Static Methods

GetGlobalKeywordTypeReturns the type of global keyword: built-in or user defined.
IsKeywordLocalReturns true if the keyword is local.

Did you find this page useful? Please give it a rating: