docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Execute rendering commands in a custom render pipeline

    This page explains how to schedule and execute rendering commands in the Scriptable Render Pipeline (SRP)ScriptableRenderPipeline, either by using CommandBuffers or by making direct API calls to the ScriptableRenderContext. The information on this page is applicable to the Universal Render Pipeline (URP), the High Definition Render Pipeline (HDRP), and custom render pipelines that are based on SRP.

    In SRP, you use C# scripts to configure and schedule rendering commands. You then tell Unity's low-level graphics architecture to execute them, which sends instructions to the graphics API.

    The main way of doing this is by making API calls to the ScriptableRenderContext, but you can also execute CommandBuffers immediately.

    Using the ScriptableRenderContext APIs

    In SRP, the ScriptableRenderContext class acts as an interface between the C# render pipeline code and Unity's low-level graphics code. SRP rendering works using delayed execution; you use the ScriptableRenderContext to build up a list of rendering commands, and then you tell Unity to execute them. Unity's low-level graphics architecture then sends instructions to the graphics API.

    To schedule rendering commands, you can:

    • Pass CommandBuffers to the ScriptableRenderContext, using ScriptableRenderContext.ExecuteCommandBuffer
    • Make direct API calls to the Scriptable Render Context, such as ScriptableRenderContext.Cull or ScriptableRenderContext.DrawRenderers

    To tell Unity to perform the commands that you have scheduled, call ScriptableRenderContext.Submit. Note that it does not matter whether you used a CommandBuffer to schedule the command, or whether you scheduled the command by calling an API; Unity schedules all rendering commands on the ScriptableRenderContext in the same way, and does not execute any of them until you call Submit().

    This example code demonstrates how to schedule and perform a command to clear the current render target, using a CommandBuffer.

    using UnityEngine;
    using UnityEngine.Rendering;
    
    public class ExampleRenderPipeline : RenderPipeline
    {
            public ExampleRenderPipeline() {
            }
    
        protected override void Render(ScriptableRenderContext context, Camera[] cameras) {
            // Create and schedule a command to clear the current render target
            var cmd = new CommandBuffer();
            cmd.ClearRenderTarget(true, true, Color.red);
            context.ExecuteCommandBuffer(cmd);
            cmd.Release();
    
             // Tell the Scriptable Render Context to tell the graphics API to perform the scheduled commands
            context.Submit();
        }
    }
    

    Executing CommandBuffers immediately

    You can execute CommandBuffers immediately without using the ScriptableRenderContext, by calling Graphics.ExecuteCommandBuffer. Calls to this API take place outside of the render pipeline.

    Additional information

    For more information on commands that you can schedule using CommandBuffers, see CommandBuffers API documentation.


    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    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.

    In This Article
    • Using the ScriptableRenderContext APIs
    • Executing CommandBuffers immediately
    • Additional information
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)