Struct Transmissive3d

pub struct Transmissive3d {
    pub distance: f32,
    pub pipeline: CachedRenderPipelineId,
    pub entity: (Entity, MainEntity),
    pub draw_function: DrawFunctionId,
    pub batch_range: Range<u32>,
    pub extra_index: PhaseItemExtraIndex,
}

Fields

distance: f32

pipeline: CachedRenderPipelineId

entity: (Entity, MainEntity)

draw_function: DrawFunctionId

batch_range: Range<u32>

extra_index: PhaseItemExtraIndex

Trait Implementations

impl CachedRenderPipelinePhaseItem for Transmissive3d

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 Transmissive3d

const AUTOMATIC_BATCHING: bool = false

For now, automatic batching is disabled for transmissive items because their rendering is split into multiple steps depending on Camera3d::screen_space_specular_transmission_steps, which the batching system doesn’t currently know about.

Having batching enabled would cause the same item to be drawn multiple times across different steps, whenever the batching range crossed a step boundary.

Eventually, we could add support for this by having the batching system break up the batch ranges using the same logic as the transmissive pass, but for now it’s simpler to just disable batching.

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.

impl SortedPhaseItem for Transmissive3d

type SortKey = FloatOrd

The type used for ordering the items. The smallest values are drawn first. This order can be calculated using the ViewRangefinder3d, based on the view-space Z value of the corresponding view matrix.

fn sort_key(&self) -> Self::SortKey

Determines the order in which the items are drawn.

fn sort(items: &mut [Self])

Sorts a slice of phase items into render order. Generally if the same type is batched this should use a stable sort like slice::sort_by_key. In almost all other cases, this should not be altered from the default, which uses a unstable sort, as this provides the best balance of CPU and GPU performance.