Version: 2021.3
LanguageEnglish
  • C#

LocalKeyword 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 LocalKeyword(Shader shader, string name);

Parameters

shader The Shader to use.
name The name of the local shader keyword.

Description

Initializes and returns a LocalKeyword struct that represents an existing local shader keyword for a given Shader.

If the Shader declares a local shader keyword with the given name, Unity creates and returns a LocalKeyword struct that represents it. Otherwise, Unity still creates a struct, but throws an error.

Additional resources: Shader variants and keywords, IPreprocessShaders.OnProcessShader.


Declaration

public LocalKeyword(ComputeShader shader, string name);

Parameters

shader The ComputeShader to use.
name The name of the local shader keyword.

Description

Initializes and returns a LocalKeyword struct that represents an existing local shader keyword for a given ComputeShader.

If the ComputeShader declares a local shader keyword with the given name, Unity creates and returns a LocalKeyword struct that represents it. Otherwise, Unity still creates a struct, but throws an error.

Additional resources: Shader variants and keywords, IPreprocessComputeShaders.OnProcessComputeShader.