PassHasKeyword
Checks whether a local shader keyword is valid for a Pass within a particular shader.
Read time 2 minutesLast updated 4 days ago
Definition
- Type: Method
- Namespace: UnityEditor
- Assembly: UnityEditor
PassHasKeyword(Shader, PassIdentifier, LocalKeyword)
Checks whether a local shader keyword is valid for a Pass within a particular shader.
public static bool PassHasKeyword(Shader s, in PassIdentifier passIdentifier, in LocalKeyword keyword)
Parameters
The shader the Pass belongs to.
The identifier of a Pass within the given shader.
The local shader keyword to check.
Returns
Type | Description |
|---|---|
| bool | Returns true if the keyword is valid for the given Pass. Otherwise, returns false. If the PassIdentifier you use is invalid, this function returns false and Unity displays an error in the Console window. |
Remarks
Additional Resources: Pass.
PassHasKeyword(Shader, PassIdentifier, LocalKeyword, ShaderType)
Checks whether a local shader keyword is valid for a particular shader stage of a Pass within a particular shader.
public static bool PassHasKeyword(Shader s, in PassIdentifier passIdentifier, in LocalKeyword keyword, ShaderType shaderType)
Parameters
The shader the Pass belongs to.
The identifier of a Pass within the given shader.
The local shader keyword to check.
The shader stage of the given pass.
Returns
Type | Description |
|---|---|
| bool | Returns true if the keyword is valid for the given shader stage of the Pass. Otherwise, returns false. If the PassIdentifier you use is invalid, this function returns false and Unity displays an error in the Console window. |
Remarks
Additional Resources: Pass.
PassHasKeyword(Shader, PassIdentifier, LocalKeyword, ShaderType, ShaderCompilerPlatform)
Checks whether a local shader keyword is valid for a particular shader stage of a Pass within a particular shader for the given shader compiler platform.
public static bool PassHasKeyword(Shader s, in PassIdentifier passIdentifier, in LocalKeyword keyword, ShaderType shaderType, ShaderCompilerPlatform shaderCompilerPlatform)
Parameters
The shader the Pass belongs to.
The identifier of a Pass within the given shader.
The local shader keyword to check.
The shader stage of the given pass.
The shader compiler platform to check against.
Returns
Type | Description |
|---|---|
| bool | Returns true if the keyword is valid for the given shader stage of the Pass for the given ShaderCompilerPlatform. Otherwise, returns false. If the PassIdentifier you use is invalid, this function returns false and Unity displays an error in the Console window. |
Remarks
Some shader compiler platforms combine several shader stages in one. This method overload ensures that correct data is returned for all shader compiler platforms.
Additional Resources: Pass.