Struct bevy::render::render_phase::RenderPhase

pub struct RenderPhase<I>
where
    I: PhaseItem,
{
    pub items: Vec<I>,
}

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.

Fields

items: Vec<I>

Implementations

impl<I> RenderPhase<I>

where I: PhaseItem,

pub fn add(&mut self, item: I)

Adds a PhaseItem to this render phase.

pub fn sort(&mut self)

Sorts all of its PhaseItems.

pub fn iter_entities(&self) -> impl Iterator<Item = Entity>

An Iterator through the associated Entity for each PhaseItem in order.

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

Renders all of its PhaseItems using their corresponding draw functions.

pub fn render_range<'w>( &self, render_pass: &mut TrackedRenderPass<'w>, world: &'w World, view: Entity, range: impl SliceIndex<[I], Output = [I]> )

Renders all PhaseItems in the provided range (based on their index in self.items) using their corresponding draw functions.

Trait Implementations

impl<I> Component for RenderPhase<I>

where I: PhaseItem, RenderPhase<I>: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either TableStorage or SparseStorage.

impl<I> Default for RenderPhase<I>

where I: PhaseItem,

fn default() -> RenderPhase<I>

Returns the “default value” for a type.