new AutoCull()
The AutoCull Component is responsible for providing methods that check if a Game Object is within the bounds of the World Camera. It is used by the InWorld component.
Members
-
autoCull : boolean
-
A Game Object with
autoCullset to true will check its bounds against the World Camera every frame. If it is not intersecting the Camera bounds at any point then it has itsrenderableproperty set tofalse. This keeps the Game Object alive and still processing updates, but forces it to skip the render step entirely.This is a relatively expensive operation, especially if enabled on hundreds of Game Objects. So enable it only if you know it's required, or you have tested performance and find it acceptable.
Type:
- boolean
-
<readonly> inCamera : boolean
-
Checks if the Game Objects bounds intersect with the Game Camera bounds. Returns
trueif they do, otherwisefalseif fully outside of the Cameras bounds.Type:
- boolean