CullingGroup
Describes a set of bounding spheres that should have their visibility and distances maintained.
Read time 1 minuteLast updated 4 days ago
Definition
- Type: Class
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
- Implements: IDisposable
public class CullingGroup : IDisposable
Constructors
Constructor | Description |
|---|---|
| CullingGroup() | Create a CullingGroup. |
Properties
Property | Description |
|---|---|
| enabled | Pauses culling group execution. |
| onStateChanged | Sets the callback that will be called when a sphere's visibility and/or distance state has changed. |
| targetCamera | Locks the CullingGroup to a specific camera. |
Methods
Method | Description |
|---|---|
| Dispose | Clean up all memory used by the CullingGroup immediately. |
| EraseSwapBack | Erase a given bounding sphere by moving the final sphere on top of it. |
| GetDistance | Get the current distance band index of a given sphere. |
| IsVisible | Returns true if the bounding sphere at index is currently visible from any of the contributing cameras. |
| QueryIndices | Retrieve the indices of spheres that have particular visibility and/or distance states. |
| SetBoundingDistances | Set bounding distances for 'distance bands' the group should compute, as well as options for how spheres falling into each distance band should be treated. |
| SetBoundingSphereCount | Sets the number of bounding spheres in the bounding spheres array that are actually being used. |
| SetBoundingSpheres | Sets the array of bounding sphere definitions that the CullingGroup should compute culling for. |
| SetDistanceReferencePoint | Set the reference point from which distance bands are measured. |
Static Methods
Method | Description |
|---|---|
| EraseSwapBack | Erase a given entry in an arbitrary array by copying the final entry on top of it, then decrementing the number of entries used by one. |
Delegates
Delegate | Description |
|---|---|
| CullingGroup.StateChanged | This delegate is used for recieving a callback when a sphere's distance or visibility state has changed. |