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.
- Source code: gameobjects/components/AutoCull.js (Line 13)
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 its
renderableproperty set to
false. 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.
- Default Value
- Source code: gameobjects/components/AutoCull.js (Line 28)
[readonly] inCamera : boolean
Checks if the Game Objects bounds intersect with the Game Camera bounds. Returns
trueif they do, otherwise
falseif fully outside of the Cameras bounds.
- Source code: gameobjects/components/AutoCull.js (Line 37)