Struct TilesetOptions 

#[non_exhaustive]
pub struct TilesetOptions {
    pub bytes: Vec<u8>,
    pub tile_width: u16,
    pub tile_height: u16,
    pub columns: Option<u16>,
    pub codepage: Codepage,
    pub align: SpriteAlign,
    pub color: SheetColor,
    pub transparent_color: Option<(u8, u8, u8)>,
}

Options for loading a single tileset (sprite sheet).

Sprites carry their own color

By default (SheetColor::Art) a tileset’s artwork is composited verbatim: the cell’s Style::fg does not tint it, so a full-color sheet renders exactly as authored. The cell’s background is still painted behind the sprite and shows through its transparent pixels.

A sheet authored as white-on-transparent masks declares SheetColor::Mask instead, and its sprites are colored by the cell’s foreground the way a bitmap font glyph is.

Recoloring one piece of artwork per cell (biome variants, damage flashes) is a per-draw decision rather than a sheet-wide one, and goes through Surface::with_tint.

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.

bytes: Vec<u8>

Raw bytes of the sprite sheet image (any format the image crate supports).

tile_width: u16

Width of a single tile in pixels.

tile_height: u16

Height of a single tile in pixels.

columns: Option<u16>

Number of tiles per row in the sprite sheet.

If None, derived as image_width / tile_width.

codepage: Codepage

Codepoint mapping from tile index to Unicode character.

align: SpriteAlign

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

color: SheetColor

What this sheet’s pixels mean, and so whether the cell’s foreground color colors them.

transparent_color: Option<(u8, u8, u8)>

If set, any pixel matching this RGB colour is made fully transparent (alpha = 0) when decoding the tileset.

Useful for spritesheets that use a solid colour background instead of an alpha channel. Equivalent to bracket-lib’s with_font_bg() or doryen-rs’s top-left-pixel key colour auto-detection.

Implementations

impl TilesetOptions

pub const fn builder(bytes: Vec<u8>) -> TilesetBuilder

Starts building a tileset from raw sprite sheet bytes.

Pass include_bytes!("...").to_vec() to embed the asset at compile time, or std::fs::read(path)? to load it at runtime.

Trait Implementations

impl Clone for TilesetOptions

fn clone(&self) -> TilesetOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TilesetOptions

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

Formats the value using the given formatter.

impl Eq for TilesetOptions

impl PartialEq for TilesetOptions

fn eq(&self, other: &TilesetOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TilesetOptions