Struct TextureAtlas 

pub struct TextureAtlas {
    pub config: AtlasConfig,
    pub pixels: Vec<u8>,
    /* private fields */
}

Texture atlas packer.

Allocates rectangular regions inside a fixed-size backing texture using a shelf-packing strategy. The CPU-side pixel data is stored in pixels so the atlas can be uploaded to the GPU at any time.

Fields

config: AtlasConfig

Configuration.

pixels: Vec<u8>

CPU-side RGBA pixel data for the backing texture.

Size = config.width * config.height * 4 bytes.

Implementations

impl TextureAtlas

pub fn new(config: AtlasConfig) -> Self

Create a new, empty atlas.

pub fn insert(&mut self, w: u32, h: u32) -> Result<u32>

Insert a sub-texture of w × h texels.

Returns an opaque allocation ID on success.

Errors

Returns GpuError::Internal if the atlas has no space left or if the requested dimensions exceed the atlas size.

pub fn upload_pixels(&mut self, id: u32, data: &[u8]) -> Result<()>

Upload RGBA pixel data for the sub-texture identified by id.

data must be exactly w * h * 4 bytes.

Errors

Returns an error if id is invalid or data has wrong length.

pub fn rect(&self, id: u32) -> Option<AtlasRect>

Return the allocated AtlasRect for id, or None if unknown.

pub fn len(&self) -> usize

Number of allocated sub-textures.

pub fn is_empty(&self) -> bool

true if no sub-textures have been allocated.

pub fn utilisation(&self) -> f32

Utilisation as a fraction in [0, 1] (pixels used / total pixels).

pub fn clear(&mut self)

Clear all allocations, retaining the backing pixel buffer.

pub fn width(&self) -> u32

Atlas width in texels.

pub fn height(&self) -> u32

Atlas height in texels.