Legacy Documentation: Version 2017.1 (Go to current version)
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.Cull(Camera,RenderLoop,CullResults)

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

Parameters

camera Camera to cull for.
renderLoop Render loop the culling results will be used with.
results Culling results.

Returns

void Flag indicating whether culling succeeded.

Description

Perform culling for a Camera.

This function is the same as calling GetCullingParameters for a camera, followed by a call to Cull that takes these culling parameters. Camera's transform, projection parameters and other flags that might affect culling are used.

Cull returns false if camera is invalid to render (empty viewport rectangle, invalid clip plane setup etc.).

Culling results are bound to a RenderLoop they will be used with; memory used by culling results is released once the render loop is finished.

See Also: CullResults, RenderLoop.


Parameters

parameters Parameters for culling.
renderLoop Render loop the culling results will be used with.

Returns

void Culling results.

Description

Perform culling with custom CullingParameters.

Did you find this page useful? Please give it a rating: