Struct bevy::ui::TransparentUi

pub struct TransparentUi {
    pub sort_key: (FloatOrd, u32),
    pub entity: Entity,
    pub pipeline: CachedRenderPipelineId,
    pub draw_function: DrawFunctionId,
    pub batch_range: Range<u32>,
    pub dynamic_offset: Option<NonMaxU32>,
}

Fields

sort_key: (FloatOrd, u32)

entity: Entity

pipeline: CachedRenderPipelineId

draw_function: DrawFunctionId

batch_range: Range<u32>

dynamic_offset: Option<NonMaxU32>

Trait Implementations

impl CachedRenderPipelinePhaseItem for TransparentUi

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 TransparentUi

type SortKey = (FloatOrd, u32)

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 entity(&self) -> Entity

The corresponding entity that will be drawn.

fn sort_key(&self) -> <TransparentUi as PhaseItem>::SortKey

Determines the order in which the items are drawn.

fn draw_function(&self) -> DrawFunctionId

Specifies the Draw function used to render the item.

fn sort(items: &mut [TransparentUi])

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.

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 dynamic_offset(&self) -> Option<NonMaxU32>

fn dynamic_offset_mut(&mut self) -> &mut Option<NonMaxU32>

const AUTOMATIC_BATCHING: bool = true

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