Struct AlphaMask3d

pub struct AlphaMask3d {
    pub batch_set_key: OpaqueNoLightmap3dBatchSetKey,
    pub bin_key: OpaqueNoLightmap3dBinKey,
    pub representative_entity: (Entity, MainEntity),
    pub batch_range: Range<u32>,
    pub extra_index: PhaseItemExtraIndex,
}

Fields

batch_set_key: OpaqueNoLightmap3dBatchSetKey

Determines which objects can be placed into a batch set.

Objects in a single batch set can potentially be multi-drawn together, if it’s enabled and the current platform supports it.

bin_key: OpaqueNoLightmap3dBinKey

The key, which determines which can be batched.

representative_entity: (Entity, MainEntity)

batch_range: Range<u32>

extra_index: PhaseItemExtraIndex

Trait Implementations

impl BinnedPhaseItem for AlphaMask3d

type BinKey = OpaqueNoLightmap3dBinKey

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.

type BatchSetKey = OpaqueNoLightmap3dBatchSetKey

The key used to combine batches into batch sets.

fn new( batch_set_key: Self::BatchSetKey, bin_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 AlphaMask3d

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 AlphaMask3d

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)