Version: 2021.1
LanguageEnglish
  • C#

Material.IsKeywordEnabled

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 bool IsKeywordEnabled(string keyword);

Parameters

keyword The name of the local shader keyword to check.

Returns

bool Returns true if the given local shader keyword is enabled for this material. Otherwise, returns false.

Description

Checks whether a local shader keyword is enabled for this material.

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

The following example checks the state of a local shader keyword called EXAMPLE_FEATURE_ON.

using UnityEngine;

public class Example : MonoBehaviour { public Material mat;

void Start() { if (mat.IsKeywordEnabled("EXAMPLE_FEATURE_ON")) { Debug.Log("EXAMPLE_FEATURE_ON is enabled"); } } }