Version: 2023.2
LanguageEnglish
  • C#

CommandBuffer.SetKeyword

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 void SetKeyword(ref Rendering.GlobalKeyword keyword, bool value);

Declaration

public void SetKeyword(Material material, ref Rendering.LocalKeyword keyword, bool value);

Declaration

public void SetKeyword(ComputeShader computeShader, ref Rendering.LocalKeyword keyword, bool value);

Parameters

keyword The local or global shader keyword to set the state for.
material The material for which to set the state of the local shader keyword.
computeShader The compute shader for which to set the state of the local shader keyword.
value The state to set the shader keyword state to.

Description

Adds a command to set the state of a global or local shader keyword.

Shader keywords determine which shader variants Unity uses. For information on working with local shader keywords and global shader keywords and how they interact, see Using shader keywords with C# scripts.

Additional resources: Shader variants and keywords, DisableKeyword, EnableKeyword, GlobalKeyword, LocalKeyword, Shader.SetKeyword, Material.SetKeyword, ComputeShader.SetKeyword.