Struct amethyst_rendy::batch::TwoLevelBatch

pub struct TwoLevelBatch<PK, SK, C> where
    PK: Eq + Hash,  { /* fields omitted */ }

Batching implementation which provides two levels of indirection and grouping for a given batch. This batch method is used, for example, batching meshes and textures; for any given draw call, a user would want to batch all draws using a specific texture together, and then also group all draw calls for a specific mesh together.

PK - First level of batch grouping SK - Secondary level of batch grouping C - the actual final type being batched.

Internally, this batch type is implemented using a FnvHashMap for its outer primary batching layer. The inner layer is then implemented as a tuple indexed SmallVec.

Methods

impl<PK, SK, C> TwoLevelBatch<PK, SK, C> where
    PK: Eq + Hash,
    SK: PartialEq,
    C: IntoIterator,
    C: FromIterator<<C as IntoIterator>::Item>,
    C: Extend<<C as IntoIterator>::Item>, 

pub fn clear_inner(&mut self)

Clears all batch data.

pub fn prune(&mut self)

Removes empty batch indices from internal storage.

pub fn insert(
    &mut self,
    pk: PK,
    sk: SK,
    data: impl IntoIterator<Item = C::Item>
)

Inserts a set of batch items.

pub fn data(&self) -> impl Iterator<Item = &C>

Returns an iterator over the internally batched raw data.

pub fn iter(
    &self
) -> impl Iterator<Item = (&PK, impl Iterator<Item = &(SK, C)>)>

Returns an iterator over the internally batched data, which includes the group keys.

pub fn count(&self) -> usize

Returns the number of items currently in this batch.

Trait Implementations

impl<PK, SK, C> Default for TwoLevelBatch<PK, SK, C> where
    PK: Eq + Hash, 

fn default() -> Self

Returns the "default value" for a type.

impl<PK: Debug, SK: Debug, C: Debug> Debug for TwoLevelBatch<PK, SK, C> where
    PK: Eq + Hash, 

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

Formats the value using the given formatter.