keyword | The LocalKeyword to enable. |
keyword | The name of the LocalKeyword to enable. |
Enables a local shader keyword for this compute shader.
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 keywordSpace, this function has no effect. If you pass a string and a LocalKeyword with that name
does not exist in the keywordSpace, 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 ComputeKeywordExample : MonoBehaviour { public ComputeShader computeShader; private LocalKeyword exampleFeatureKeyword;
void Start() { // Create and cache the LocalKeyword exampleFeatureKeyword = new LocalKeyword(computeShader, "EXAMPLE_FEATURE_ON"); }
public void EnableExampleFeature() { computeShader.EnableKeyword(exampleFeatureKeyword); }
public void DisableExampleFeature() { computeShader.DisableKeyword(exampleFeatureKeyword); } }
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.