Struct cushy::styles::ColorSource

pub struct ColorSource {
    pub hue: OklabHue,
    pub saturation: ZeroToOne,
}

A source for Colors.

This type is a combination of an OklabHue and a saturation ranging from 0.0 to 1.0. When combined with a luminance value, a Color can be generated.

The goal of this type is to allow various tones of a given hue/saturation to be generated easily.

Fields

hue: OklabHue

A measurement of hue, in degees, from -180 to 180.

For fully saturated bright colors:

• 0° corresponds to a kind of magenta-pink (RBG #ff0188),
• 90° to a kind of yellow (RBG RGB #ffcb00)
• 180° to a kind of cyan (RBG #00ffe1) and
• 240° to a kind of blue (RBG #00aefe).

saturation: ZeroToOne

A measurement of saturation.

A saturation of 0.0 corresponds to shades of gray, while a saturation of 1.0 corresponds to fully saturated colors.

Implementations

impl ColorSource

pub fn new(hue: impl Into<OklabHue>, saturation: impl Into<ZeroToOne>) -> Self

Returns a new source with the given hue (in degrees) and saturation (0.0

• 1.0).

pub fn color(self, lightness: impl Lightness) -> Color

Generates a new color by combing the hue, saturation, and lightness.

pub fn contrast_between(self, other: Self) -> ZeroToOne

Calculates an approximate ratio between 0.0 and 1.0 of how contrasting these colors are, with perfect constrast being two clors that are opposite of each other on the hue circle and one fully desaturated and the other fully saturated.

Trait Implementations

impl Clone for ColorSource

fn clone(&self) -> ColorSource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColorSource

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

Formats the value using the given formatter.

impl From<ColorSource> for ColorScheme

fn from(primary: ColorSource) -> Self

Converts to this type from the input type.

impl PartialEq for ColorSource

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> ProtoColor for &'a ColorSource

fn hue(&self) -> OklabHue

Returns the hue of this prototype color.

fn saturation(&self) -> Option<ZeroToOne>

Returns the saturation of this prototype color, if available.

fn into_source( self, saturation_if_not_provided: impl Into<ZeroToOne> ) -> ColorSource

Returns a color source built from this prototype color

impl ProtoColor for ColorSource

fn hue(&self) -> OklabHue

Returns the hue of this prototype color.

fn saturation(&self) -> Option<ZeroToOne>

Returns the saturation of this prototype color, if available.

fn into_source( self, saturation_if_not_provided: impl Into<ZeroToOne> ) -> ColorSource

Returns a color source built from this prototype color

impl Copy for ColorSource