Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

DisableKeyword

Disables a local shader keyword for this material.
Read time 3 minutesLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule

DisableKeyword(string)

Disables a local shader keyword for this material.
public void DisableKeyword(string keyword)

Parameters

keyword

string
The LocalKeyword to disable.

Remarks

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.
If you pass in a LocalKeyword and it does not exist in the Shader.keywordSpace for the shader that this material uses, this function has no effect. If you pass a string and a LocalKeyword with that 
name
does not exist in the Shader.keywordSpace for the shader that this material uses, this function has no effect.
The version of this function that takes a string as a parameter is slower than the version that takes a LocalKeyword. If you call this function more than once, it is best practice to create a LocalKeyword struct, cache it, and use that.
Note: A 
LocalKeyword
is specific to a single Shader or ComputeShader instance. You cannot use it with other Shader or ComputeShader instances, even if they declare keywords with the same name.
The following example creates a 
LocalKeyword
struct with the name 
EXAMPLE_FEATURE_ON
, and caches it. It provides functions to enable and disable it.
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 EnableExampleFeature()    {        material.EnableKeyword(exampleFeatureKeyword);    }    public void DisableExampleFeature()    {        material.DisableKeyword(exampleFeatureKeyword);    }}
Additional Resources: Shader variants and keywords, LocalKeyword, GlobalKeyword, Material.EnableKeyword, Material.SetKeyword, Shader.keywordSpace, Material.IsKeywordEnabled, Material.enabledKeywords, Material.shaderKeywords.

DisableKeyword(LocalKeyword)

Disables a local shader keyword for this material.
public void DisableKeyword(in LocalKeyword keyword)

Parameters

keyword

LocalKeyword
The LocalKeyword to disable.

Remarks

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.
If you pass in a LocalKeyword and it does not exist in the Shader.keywordSpace for the shader that this material uses, this function has no effect. If you pass a string and a LocalKeyword with that 
name
does not exist in the Shader.keywordSpace for the shader that this material uses, this function has no effect.
The version of this function that takes a string as a parameter is slower than the version that takes a LocalKeyword. If you call this function more than once, it is best practice to create a LocalKeyword struct, cache it, and use that.
Note: A 
LocalKeyword
is specific to a single Shader or ComputeShader instance. You cannot use it with other Shader or ComputeShader instances, even if they declare keywords with the same name.
The following example creates a 
LocalKeyword
struct with the name 
EXAMPLE_FEATURE_ON
, and caches it. It provides functions to enable and disable it.
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 EnableExampleFeature()    {        material.EnableKeyword(exampleFeatureKeyword);    }    public void DisableExampleFeature()    {        material.DisableKeyword(exampleFeatureKeyword);    }}
Additional Resources: Shader variants and keywords, LocalKeyword, GlobalKeyword, Material.EnableKeyword, Material.SetKeyword, Shader.keywordSpace, Material.IsKeywordEnabled, Material.enabledKeywords, Material.shaderKeywords.