Struct etagere::allocator::AtlasAllocator

pub struct AtlasAllocator {
    shelves: Vec<Shelf>,
    items: Vec<Item>,
    alignment: Size,
    flip_xy: bool,
    size: Size,
    first_shelf: ShelfIndex,
    free_items: ItemIndex,
    free_shelves: ShelfIndex,
    shelf_width: u16,
    allocated_space: i32,
}

A shelf-packing dynamic texture atlas allocator tracking each allocation individually and with support for coalescing empty shelves.

Fields

shelves: Vec<Shelf>

items: Vec<Item>

alignment: Size

flip_xy: bool

size: Size

first_shelf: ShelfIndex

free_items: ItemIndex

free_shelves: ShelfIndex

shelf_width: u16

allocated_space: i32

Implementations

impl AtlasAllocator

pub fn with_options(size: Size, options: &AllocatorOptions) -> Self

Create an atlas allocator with provided options.

pub fn new(size: Size) -> Self

Create an atlas allocator with default options.

pub fn clear(&mut self)

fn init(&mut self)

pub fn size(&self) -> Size

pub fn allocate(&mut self, size: Size) -> Option<Allocation>

Allocate a rectangle in the atlas.

pub fn deallocate(&mut self, id: AllocId)

Deallocate a rectangle in the atlas.

pub fn is_empty(&self) -> bool

pub fn allocated_space(&self) -> i32

Amount of occupied space in the atlas.

pub fn free_space(&self) -> i32

How much space is available for future allocations.

pub fn iter(&self) -> Iter<'_>

fn remove_item(&mut self, idx: ItemIndex)

fn remove_shelf(&mut self, idx: ShelfIndex)

fn add_item(&mut self, item: Item) -> ItemIndex

fn add_shelf(&mut self, shelf: Shelf) -> ShelfIndex

fn check(&self)

pub fn get_index(&self, id: AllocId) -> u32

Turn a valid AllocId into an index that can be used as a key for external storage.

The allocator internally stores all items in a single vector. In addition allocations stay at the same index in the vector until they are deallocated. As a result the index of an item can be used as a key for external storage using vectors. Note that:

• The provided ID must correspond to an item that is currently allocated in the atlas.
• After an item is deallocated, its index may be reused by a future allocation, so the returned index should only be considered valid during the lifetime of the its associated item.
• indices are expected to be “reasonable” with respect to the number of allocated items, in other words it is never larger than the maximum number of allocated items in the atlas (making it a good fit for indexing within a sparsely populated vector).

pub fn get(&self, id: AllocId) -> Rectangle

Returns the allocation info associated to the allocation ID.

The id must correspond to an existing allocation in the atlas.

pub fn dump_svg(&self, output: &mut dyn Write) -> Result<()>

Dump a visual representation of the atlas in SVG format.

pub fn dump_into_svg( &self, rect: Option<&Rectangle>, output: &mut dyn Write, ) -> Result<()>

Dump a visual representation of the atlas in SVG, omitting the beginning and end of the SVG document, so that it can be included in a larger document.

If a rectangle is provided, translate and scale the output to fit it.

Trait Implementations

impl Clone for AtlasAllocator

fn clone(&self) -> AtlasAllocator

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for AtlasAllocator

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'l> IntoIterator for &'l AtlasAllocator

type Item = Allocation

The type of the elements being iterated over.

type IntoIter = Iter<'l>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'l>

Creates an iterator from a value.

impl Serialize for AtlasAllocator

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.