Struct RenderGpuCulledEntities 

pub struct RenderGpuCulledEntities {
    pub entities: HashMap<MainEntity, RenderLayers, EntityHash>,
    pub added: Vec<MainEntity>,
    pub removed: Vec<MainEntity>,
    pub changed_layers: Vec<MainEntity>,
}

A resource, part of the render world, that stores all entities that are potentially-visible and have NoCpuCulling components.

Even though this resource exists, individual views still have their own lists of all GPU-culled entities, because render layers can alter the set of entities visible to each view.

Fields

entities: HashMap<MainEntity, RenderLayers, EntityHash>

A mapping from each potentially-visible entity to the render layers it’s part of.

added: Vec<MainEntity>

A list of all entities with GPU culling (and no CPU culling) that became potentially visible in some view this frame.

This also includes entities that changed from CPU culling to GPU culling.

Unlike the corresponding field in bevy_render::view::visibility::RenderVisibleEntitiesClass, this list is not necessarily sorted.

removed: Vec<MainEntity>

A list of all entities with GPU culling that were either despawned or otherwise became definitely invisible this frame.

This also includes entities that changed from GPU culling to CPU culling.

Unlike the corresponding field in bevy_render::view::visibility::RenderVisibleEntitiesClass, this list is not necessarily sorted.

changed_layers: Vec<MainEntity>

A list of all entities with GPU culling that changed the set of render layers they belong to this frame.

Implementations

impl RenderGpuCulledEntities

pub fn prepare_for_new_frame(&mut self)

Clears out the sets of newly-added entities, newly-removed entities, and entities that newly changed render layers in preparation for a new frame.

pub fn update( &mut self, new_entity: MainEntity, render_layers: RenderLayers, no_cpu_culling: bool, )

Records that an entity became newly-visible or changed its set of layers this frame.

The render_layers argument specifies the set of render layers that the entity belongs to.

pub fn remove(&mut self, old_entity: MainEntity)

Records that an entity became newly-invisible this frame.

Trait Implementations

impl Component for RenderGpuCulledEntities

where RenderGpuCulledEntities: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::SparseSet

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<RenderGpuCulledEntities>>

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]

impl Default for RenderGpuCulledEntities

fn default() -> RenderGpuCulledEntities

Returns the “default value” for a type.

impl Resource for RenderGpuCulledEntities

where RenderGpuCulledEntities: Send + Sync + 'static,