Struct bevy_render::render_phase::BinnedRenderPhase

pub struct BinnedRenderPhase<BPI>
where
    BPI: BinnedPhaseItem,
{
    pub batchable_mesh_keys: Vec<BPI::BinKey>,
    pub unbatchable_mesh_keys: Vec<BPI::BinKey>,
    pub non_mesh_items: Vec<(BPI::BinKey, Entity)>,
    /* private fields */
}

A collection of all rendering instructions, that will be executed by the GPU, for a single render phase for a single view.

Each view (camera, or shadow-casting light, etc.) can have one or multiple render phases. They are used to queue entities for rendering. Multiple phases might be required due to different sorting/batching behaviors (e.g. opaque: front to back, transparent: back to front) or because one phase depends on the rendered texture of the previous phase (e.g. for screen-space reflections). All PhaseItems are then rendered using a single TrackedRenderPass. The render pass might be reused for multiple phases to reduce GPU overhead.

This flavor of render phase is used for phases in which the ordering is less critical: for example, Opaque3d. It’s generally faster than the alternative SortedRenderPhase.

Fields

batchable_mesh_keys: Vec<BPI::BinKey>

A list of BinKeys for batchable items.

These are accumulated in queue_material_meshes and then sorted in batch_and_prepare_binned_render_phase.

unbatchable_mesh_keys: Vec<BPI::BinKey>

A list of BinKeys for unbatchable items.

These are accumulated in queue_material_meshes and then sorted in batch_and_prepare_binned_render_phase.

non_mesh_items: Vec<(BPI::BinKey, Entity)>

Items in the bin that aren’t meshes at all.

Bevy itself doesn’t place anything in this list, but plugins or your app can in order to execute custom drawing commands. Draw functions for each entity are simply called in order at rendering time.

See the custom_phase_item example for an example of how to use this.

Implementations

impl<BPI> BinnedRenderPhase<BPI>

where BPI: BinnedPhaseItem,

pub fn add( &mut self, key: BPI::BinKey, entity: Entity, phase_type: BinnedRenderPhaseType, )

Bins a new entity.

The phase_type parameter specifies whether the entity is a preprocessable mesh and whether it can be binned with meshes of the same type.

pub fn render<'w>( &self, render_pass: &mut TrackedRenderPass<'w>, world: &'w World, view: Entity, )

Encodes the GPU commands needed to render all entities in this phase.

pub fn is_empty(&self) -> bool

pub fn clear(&mut self)

Trait Implementations

impl<BPI> Default for BinnedRenderPhase<BPI>

where BPI: BinnedPhaseItem,

fn default() -> Self

Returns the “default value” for a type.