Struct Clusters 

pub struct Clusters {
    pub tile_size: UVec2,
    pub dimensions: UVec3,
    pub near: f32,
    pub far: f32,
    pub last_frame_farthest_z: Option<f32>,
    pub last_frame_total_cluster_index_count: Option<usize>,
    pub clusterable_objects: ClusterableObjects,
}

Available on crate feature bevy_light only.

The cluster geometry generated by ClusterConfig.

Fields

tile_size: UVec2

The dimensions of the rectangle the cluster occupies in screen-space, rounded up to the nearest pixel.

dimensions: UVec3

Number of clusters in X / Y / Z in the view frustum

near: f32

Distance to the far plane of the first depth slice. The first depth slice is special and explicitly-configured to avoid having unnecessarily many slices close to the camera.

far: f32

Distance to the far plane of the last depth slice. This may change depending on ClusterZConfig used.

last_frame_farthest_z: Option<f32>

The farthest Z value of any bounding sphere of any clusterable object on the previous frame.

This is used for the ClusterFarZMode::MaxClusterableObjectRange feature.

last_frame_total_cluster_index_count: Option<usize>

The sum of the number of objects that all clusters contained last frame.

This is used for the dynamic_resizing feature, which automatically grows the number of clusters if clusters have likely become too large.

clusterable_objects: ClusterableObjects

All objects within the cluster.

Trait Implementations

impl Component for Clusters

where Clusters: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Clusters>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

const HAS_SUMMARY_TICK: bool = false

Set this constant to true if the component should track a summary tick.

impl Debug for Clusters

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Clusters

fn default() -> Clusters

Returns the “default value” for a type.

impl<'a> From<&'a Clusters> for ExtractedClusterConfig

fn from(clusters: &'a Clusters) -> ExtractedClusterConfig

Converts to this type from the input type.