Set which render pipelines make a class active.
Add [SupportedOnRenderPipeline]
above a class to set which Render Pipeline Assets make a class active. For example, [SupportedOnRenderPipeline(typeof(HDRenderPipelineAsset))
.
[SupportedOnRenderPipeline]
works only with some attributes - for example, CustomEditor.
You can use [SupportedOnRenderPipeline]
without an argument if you want all Scriptable Render Pipeline Assets to make the class active.
The following example makes the BehaviourEditor
class active when any Scriptable Render Pipeline asset is active.
using UnityEditor; using UnityEngine; using UnityEngine.Rendering;
[CustomEditor(typeof(Behaviour))] [SupportedOnRenderPipeline] public class BehaviourEditor : Editor { public override void OnInspectorGUI() { EditorGUILayout.LabelField($"{nameof(BehaviourEditor)} is supported on the currently active render pipeline."); } }
public class Behaviour : MonoBehaviour { }
See Also: RenderPipelineAsset.
isSupportedOnCurrentPipeline | The value is true if the current RenderPipelineAsset supports the attribute. |
renderPipelineTypes | The Render Pipeline Assets that support the attribute. |
GetSupportedMode | Use SupportedOnRenderPipelineAttribute.GetSupportedMode to find out whether a RenderPipelineAsset supports the attribute. |
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.