struct in UnityEngine.Rendering
/
Implemented in:UnityEngine.CoreModule
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseA 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(); } } }
lightAndReflectionProbeIndexCount | Gets the number of per-object light and reflection probe indices. |
lightIndexCount | Gets the number of per-object light indices. |
reflectionProbeIndexCount | Gets the number of per-object reflection probe indices. |
visibleLights | Array of visible lights. |
visibleOffscreenVertexLights | Off-screen lights that still affect visible vertices. |
visibleReflectionProbes | Array of visible reflection probes. |
ComputeDirectionalShadowMatricesAndCullingPrimitives | Calculates the view and projection matrices and shadow split data for a directional light. |
ComputePointShadowMatricesAndCullingPrimitives | Calculates the view and projection matrices and shadow split data for a point light. |
ComputeSpotShadowMatricesAndCullingPrimitives | Calculates the view and projection matrices and shadow split data for a spot light. |
FillLightAndReflectionProbeIndices | Fills a buffer with per-object light indices. |
GetLightIndexMap | If a RenderPipeline sorts or otherwise modifies the VisibleLight list, an index remap will be necessary to properly make use of per-object light lists. |
GetReflectionProbeIndexMap | If a RenderPipeline sorts or otherwise modifies the VisibleReflectionProbe list, an index remap will be necessary to properly make use of per-object reflection probe lists. |
GetShadowCasterBounds | Returns the bounding box that encapsulates the visible shadow casters. Can be used to, for instance, dynamically adjust cascade ranges. |
SetLightIndexMap | If a RenderPipeline sorts or otherwise modifies the VisibleLight list, an index remap will be necessary to properly make use of per-object light lists. |
SetReflectionProbeIndexMap | If a RenderPipeline sorts or otherwise modifies the VisibleReflectionProbe list, an index remap will be necessary to properly make use of per-object reflection probe lists. |
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.