Struct etagere::BucketedAtlasAllocator

pub struct BucketedAtlasAllocator {
    shelves: Vec<Shelf>,
    buckets: Vec<Bucket>,
    available_height: u16,
    width: u16,
    height: u16,
    first_unallocated_bucket: BucketIndex,
    flip_xy: bool,
    alignment: Size,
    current_column: u16,
    column_width: u16,
    num_columns: u16,
    allocated_space: i32,
}

A faster but less precise Shelf-packing dynamic texture atlas allocator, inspired by https://github.com/mapbox/shelf-pack/

Items are accumulated into buckets which are laid out in rows (shelves) of variable height. When allocating we first look for a suitable bucket. If none is found, a new shelf of the desired height is pushed.

Lifetime isn’t tracked at item granularity. Instead, items are grouped into buckets and deallocation happens per bucket when all items of the buckets are removed. When the top-most shelf is empty, it is removed, potentially cascading into garbage-collecting the next shelf, etc.

This allocator works well when there are a lot of small items with similar sizes (typically, glyph atlases).

Fields

shelves: Vec<Shelf>

buckets: Vec<Bucket>

available_height: u16

width: u16

height: u16

first_unallocated_bucket: BucketIndex

flip_xy: bool

alignment: Size

current_column: u16

column_width: u16

num_columns: u16

allocated_space: i32

Implementations

impl BucketedAtlasAllocator

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)

pub fn size(&self) -> Size

pub fn grow(&mut self, new_size: Size)

pub fn is_empty(&self) -> bool

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

Allocate a rectangle in the atlas.

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

Deallocate a rectangle in the atlas.

Space is only reclaimed when all items of the same bucket are deallocated.

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.

fn alloc_from_bucket( &mut self, shelf_index: usize, bucket_index: BucketIndex, width: u16, ) -> Option<Allocation>

fn add_bucket(&mut self, bucket: Bucket) -> BucketIndex

fn add_shelf(&mut self, width: u16, height: u16) -> usize

fn coalesce_shelves(&mut self, w: u16, h: u16) -> (usize, BucketIndex)

Find a sequence of consecutive shelves that can be coalesced into a single one tall enough to fit the provided size.

If such a sequence is found, grow the height of first shelf and squash the other ones to zero. The squashed shelves are not removed, their height is just set to zero so no item can go in, and they will be garbage-collected whenever there’s no shelf above them. For simplicity, the bucket width is not modified.

fn num_buckets(&self, width: u16, height: u16) -> u16

fn deallocate_from_bucket(&mut self, id: AllocId) -> bool

Returns true if we should garbage-collect the shelves as a result of removing this element (we deallocated the last item from the bucket on the top-most shelf).

fn cleanup_shelves(&mut self)

fn shelf_is_empty(&self, idx: usize) -> bool

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

Dump a visual representation of the atlas in SVG format.

fn check(&self)

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 BucketedAtlasAllocator

fn clone(&self) -> BucketedAtlasAllocator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for BucketedAtlasAllocator

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BucketedAtlasAllocator

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

where __S: Serializer,

Serialize this value into the given Serde serializer.