Struct Palette 

pub struct Palette {
    pub page: Color,
    pub raised: Color,
    pub overlay: Color,
    pub well: Option<Color>,
    pub bevel_light: Color,
    pub bevel_dark: Color,
    pub fidelity: Fidelity,
}

The resolved colours this renderer needs.

Supply them already quantised to whatever the terminal can show. That is what makes Palette::shows a plain inequality rather than a colour-space calculation: by the time a colour reaches here, the question of what the terminal will actually paint has been answered.

Fields

page: Color

surface-page.

raised: Color

surface-raised.

overlay: Color

surface-overlay.

well: Option<Color>

surface-well, absent on makeover before 2.3.0.

bevel_light: Color

bevel-light.

bevel_dark: Color

bevel-dark.

fidelity: Fidelity

What the terminal can show. Defaults to Fidelity::TrueColor.

Implementations

impl Palette

pub const fn fill(&self, fill: Fill) -> Option<Color>

Resolve a surface intent, or None where the theme has no such colour.

No substitution happens here. A missing intent stays missing, and frame answers it with structure instead of with a different colour.

pub const fn edge(&self, edge: Edge) -> Color

Resolve a bevel edge intent.

pub fn shows(fill: Color, behind: Color) -> bool

Whether painting fill over behind would show anything.

The whole of the terminal’s problem in one predicate. On a truecolor terminal this is almost always true; in sixteen colours it is false often enough that a design relying on fills is a design that vanishes.

pub fn two_tone(&self) -> bool

Whether this palette can express a bevel as two distinct edges.

Measured, this is the wrong thing to worry about: the two edge colours never quantise onto each other, at any depth, on any shipped theme. What does happen is an edge vanishing into the face it is drawn on, on every theme at sixteen colours. Kept because a hand-built palette can still collide, and cheap to ask.

pub const fn needs_glyph_depth(&self) -> bool

Whether depth has to be carried by glyphs rather than by colour.

True when the terminal cannot separate the two surfaces, which is the sixteen-colour case and nothing else.

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 Copy for Palette

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