Version: 2023.2
LanguageEnglish
  • C#

ShaderKeyword 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 ShaderKeyword(string keywordName);

Parameters

keywordName The name of the keyword.

Description

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

If you call this function and a keyword with the name you pass in does not exist, Unity creates one with that name. To get all the global keywords that already exist, use Shader.globalKeywords.

Additional resources: IPreprocessShaders.OnProcessShader, IPreprocessComputeShaders.OnProcessComputeShader.


Declaration

public ShaderKeyword(Shader shader, string keywordName);

Parameters

shader The shader that declares the keyword.
keywordName The name of the keyword.

Description

Initializes a new instance of the ShaderKeyword class from a local shader keyword name.

If the shader defines a local keyword with the given name, Unity creates a valid ShaderKeyword instance that represents the local keyword. Otherwise, Unity creates an invalid ShaderKeyword instance.

Additional resources: Build.IPreprocessComputeShaders.OnProcessShader, ShaderKeyword.IsValid.


Declaration

public ShaderKeyword(ComputeShader shader, string keywordName);

Parameters

shader The compute shader that declares the local keyword.
keywordName The name of the keyword.

Description

Initializes a new instance of the ShaderKeyword class from a local shader keyword name, and the compute shader that defines that local keyword.

If the compute shader defines a local keyword with the given name, Unity creates a valid ShaderKeyword instance that represents the local keyword. Otherwise, Unity creates an invalid ShaderKeyword instance.

Additional resources: IPreprocessComputeShaders.OnProcessComputeShader, ShaderKeyword.IsValid.