Struct SortedRenderPhase

pub struct SortedRenderPhase<I>
where
    I: SortedPhaseItem,
{
    pub items: Vec<I>,
}

A collection of all items to be rendered that will be encoded to GPU commands 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 only for meshes that need to be sorted back-to-front, such as transparent meshes. For items that don’t need strict sorting, BinnedRenderPhase is preferred, for performance.

Fields

items: Vec<I>

The items within this SortedRenderPhase.

Implementations

impl<I> SortedRenderPhase<I>

where I: SortedPhaseItem,

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

Adds a PhaseItem to this render phase.

pub fn clear(&mut self)

Removes all PhaseItems from 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, ) -> Result<(), DrawError>

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]>, ) -> Result<(), DrawError>

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

Trait Implementations

impl<I> Default for SortedRenderPhase<I>

where I: SortedPhaseItem,

fn default() -> Self

Returns the “default value” for a type.