Struct Sprite 

#[non_exhaustive]
pub struct Sprite {
    pub pixels: Vec<u8>,
    pub pixel_width: u32,
    pub pixel_height: u32,
    pub align: SpriteAlign,
    pub color: SheetColor,
}

A decoded, ready-to-blit sprite.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

pixels: Vec<u8>

RGBA8 pixel data, row-major, pixel_width * pixel_height * 4 bytes.

pixel_width: u32

Pixel width of the sprite.

pixel_height: u32

Pixel height of the sprite.

align: SpriteAlign

Where this sprite sits inside the multi-cell box a span reserves for it.

color: SheetColor

What this sprite’s own sheet declared its pixels to mean.

Copied from the sheet at load time rather than looked up at draw time: a SpriteCache is a flat map keyed by codepoint, so a sprite loses track of which sheet it came from the moment it lands there. One byte per sprite keeps the sheet’s declaration with the pixels it describes.

Implementations

impl Sprite

pub const fn align_offset( &self, span_w: u16, span_h: u16, glyph_w: u8, glyph_h: u8, ) -> (i16, i16)

Returns the offset, in unscaled pixels, from the top-left corner of a span_w x span_h cell box to where this sprite’s own top-left pixel belongs, per align.

span_w/span_h come from Tile::span and glyph_w/ glyph_h are the unscaled cell size, so the box is span_w * glyph_w x span_h * glyph_h pixels. A zero cell size is treated as one pixel, leaving the sprite on its anchor rather than offsetting it by a meaningless amount.

Returns (0, 0) whenever the art already fills its box, which is the common case, so a backend can add the result to a tile’s dx/dy unconditionally.

Trait Implementations

impl Clone for Sprite

fn clone(&self) -> Sprite

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sprite

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

Formats the value using the given formatter.