Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Experimental: this API is experimental and might be changed or removed in the future.

ScriptableCullingParameters

struct in UnityEngine.Experimental.Rendering

Suggest a change

Success!

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.

Close

Submission failed

For 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.

Close

Cancel

Description

Parameters controlling culling process in CullResults.

Typical use case is to compute culling parameters from Camera data, see CullResults.GetCullingParameters.

Properties

cameraPropertiesCamera Properties used for culling.
cullingFlagsCulling Flags for the culling.
cullingMaskCullingMask used for culling.
cullingMatrixCullingMatrix used for culling.
cullingPlaneCountNumber of culling planes to use.
cullStereoProjThe projection matrix generated for single-pass stereo culling.
cullStereoSeparationDistance between the virtual eyes.
cullStereoViewThe view matrix generated for single-pass stereo culling.
isOrthographicIs the cull orthographic.
layerCullLayers to cull.
lodParametersLODParameters for culling.
positionPosition for the origin of th cull.
reflectionProbeSortOptionsReflection Probe Sort options for the cull.
sceneMaskScene Mask to use for the cull.
shadowDistanceShadow distance to use for the cull.

Public Methods

GetCullingPlaneFetch the culling plane at the given index.
GetLayerCullDistanceGet the distance for the culling of a specific layer.
SetCullingPlaneSet the culling plane at a given index.
SetLayerCullDistanceSet the distance for the culling of a specific layer.