RendererListDesc

Description

A high-level struct holding the arguments needed to create a RendererList.

To create a RendererList object, fill this struct and pass it to ScriptableRenderContext.CreateRendererList.

Alternatively, if you use the render graph system, pass this struct to RenderGraph.CreateRendererList. For more information about RenderGraph, refer to The render graph system .

In terms of usage, this struct is similar to RendererListParams, only higher level. If you need access to advanced properties such as FilteringSettings.sortingLayerRange, use RendererListParams instead.

This struct can be converted to RendererListParams using RendererListDesc.ConvertToParameters.

The example illustrates how RendererListDesc can be used. Follow these steps:

1. Save the example code in your project as SimpleRenderPipelineAsset.cs.
2. Use the RenderPipeline/Create SimpleRenderPipelineAsset menu item to create the render pipeline asset.
3. Go to Project Settings > Graphics, and assign the created asset as the **Default Render Pipeline Asset**.

using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Rendering;
using UnityEngine.Rendering.RendererUtils;

public class SimpleRenderPipelineAsset : RenderPipelineAsset<SimpleRenderPipeline>
{
#if UNITY_EDITOR
    [UnityEditor.MenuItem("RenderPipeline/Create SimpleRenderPipelineAsset")]
    static void CreateSimpleRenderLoop()
    {
        var instance = CreateInstance<SimpleRenderPipelineAsset>();
        UnityEditor.AssetDatabase.CreateAsset(instance, "Assets/SimpleRenderPipeline.asset");
    }
#endif

    protected override RenderPipeline CreatePipeline() => new SimpleRenderPipeline();
}

public class SimpleRenderPipeline : RenderPipeline
{
    protected override void Render(ScriptableRenderContext context, List<Camera> cameras)
    {
        foreach (var camera in cameras)
        {
            if (!camera.TryGetCullingParameters(out var cullingParams))
                continue;
            
            CullingResults cullingResults = context.Cull(ref cullingParams);
            context.SetupCameraProperties(camera);

            var cmd = new CommandBuffer();
            cmd.ClearRenderTarget(true, true, Color.red);
            
            // Draws visible MeshRenderers that use the built-in Default-Material/Default-Diffuse material.
            var rendererListDesc = new RendererListDesc(new ShaderTagId("ForwardBase"), cullingResults, camera)
            {
                renderQueueRange = RenderQueueRange.opaque
            };
            var rendererList = context.CreateRendererList(rendererListDesc);            
            cmd.DrawRendererList(rendererList);

            context.ExecuteCommandBuffer(cmd);
            cmd.Release();
            context.Submit();
        }
    }
}

Additional resources: RendererList, ScriptableRenderContext.CreateRendererList.

Properties

Constructors

Public Methods

Static Methods