Version: 2018.4
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

ScriptableCullingParameters

struct in UnityEngine.Experimental.Rendering

/

Implemented in:UnityEngine.CoreModule

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

accurateOcclusionThresholdThis parameter determines query distance for occlusion culling. The accurateOcclusionThreshold controls the distance where the level of detail (LOD) changes.The default value of this parameter is -1, and any value less than 0 has the same effect. Default values result in automatic calculation of the LOD.When you use occlusion culling, the occlusion data of the world varies in level of detail. In the occlusion data, there are tiles of various sizes. Each tile contains a cells-and-portals graph. In each cell, visibility is the same. This means that any two points are visible within the cell. Portals are the openings between the cells, which determine the visibility between them.The tiles are in a k-d tree. The tree contains different sized tiles, where each tile represents a level of detail. When you query a small tile, you get accurate culling results at the price of query time.During the culling, the tile size varies with the distance from the camera. This gives finer detail closer to the camera, and coarser detail at further distance.The higher the value is, the higher the accuracy is far away form the camera. High values can have a negative impact on performance.
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.