Enum SpriteMipLevel

pub enum SpriteMipLevel {
    SingleChunkSprite {
        offset: (u16, u16),
        size: (u16, u16),
        sprite_chunk: u32,
    },
    MultiChunkSprite {
        size: (u16, u16),
        sprite_chunks: Range<u32>,
    },
}

One mipmap level (i.e. a sprite with a specific resolution) of a SpriteAsset.

Each SpriteAsset has a maximum of MAX_MIPS of these, with the first level being the resolution of the original sprite, and each successive mip having half the width and height of the previous mip.

The sprites do not use hardware mipmapping. Multiple mip levels (especially the smaller ones) can share a single sprite chunk.

Variants

SingleChunkSprite

A sprite contained within a single chunk. Unlike the other variant, these sprite might not be located in the top-left corner of the chunk, so this variant has an offset field.

Fields

offset: (u16, u16)

Offset from the topmost and leftmost chunks where the actual sprite starts.

size: (u16, u16)

The dimensions of the sprite in pixels.

sprite_chunk: u32

The chunk the sprite’s pixels are located in. The subregion to render is described by the offset and size fields.

MultiChunkSprite

A sprite split between multiple sprite chunks.

Chunks are allocated for a multi-chunk sprite starting from the top-left, row by row. Each chunk has a 1px border (copied from the edge of the sprite, creating a kind of clamp-to-edge effect), inside which is the actual sprite. The chunks on the right and bottom edges of the sprite are the only ones that don’t occupy their sprite chunk entirely, they instead occupy only up to the sprite’s width and height plus the border, effectively taking up a width + 2 by `height

• 2` region from the top left corner of those chunks due to the border.

Fields

size: (u16, u16)

The dimensions of the sprite in pixels.

sprite_chunks: Range<u32>

The chunks the sprite is made up of.

Trait Implementations

impl Debug for SpriteMipLevel

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

Formats the value using the given formatter.

impl Deserialize for SpriteMipLevel

const SERIALIZED_SIZE: usize = 13usize

The length of the buffer passed into Deserialize::deserialize.

fn deserialize(src: &[u8]) -> Self

Deserializes the byte buffer into the struct. The length of src must match the same type’s Deserialize::SERIALIZED_SIZE constant.

impl Serialize for SpriteMipLevel

const SERIALIZED_SIZE: usize = 13usize

The length of the buffer passed into Serialize::serialize.

fn serialize(&self, dst: &mut [u8])

Serializes the struct into the byte buffer. The length of dst must match the same type’s Serialize::SERIALIZED_SIZE constant.