Struct Palette 

pub struct Palette {
    pub dark: bool,
    pub high_contrast: bool,
    pub hue: Option<f32>,
    pub chroma: f32,
    pub surfaces: SurfaceLadder,
    pub ink: InkLadder,
    pub status: StatusTones,
}

The neutral material and its inks.

Fields

dark: bool

Ink is light on these surfaces.

high_contrast: bool

Every text pairing holds WCAG AAA, floating chrome is opaque, and content surfaces are asked to force their colours.

hue: Option<f32>

The OKLCH hue every neutral shares, in degrees. None until something gives the material a temperature: a palette without a hue renders pure grey whatever its chroma, and the workspace it is shown in supplies one (Theme::with_neutral_hue).

chroma: f32

The neutrals’ chroma, 0 (pure grey) to NEUTRAL_MAX_CHROMA: how much temperature the material takes once it has a hue. At 0 a workspace’s temperature has nothing to tint.

surfaces: SurfaceLadder

ink: InkLadder

status: StatusTones

Implementations

impl Palette

pub const fn dark() -> Palette

The default: the dark ladder in pure neutral grey.

pub const fn dark_cool() -> Palette

The dark ladder, cool.

pub const fn dark_graphite() -> Palette

The dark ladder, warm graphite.

pub const fn dark_soft() -> Palette

A lifted dark ladder, faintly violet: lower contrast between ground and ink for long sessions. The tertiary tier rises with the surfaces so it still reads as body text on content.

pub const fn light() -> Palette

The light ladder. It has no hue of its own: pure grey until the workspace it is shown in gives it a temperature, which its chroma then carries.

pub const fn high_contrast_dark() -> Palette

Black ground under near-white ink: every text pairing at WCAG AAA.

pub const fn high_contrast_light() -> Palette

White ground under black ink: every text pairing at WCAG AAA.

pub fn temperature(&self) -> (f32, f32)

The hue and chroma the neutrals are painted at: the palette’s own when it has a hue, pure grey (chroma 0) until it has one.

pub const fn stock_presence(&self) -> Tone

The presence tone this polarity ships with.

pub fn validate(&self) -> Result<(), &'static str>

Structural check: finite numbers in range and a ladder whose ink sits on the right side of every surface. Legibility is checked on the materialized colours (crate::tokens::contrast::audit).

Errors

A static message naming the first field out of range.

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<(), Error>

Formats the value using the given formatter.

impl Default for Palette

fn default() -> Palette

The default theme’s palette: pure neutral dark.

impl<'de> Deserialize<'de> for Palette

fn deserialize<__D>( __deserializer: __D, ) -> Result<Palette, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Palette

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Palette

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Palette

impl StructuralPartialEq for Palette