Version: 2021.2
LanguageEnglish
  • C#

Material.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

Switch to Manual

Declaration

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

Parameters

keyword The LocalKeyword to enable or disable.
value The desired keyword state.

Description

Sets the state of a local shader keyword for this material.

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.

When value is true, this function calls EnableKeyword. Otherwise, it calls DisableKeyword.

If the LocalKeyword does not exist in the Shader.keywordSpace for the shader that this material uses, this function has no effect.

The following example creates and caches a LocalKeyword, and provides a function to toggle its state.

using UnityEngine;
using UnityEngine.Rendering;

public class MaterialKeywordExample : MonoBehaviour { public Material material; private LocalKeyword exampleFeatureKeyword;

void Start() { // Get the instance of the Shader class that this material uses var shader = material.shader;

// Create and cache the LocalKeyword exampleFeatureKeyword = new LocalKeyword(shader, "EXAMPLE_FEATURE_ON"); }

public void ToggleExampleFeature() { // Get the current state of the local keyword bool state = material.IsKeywordEnabled(exampleFeatureKeyword);

// Toggle the state material.SetKeyword(exampleFeatureKeyword, !state); } }