Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

LocalKeyword

Initializes and returns a LocalKeyword struct that represents an existing local shader keyword for a given Shader.
Read time 1 minuteLast updated 7 days ago

Definition

LocalKeyword(Shader, string)

Initializes and returns a LocalKeyword struct that represents an existing local shader keyword for a given Shader.
public LocalKeyword(Shader shader, string name)

Parameters

shader

Shader
The Shader to use.

name

string
The name of the local shader keyword.

Remarks

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.

LocalKeyword(ComputeShader, string)

Initializes and returns a LocalKeyword struct that represents an existing local shader keyword for a given ComputeShader.
public LocalKeyword(ComputeShader shader, string name)

Parameters

shader

ComputeShader
The ComputeShader to use.

name

string
The name of the local shader keyword.

Remarks

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.