Struct Opaque2d

pub struct Opaque2d {
    pub key: Opaque2dBinKey,
    pub representative_entity: (Entity, MainEntity),
    pub batch_range: Range<u32>,
    pub extra_index: PhaseItemExtraIndex,
}

Opaque 2D BinnedPhaseItems.

Fields

key: Opaque2dBinKey

The key, which determines which can be batched.

representative_entity: (Entity, MainEntity)

An entity from which data will be fetched, including the mesh if applicable.

batch_range: Range<u32>

The ranges of instances.

extra_index: PhaseItemExtraIndex

An extra index, which is either a dynamic offset or an index in the indirect parameters list.

Trait Implementations

impl BinnedPhaseItem for Opaque2d

type BinKey = Opaque2dBinKey

The key used for binning PhaseItems into bins. Order the members of BinnedPhaseItem::BinKey by the order of binding for best performance. For example, pipeline id, draw function id, mesh asset id, lowest variable bind group id such as the material bind group id, and its dynamic offsets if any, next bind group and offsets, etc. This reduces the need for rebinding between bins and improves performance.

fn new( key: Self::BinKey, representative_entity: (Entity, MainEntity), batch_range: Range<u32>, extra_index: PhaseItemExtraIndex, ) -> Self

Creates a new binned phase item from the key and per-entity data.

impl CachedRenderPipelinePhaseItem for Opaque2d

fn cached_pipeline(&self) -> CachedRenderPipelineId

The id of the render pipeline, cached in the PipelineCache, that will be used to draw this phase item.

impl PhaseItem for Opaque2d

fn entity(&self) -> Entity

The corresponding entity that will be drawn.

fn main_entity(&self) -> MainEntity

The main world entity represented by this PhaseItem.

fn draw_function(&self) -> DrawFunctionId

Specifies the Draw function used to render the item.

fn batch_range(&self) -> &Range<u32>

The range of instances that the batch covers. After doing a batched draw, batch range length phase items will be skipped. This design is to avoid having to restructure the render phase unnecessarily.

fn batch_range_mut(&mut self) -> &mut Range<u32>

fn extra_index(&self) -> PhaseItemExtraIndex

Returns the PhaseItemExtraIndex.

fn batch_range_and_extra_index_mut( &mut self, ) -> (&mut Range<u32>, &mut PhaseItemExtraIndex)

Returns a pair of mutable references to both the batch range and extra index.

const AUTOMATIC_BATCHING: bool = true

Whether or not this PhaseItem should be subjected to automatic batching. (Default: true)