Struct Palette 

pub struct Palette { /* private fields */ }

Named colors, built from the validated PaletteDef for a game’s ColorSet.

Implementations

impl Palette

pub fn new<C: ColorSet>(def: &PaletteDef) -> Result<Self, Vec<&'static str>>

Builds the palette for the colors of C. Fails with every one of required_names the definition lacks (a palette checked against them when it loaded never does).

pub fn get<C: ColorSet>(&self, color: C) -> Rgb

The RGB value of a color of the set the palette was built for. A color of another set is looked up by its name (black if there is no such name).

pub fn engine(&self, color: EngineColor) -> Rgb

The RGB value of an engine color.

pub fn lookup(&self, name: &str) -> Option<Rgb>

Looks up a data-driven color name (e.g. terrain).

pub fn iter(&self) -> impl Iterator<Item = (&str, Rgb)>

Every named color, alphabetically.

pub fn name_of(&self, rgb: Rgb) -> Option<&str>

The name of a color with exactly this RGB value, if any. When several names share a value, the set’s names win (in required_names order), then the alphabetically first other name.

Trait Implementations

impl Clone for Palette

fn clone(&self) -> Palette

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Palette

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

Formats the value using the given formatter.

impl Eq for Palette

impl PartialEq for Palette

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Palette