Version: 2022.1
LanguageEnglish
  • C#

ShaderKeyword

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 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.

See Also: 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.
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961