IsKeywordEnabled
Checks whether a local shader keyword is enabled for this compute shader.
Read time 4 minutesLast updated 4 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
IsKeywordEnabled(string)
Checks whether a local shader keyword is enabled for this compute shader.
public bool IsKeywordEnabled(string keyword)
Parameters
The LocalKeyword to check.
Returns
Type | Description |
|---|---|
| bool | Returns true if the given LocalKeyword is enabled for this compute shader. Otherwise, returns false. |
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 ComputeShader.keywordSpace, this function returns . If you pass a string and a LocalKeyword with that does not exist in the ComputeShader.keywordSpace, this function returns .
falsenamefalseThe 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 is specific to a single Shader, ComputeShader or RayTracingShader instance. You cannot use it with other Shader, ComputeShader or RayTracingShader instances, even if they declare keywords with the same name.
LocalKeywordThis example iterates over the local shader keywords in the local keyword space for a compute shader. It determines whether they are overridden by a global shader keyword, and prints their state.
using UnityEngine;using UnityEngine.Rendering;public class Example : MonoBehaviour{ public ComputeShader computeShader; void Start() { CheckShaderKeywordState(); } void CheckShaderKeywordState() { // Get all the local keywords that affect the Compute Shader var keywordSpace = computeShader.keywordSpace; // Iterate over the local keywords foreach (var localKeyword in keywordSpace.keywords) { // If the local keyword is overridable, // and a global keyword with the same name exists and is enabled, // then Unity uses the global keyword state if (localKeyword.isOverridable && Shader.IsKeywordEnabled(localKeyword.name)) { Debug.Log("Local keyword with name of " + localKeyword.name + " is overridden by a global keyword, and is enabled"); } // Otherwise, Unity uses the local keyword state else { var state = computeShader.IsKeywordEnabled(localKeyword) ? "enabled" : "disabled"; Debug.Log("Local keyword with name of " + localKeyword.name + " is " + state); } } }}
Additional Resources: Shader variants and keywords, LocalKeyword, GlobalKeyword, ComputeShader.EnableKeyword, ComputeShader.DisableKeyword, ComputeShader.SetKeyword, ComputeShader.keywordSpace, ComputeShader.enabledKeywords, ComputeShader.shaderKeywords.
IsKeywordEnabled(LocalKeyword)
Checks whether a local shader keyword is enabled for this compute shader.
public bool IsKeywordEnabled(in LocalKeyword keyword)
Parameters
The LocalKeyword to check.
Returns
Type | Description |
|---|---|
| bool | Returns true if the given LocalKeyword is enabled for this compute shader. Otherwise, returns false. |
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 ComputeShader.keywordSpace, this function returns . If you pass a string and a LocalKeyword with that does not exist in the ComputeShader.keywordSpace, this function returns .
falsenamefalseThe 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 is specific to a single Shader, ComputeShader or RayTracingShader instance. You cannot use it with other Shader, ComputeShader or RayTracingShader instances, even if they declare keywords with the same name.
LocalKeywordThis example iterates over the local shader keywords in the local keyword space for a compute shader. It determines whether they are overridden by a global shader keyword, and prints their state.
using UnityEngine;using UnityEngine.Rendering;public class Example : MonoBehaviour{ public ComputeShader computeShader; void Start() { CheckShaderKeywordState(); } void CheckShaderKeywordState() { // Get all the local keywords that affect the Compute Shader var keywordSpace = computeShader.keywordSpace; // Iterate over the local keywords foreach (var localKeyword in keywordSpace.keywords) { // If the local keyword is overridable, // and a global keyword with the same name exists and is enabled, // then Unity uses the global keyword state if (localKeyword.isOverridable && Shader.IsKeywordEnabled(localKeyword.name)) { Debug.Log("Local keyword with name of " + localKeyword.name + " is overridden by a global keyword, and is enabled"); } // Otherwise, Unity uses the local keyword state else { var state = computeShader.IsKeywordEnabled(localKeyword) ? "enabled" : "disabled"; Debug.Log("Local keyword with name of " + localKeyword.name + " is " + state); } } }}
Additional Resources: Shader variants and keywords, LocalKeyword, GlobalKeyword, ComputeShader.EnableKeyword, ComputeShader.DisableKeyword, ComputeShader.SetKeyword, ComputeShader.keywordSpace, ComputeShader.enabledKeywords, ComputeShader.shaderKeywords.