Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


TryGetCullingParameters

Get culling parameters for a camera.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule

TryGetCullingParameters(ScriptableCullingParameters)

Get culling parameters for a camera.
public bool TryGetCullingParameters(out ScriptableCullingParameters cullingParameters)

Parameters

Resultant culling parameters.

Returns

Type

Description

boolFlag indicating whether culling parameters are valid.

Remarks

Returns false if camera is invalid to render (empty viewport rectangle, invalid clip plane setup etc.).
Both left and right stereo eyes are considered in the generated culling parameters when stereoAware is
true
and single-pass stereo is enabled.

TryGetCullingParameters(bool, ScriptableCullingParameters)

Get culling parameters for a camera.
public bool TryGetCullingParameters(bool stereoAware, out ScriptableCullingParameters cullingParameters)

Parameters

stereoAware

Generate single-pass stereo aware culling parameters.

Resultant culling parameters.

Returns

Type

Description

boolFlag indicating whether culling parameters are valid.

Remarks

Returns false if camera is invalid to render (empty viewport rectangle, invalid clip plane setup etc.).
Both left and right stereo eyes are considered in the generated culling parameters when stereoAware is
true
and single-pass stereo is enabled.