Struct SpriteTint 

pub struct SpriteTint {
    pub mask: Tint,
    pub tint: Tint,
}

Available on crate feature tilesets only.

The complete recolouring one sprite goes through in one cell: the sheet’s own treatment, then the cell’s tint.

Two stages rather than one because they do not always fold together. A SheetColor::Mask sheet is a multiply by the cell’s foreground, and a multiply composes with another multiply, but not with a Tint::Mix: “colour this mask red, then flash it half-way to white” is two operations and cannot be written as one.

Both pixel backends resolve through here, so a sprite recoloured on the software rasteriser and the same sprite recoloured in the GL fragment shader cannot disagree. The GL side uploads the two stages as instance attributes and mirrors apply’s order.

Fields

mask: Tint

The sheet’s own treatment, applied first.

Tint::Multiply by the cell’s resolved foreground colour for a SheetColor::Mask sheet, Tint::None for SheetColor::Art.

tint: Tint

The cell’s own tint, applied second.

Implementations

impl SpriteTint

pub const fn resolve( sheet: SheetColor, fg: Color, tint: Tint, default_fg: (u8, u8, u8), ) -> Self

Resolves what a sprite from a sheet-coloured tileset should look like in a cell with foreground fg and tint tint.

Takes the sheet’s declaration rather than the Sprite itself, because that is all the answer depends on: the GPU backend resolves against an atlas slot and never holds the pixels at draw time.

default_fg is the palette fallback for Color::Default, which has no reading as a modulation value on its own (see Tint); palette::DEFAULT_FG is what both backends pass.

pub const fn is_identity(&self) -> bool

Whether this leaves every pixel exactly as authored, so a renderer can take its untinted path.

pub const fn apply(&self, rgb: (u8, u8, u8)) -> (u8, u8, u8)

Applies both stages to one straight-alpha RGB triple, sheet treatment first.

Trait Implementations

impl Clone for SpriteTint

fn clone(&self) -> SpriteTint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SpriteTint

impl Debug for SpriteTint

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

Formats the value using the given formatter.

impl Default for SpriteTint

fn default() -> SpriteTint

Returns the “default value” for a type.

impl Eq for SpriteTint

impl PartialEq for SpriteTint

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SpriteTint