Struct cushy::styles::ColorSchemeBuilder

pub struct ColorSchemeBuilder {
    pub primary: ColorSource,
    pub secondary: Option<ColorSource>,
    pub tertiary: Option<ColorSource>,
    pub error: Option<ColorSource>,
    pub neutral: Option<ColorSource>,
    pub neutral_variant: Option<ColorSource>,
    /* private fields */
}

A builder of ColorSchemes.

Fields

primary: ColorSource

The primary color of the scheme.

secondary: Option<ColorSource>

The secondary color of the scheme. If not provided, a complimentary color will be chosen.

tertiary: Option<ColorSource>

The tertiary color of the scheme. If not provided, a complimentary color will be chosen.

error: Option<ColorSource>

The error color of the scheme. If not provided, red will be used unless it contrasts poorly with any of the other colors.

neutral: Option<ColorSource>

The neutral color of the scheme. If not provided, a nearly fully desaturated variation of the primary color will be used.

neutral_variant: Option<ColorSource>

The neutral variant color of the scheme. If not provided, a mostly desaturated variation of the primary color will be used.

Implementations

impl ColorSchemeBuilder

pub fn new(primary: impl ProtoColor) -> Self

Returns a builder for the provided primary color.

pub fn secondary(self, secondary: impl ProtoColor) -> Self

Sets the secondary color and returns self.

If secondary doesn’t specify a saturation, a saturation value that is 50% of the primary saturation will be picked.

pub fn tertiary(self, tertiary: impl ProtoColor) -> Self

Sets the tertiary color and returns self.

If tertiary doesn’t specify a saturation, a saturation value that is 33% of the primary saturation will be picked.

pub fn error(self, error: impl ProtoColor) -> Self

Sets the error color and returns self.

If error doesn’t specify a saturation, the primary color’s saturation will be used.

pub fn neutral(self, neutral: impl ProtoColor) -> Self

Sets the neutral color and returns self.

If neutral doesn’t specify a saturation, a saturation of 1%.

pub fn neutral_variant(self, neutral_variant: impl ProtoColor) -> Self

Sets the neutral color and returns self.

If neutral_variant doesn’t specify a saturation, a saturation value that is 10% of the primary saturation will be picked.

pub fn hue_shift(self, hue_shift: impl Into<OklabHue>) -> Self

Sets the amount the hue component is shifted when auto-generating colors to fill in the palette.

The default hue shift is 30 degrees.

pub fn build(self) -> ColorScheme

Builds a color scheme from the provided colors, generating any unspecified colors.

Trait Implementations

impl Clone for ColorSchemeBuilder

fn clone(&self) -> ColorSchemeBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColorSchemeBuilder

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

Formats the value using the given formatter.

impl PartialEq for ColorSchemeBuilder

fn eq(&self, other: &ColorSchemeBuilder) -> 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 Copy for ColorSchemeBuilder

impl StructuralPartialEq for ColorSchemeBuilder