Note: Unity no longer develops or improves the rendering path that doesn’t use the render graph API. Use the render graph API instead when developing new graphics features. To use the instructions on this page, enable Compatibility Mode (Render Graph Disabled) in URP graphics settings (Project Settings > Graphics).
To create a Scriptable Render Pass in the Universal Render PipelineA series of operations that take the contents of a Scene, and displays them on a screen. Unity lets you choose from pre-built render pipelines, or write your own. More info
See in Glossary (URP), follow these steps:
Create a C# script that inherits the ScriptableRenderPass
class. For example:
using UnityEngine.Rendering;
using UnityEngine.Rendering.Universal;
public class ExampleRenderPass : ScriptableRenderPass
{
}
In the class, add variables for the materials and textures you use in the render pass.
For example, the following code sets up a handle to a texture, and a descriptor to configure the texture.
private RTHandle textureHandle;
private RenderTextureDescriptor textureDescriptor;
Override the Configure
method to set up the render pass. Unity calls this method before executing the render pass.
For example:
public override void Configure(CommandBuffer cmd, RenderTextureDescriptor cameraTextureDescriptor)
{
//Set the texture size to be the same as the camera target size.
textureDescriptor.width = cameraTextureDescriptor.width;
textureDescriptor.height = cameraTextureDescriptor.height;
//Check if the descriptor has changed, and reallocate the texture handle if necessary.
RenderingUtils.ReAllocateIfNeeded(ref textureHandle, textureDescriptor);
}
Override the Execute
method with your rendering commands. Unity calls this method every frame, once for each 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.
For example:
public override void Execute(ScriptableRenderContext context, ref RenderingData renderingData)
{
// Get a CommandBuffer from pool
CommandBuffer cmd = CommandBufferPool.Get();
// Add rendering commands to the CommandBuffer
...
// Execute the command buffer and release it back to the pool
context.ExecuteCommandBuffer(cmd);
CommandBufferPool.Release(cmd);
}
To inject a render pass into the render loop in Compatibility Mode, refer to the following:
For a complete example, refer to Example of a Scriptable Renderer Feature in Compatibility mode.
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.