CullingResults

Description

A struct containing the results of a culling operation.

In the Scriptable Render Pipeline, when Unity performs a culling operation, it stores the results in a CullingResults struct. This data includes information about visible objects, lights, and reflection probes. Unity uses this data to render objects and process lights. A CullingResults struct also provides several functions to aid shadow rendering.

To obtain a CullingResults struct, call ScriptableRenderContext.Cull.

A CullingResults struct is valid within the scope of a RenderPipeline.Render function; its data goes out of scope when the Render function returns. You can use the same CullingResults struct multiple times within the same render loop, and you can share a CullingResults struct between multiple Cameras if you know that they can see the same objects. This can save on wasted CPU operations, and therefore improve performance.

This example demonstrates how to obtain a CullingResults struct, and then pass it to ScriptableRenderContext.DrawRenderers.

using UnityEngine;
using UnityEngine.Rendering;

public class ExampleRenderPipeline : RenderPipeline
{
    public ExampleRenderPipeline()
    {
    }

    protected override void Render(ScriptableRenderContext context, Camera[] cameras)
    {
        foreach (Camera camera in cameras)
        {
            // Get the culling parameters from the current camera
            camera.TryGetCullingParameters(out var cullingParameters);

            // Schedule the cull operation that populates the CullingResults struct
            CullingResults cullingResults = context.Cull(ref cullingParameters);

            // Place code that schedules drawing operations using the CullingResults struct here
            // See ScriptableRenderContext.DrawRenderers for details and examples
            // …

            // Execute all of the scheduled operations, in order
            context.Submit();
        }
    }
}

Properties

Public Methods