Struct TilesetBuilder 

pub struct TilesetBuilder { /* private fields */ }

Builder for TilesetOptions.

Construct via TilesetOptions::builder.

columns defaults to image_width / tile_width, so you usually don’t need to set it explicitly. codepage defaults to Codepage::Cp437.

Examples

Standard CP437 tileset:

use retroglyph_window::tileset::TilesetOptions;

let png: Vec<u8> = std::fs::read("assets/cp437_16x16.png").unwrap();
let opts = TilesetOptions::builder(png)
    .tile_size(16, 16) // codepage defaults to Cp437
    .build()
    .unwrap();

Private-use sprite sheet addressed by index, centred in whatever box a span reserves:

use retroglyph_window::tileset::{Codepage, SpriteAlign, TilesetOptions};

let png: Vec<u8> = std::fs::read("assets/sprites.png").unwrap();
let opts = TilesetOptions::builder(png)
    .tile_size(32, 32)
    .codepage(Codepage::Identity)  // tile 0 = '\0', tile 1 = '\x01', …
    .align(SpriteAlign::Center)
    .build()
    .unwrap();

How many cells a sprite occupies is a per-write decision, not a tileset-wide one: declare it with Surface::put_span at the draw call.

Unicode private-use area sprite sheet:

use retroglyph_window::tileset::TilesetOptions;

let png: Vec<u8> = std::fs::read("assets/monsters.png").unwrap();
let opts = TilesetOptions::builder(png)
    .tile_size(16, 16)
    .start_codepoint('\u{E000}') // maps to Unicode PUA starting at U+E000
    .build()
    .unwrap();

Implementations

impl TilesetBuilder

pub const fn tile_size(self, width: u16, height: u16) -> Self

Sets the pixel dimensions of each tile.

pub const fn columns(self, cols: u16) -> Self

Sets the number of tiles per row in the sprite sheet.

Useful for sheets with padding. If not set, derived from image width.

pub fn codepage(self, codepage: Codepage) -> Self

Sets the codepoint mapping.

pub fn start_codepoint(self, start: char) -> Self

Sets the codepoint of the first tile; subsequent tiles increment by 1.

Shorthand for codepage(Codepage::Unicode { start }).

pub const fn align(self, align: SpriteAlign) -> Self

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

Defaults to SpriteAlign::TopLeft. Has no visible effect on a sprite whose art fills its box exactly; see SpriteAlign.

pub const fn color(self, color: SheetColor) -> Self

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

Defaults to SheetColor::Art: composited verbatim. See SheetColor.

pub const fn mask(self) -> Self

Shorthand for color(SheetColor::Mask): this sheet is white-on- transparent artwork to be colored by each cell’s foreground.

pub const fn transparent_color(self, r: u8, g: u8, b: u8) -> Self

Pixels matching (r, g, b) are made fully transparent (alpha = 0).

Use this for spritesheets that use a solid colour background instead of an alpha channel.

pub fn build(self) -> Result<TilesetOptions, TilesetError>

Validates and builds TilesetOptions.

Errors

Returns TilesetError::ZeroTileSize if tile dimensions are 0, or TilesetError::EmptyCodepage if Custom codepage is empty.