Skip to main content

RenderQueue

Struct RenderQueue 

Source
pub struct RenderQueue {
    pub buckets: HashMap<RenderBucket, Vec<RenderItem>>,
    pub sort_modes: HashMap<RenderBucket, SortMode>,
    pub camera_position: [f32; 3],
    pub frustum_planes: [[f32; 4]; 6],
    pub total_submitted: u32,
    pub total_visible: u32,
    pub total_culled: u32,
    /* private fields */
}
Expand description

Collects and sorts render items into buckets for the pipeline passes.

Fields§

§buckets: HashMap<RenderBucket, Vec<RenderItem>>

All render items, partitioned by bucket.

§sort_modes: HashMap<RenderBucket, SortMode>

Sort modes per bucket (overridable).

§camera_position: [f32; 3]

Camera position used for distance-based sorting.

§frustum_planes: [[f32; 4]; 6]

Frustum planes for culling [left, right, bottom, top, near, far].

§total_submitted: u32

Total items submitted this frame.

§total_visible: u32

Total items visible after culling.

§total_culled: u32

Total items culled.

Implementations§

Source§

impl RenderQueue

Source

pub fn new() -> Self

Source

pub fn clear(&mut self)

Clear all buckets for a new frame.

Source

pub fn set_camera(&mut self, position: [f32; 3], frustum_planes: [[f32; 4]; 6])

Set the camera position and frustum for this frame.

Source

pub fn submit(&mut self, item: RenderItem)

Submit a render item to the queue.

Source

pub fn submit_batch(&mut self, items: Vec<RenderItem>)

Submit a batch of render items.

Source

pub fn sort(&mut self)

Sort all buckets according to their sort modes.

Source

pub fn get_bucket(&self, bucket: RenderBucket) -> &[RenderItem]

Get items in a specific bucket (sorted).

Source

pub fn opaque_items(&self) -> &[RenderItem]

Get opaque items (convenience).

Source

pub fn transparent_items(&self) -> &[RenderItem]

Get transparent items (convenience).

Source

pub fn overlay_items(&self) -> &[RenderItem]

Get overlay items (convenience).

Source

pub fn total_triangles(&self) -> u64

Return the total number of triangles across all visible items.

Source

pub fn total_draw_calls(&self) -> u32

Return the total number of draw calls across all visible items.

Trait Implementations§

Source§

impl Debug for RenderQueue

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for RenderQueue

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,