Struct crunch::Packer

pub struct Packer<T> { /* fields omitted */ }

A packer for items of type Item<T>.

Implementations

impl<T> Packer<T>

pub fn new() -> Self

Create a new, empty packer.

pub fn with_capacity(capacity: usize) -> Self

Create a packer with an initial capacity to prevent collection resizing.

pub fn with_items<I: IntoIterator<Item = Item<T>>>(items: I) -> Self

Create a packer initialized with the collection of items.

impl<T: Clone> Packer<T>

pub fn clear(&mut self) -> &mut Self

pub fn push(&mut self, item: Item<T>) -> &mut Self

pub fn extend<I: IntoIterator<Item = Item<T>>>(&mut self, items: I) -> &mut Self

pub fn pack(
    &mut self,
    into_rect: Rect
) -> Result<PackedItems<T>, PackedItems<T>>

Attempt to pack all the items into into_rect. The returned PackedItems will contain positions for all packed items on success, or just the items the packer was able to successfull pack before failing.

This function uses some internal intermediary collections, which is why it is mutable, so it cannot be called but it is valid to call it multiple times with different into_rect values.

If you want to attempt to pack the same item list into several different into_rect, it is valid to call this function multiple times on the same Packer, and it will re-use its intermediary data structures.

pub fn pack_into_po2(
    &mut self,
    max_size: usize
) -> Result<(usize, usize, PackedItems<T>), ()>

Attempts to pack the supplied items into the smallest power of 2 container it possibly can while not exceeding the provided max_size.

On success, returns the size of the container (a power of 2) and the packed items.

Trait Implementations

impl<T> Default for Packer<T>

fn default() -> Self

Default packer, equivalent to Packer::new().