To inject a custom render pass into the rendering loop in the Universal Rendering Pipeline (URP), subscribe to one of the events in the RenderPipelineManager API and use the EnqueuePass API.
For example, you can render extra cameras to render texturesA special type of Texture that is created and updated at runtime. To use them, first create a new Render Texture and designate one of your Cameras to render into it. Then you can use the Render Texture in a Material just like a regular Texture. More info
See in Glossary, and use those textures for effects like planar reflections or surveillance cameraA component which creates an image of a particular viewpoint in your scene. The output is either drawn to the screen or captured as a texture. More info
See in Glossary views.
Note: RenderPipelineManager events trigger only if a camera is active.
Follow these steps:
Attach a new MonoBehaviour script to a GameObjectThe fundamental object in Unity scenes, which can represent characters, props, scenery, cameras, waypoints, and more. A GameObject’s functionality is defined by the Components attached to it. More info
See in Glossary, then create an instance of a custom render pass. For example:
public class InjectPass : MonoBehaviour
{
// Declare a custom render pass
private ExampleRenderPass exampleRenderPass;
private void OnEnable()
{
// Create the custom render pass
exampleRenderPass = new ExampleRenderPass(settings);
}
}
For more information about writing a render pass, refer to Write a render pass using the render graph system.
Subscribe a method to one of the events in the RenderPipelineManager API. For example:
private void OnEnable()
{
...
// Call the InjectRenderPass method when the beginCameraRendering event is raised.
RenderPipelineManager.beginCameraRendering += InjectRenderPass;
}
In the subscribed method, use the EnqueuePass API method to inject a custom render pass into the URP rendering loop.
public class InjectPass : MonoBehaviour
{
...
// Add the method that Unity calls after the beginCameraRendering event is raised.
// The method must accept the ScriptableRenderContext and Camera parameters the event delegate defines.
private void InjectRenderPass(ScriptableRenderContext context, Camera cam)
{
...
// Use the EnqueuePass API to inject the custom render pass.
cam.GetUniversalAdditionalCameraData().scriptableRenderer.EnqueuePass(exampleRenderPass);
}
}
Unsubscribe from the event in the OnDisable method. For example:
public class InjectPass : MonoBehaviour
{
...
private void OnDisable()
{
RenderPipelineManager.beginCameraRendering -= InjectRenderPass;
}
}
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.