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.

CullResults.GetCullingParameters

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

public static method GetCullingParameters(camera: Camera, out cullingParameters: Experimental.Rendering.ScriptableCullingParameters): bool;
public static bool GetCullingParameters(Camera camera, out Experimental.Rendering.ScriptableCullingParameters cullingParameters);
public static method GetCullingParameters(camera: Camera, stereoAware: bool, out cullingParameters: Experimental.Rendering.ScriptableCullingParameters): bool;
public static bool GetCullingParameters(Camera camera, bool stereoAware, out Experimental.Rendering.ScriptableCullingParameters cullingParameters);

Parameters

cameraCamera to get parameters for.
cullingParametersResultant culling parameters.
stereoAwareGenerate single-pass stereo aware culling parameters.

Returns

bool Flag indicating whether culling parameters are valid.

Description

Get culling parameters for a camera.

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.

See Also: Cull, CullingParameters, ScriptableRenderContext.SetupCameraProperties, ScriptableRenderContext.StartMultiEye, ScriptableRenderContext.StopMultiEye, ScriptableRenderContext.StereoEndRender.