Enum SheetColor 

#[non_exhaustive]
pub enum SheetColor {
    Art,
    Mask,
}

Available on crate feature tilesets only.

What a tileset’s pixels mean, which decides how its sprites respond to the cell’s foreground color.

This is a fact about how the artwork was authored, not about any one draw call, which is why it sits on the tileset rather than at the call site. A sheet of full-color terrain and a sheet of white icon masks can be loaded side by side and each behave correctly.

Orthogonal to Tint, which is per-cell and applies on top: see Surface::with_tint.

Open question (retroglyph#559): a sheet mixing mask tiles and full-colour art tiles has no way to say so today, since this is a sheet-wide setting. The likely answer is to split such a sheet into two TilesetOptions loads, one per SheetColor, rather than adding a per-tile escape hatch here. That is untested against a real mixed asset and not resolved by this type as written.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Art

Full-color artwork, composited verbatim.

The cell’s Style::fg does not touch it. The default, because a sheet that carries its own color is the common case and rendering it as authored is the unsurprising outcome.

Mask

A white-on-transparent mask, colored by the cell’s foreground the way a font glyph is.

Equivalent to a Tint::Multiply by the resolved foreground color, so a white pixel takes the foreground exactly and a grey one takes a proportionally darker shade. This is how libtcod tilesets, Dwarf Fortress’s classic tileset, and BearLibTerminal’s bitmap fonts all behave, and it is the one case where reading fg as a sprite’s color is correct rather than a workaround.

It also keeps a sprite and its text fallback in agreement: the same fg colors the sprite on a pixel backend and the fallback glyph on a cell backend.

Trait Implementations

impl Clone for SheetColor

fn clone(&self) -> SheetColor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SheetColor

impl Debug for SheetColor

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

Formats the value using the given formatter.

impl Default for SheetColor

fn default() -> SheetColor

Returns the “default value” for a type.

impl Eq for SheetColor

impl Hash for SheetColor

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SheetColor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SheetColor