Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


GetPassKeywords

Gets the local shader keywords that are valid for a Pass within a particular shader.
Read time 2 minutesLast updated 10 days ago

Definition

  • Type: Method
  • Namespace: UnityEditor
  • Assembly: UnityEditor

GetPassKeywords(Shader, PassIdentifier)

Gets the local shader keywords that are valid for a Pass within a particular shader.
public static LocalKeyword[] GetPassKeywords(Shader s, in PassIdentifier passIdentifier)

Parameters

The shader the Pass belongs to.

passIdentifier

The identifier of a Pass within the given shader.

Returns

Type

Description

LocalKeyword[]Returns an array of LocalKeywords that are valid for the Pass you identify. If the PassIdentifier you use is invalid, this function returns an empty array and Unity displays an error in the Console window.

Remarks

Additional Resources: Pass.

GetPassKeywords(Shader, PassIdentifier, ShaderType)

Gets the local shader keywords that are valid for a specified shader stage of a Pass within a particular shader.
public static LocalKeyword[] GetPassKeywords(Shader s, in PassIdentifier passIdentifier, ShaderType shaderType)

Parameters

The shader the Pass belongs to.

passIdentifier

The identifier of a Pass within the given shader.

shaderType

The shader stage of the given Pass.

Returns

Type

Description

LocalKeyword[]Returns an array of LocalKeywords that are valid for the given shader stage of the Pass you identify. If the PassIdentifier you use is invalid, this function returns an empty array and Unity displays an error in the Console window. If the shader stage doesn't exist in the pass, this function returns an empty array.

Remarks

Additional Resources: Pass, ShaderType.

GetPassKeywords(Shader, PassIdentifier, ShaderType, ShaderCompilerPlatform)

Gets the local shader keywords that are valid for a Pass within a particular shader.
public static LocalKeyword[] GetPassKeywords(Shader s, in PassIdentifier passIdentifier, ShaderType shaderType, ShaderCompilerPlatform shaderCompilerPlatform)

Parameters

The shader the Pass belongs to.

passIdentifier

The identifier of a Pass within the given shader.

shaderType


shaderCompilerPlatform

Returns

Type

Description

LocalKeyword[]Returns an array of LocalKeywords that are valid for the Pass you identify. If the PassIdentifier you use is invalid, this function returns an empty array and Unity displays an error in the Console window.

Remarks

Additional Resources: Pass.