Unity - Scripting API: Material.SetKeyword

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.

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.

Your name Your email Suggestion*

Cancel

Switch to Manual

Parameters

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

Description

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

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);
    }
}