Parameters that configure a culling operation in the Scriptable Render Pipeline.
Obtain a ScriptableCullingParameters struct by calling Camera.TryGetCullingParameters.
Note that you can obtain and view a ScriptableCullingParameters struct from a Camera in the Built-in Render Pipeline; however, changing the values has no effect.
The following Scriptable Render Pipeline code demonstrates how to obtain a ScriptableCullingParameters struct from a Camera using Camera.TryGetCullingParameters, configure the struct, and then pass the struct to ScriptableRenderContext.Cull to obtain a CullingResults struct. You can then use the CullingResults struct in a call to ScriptableRenderContext.DrawRenderers.
using UnityEngine; using UnityEngine; using UnityEngine.Rendering;
public class ExampleRenderPipelineInstance : RenderPipeline { public ExampleRenderPipelineInstance() { }
protected override void Render(ScriptableRenderContext context, Camera[] cameras) { // Get the culling parameters from the desired Camera if (cameras[0].TryGetCullingParameters(out var cullingParameters)) { // Change culling parameters to configure the culling operation cullingParameters.cullingOptions &= ~CullingOptions.OcclusionCull; cullingParameters.isOrthographic = false;
// Schedule the cull operation 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(); } } }
See Also: Camera.TryGetCullingParameters, ScriptableRenderContext.Cull, CullingResults, ScriptableRenderContext.DrawRenderers.
cullingJobsLowerLimit | The lower limit to the value ScriptableCullingParameters.maximumPortalCullingJobs. |
cullingJobsUpperLimit | The upper limit to the value ScriptableCullingParameters.maximumPortalCullingJobs. |
layerCount | The amount of layers available. |
maximumCullingPlaneCount | Maximum amount of culling planes that can be specified. |
accurateOcclusionThreshold | This parameter determines query distance for occlusion culling. |
cameraProperties | Camera Properties used for culling. |
conservativeEnclosingSphere | This property enables a conservative method for calculating the size and position of the minimal enclosing sphere around the frustum cascade corner points for shadow culling. |
cullingMask | The mask for the culling operation. |
cullingMatrix | The matrix for the culling operation. |
cullingOptions | Flags to configure a culling operation in the Scriptable Render Pipeline. |
cullingPlaneCount | Number of culling planes to use. |
isOrthographic | Is the cull orthographic. |
lodParameters | LODParameters for culling. |
maximumPortalCullingJobs | This parameter controls how many active jobs contribute to occlusion culling. |
maximumVisibleLights | This parameter controls how many visible lights are allowed. |
numIterationsEnclosingSphere | |
origin | Position for the origin of the cull. |
reflectionProbeSortingCriteria | Reflection Probe Sort options for the cull. |
shadowDistance | Shadow distance to use for the cull. |
shadowNearPlaneOffset | Offset to apply to the near camera plane when performing shadow map rendering. |
stereoProjectionMatrix | The projection matrix generated for single-pass stereo culling. |
stereoSeparationDistance | 仮想目間の距離。 |
stereoViewMatrix | The view matrix generated for single-pass stereo culling. |
GetCullingPlane | Fetch the culling plane at the given index. |
GetLayerCullingDistance | Get the distance for the culling of a specific layer. |
SetCullingPlane | Set the culling plane at a given index. |
SetLayerCullingDistance | Set the distance for the culling of a specific layer. |
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.