Struct zng::color::Hsla

pub struct Hsla {
    pub hue: f32,
    pub saturation: f32,
    pub lightness: f32,
    pub alpha: f32,
}

HSL + alpha.

Equality

Equality is determined using about_eq with 0.001 epsilon for hue and 0.00001 epsilon for the others.

Fields

hue: f32

Hue color angle in the [0.0..=360.0] range.

saturation: f32

Saturation amount in the [0.0..=1.0] range, zero is gray, one is full color.

lightness: f32

Lightness amount in the [0.0..=1.0] range, zero is black, one is white.

alpha: f32

Alpha channel in the [0.0..=1.0] range, zero is invisible, one is opaque.

Implementations

impl Hsla

pub fn set_hue<H>(&mut self, hue: H)

where H: Into<AngleDegree>,

Sets the hue color angle.

The value is normalized to be in the [0.0..=360.0] range, that is 362.deg() becomes 2.0.

pub fn set_lightness<L>(&mut self, lightness: L)

where L: Into<Factor>,

Sets the lightness value.

pub fn set_saturation<S>(&mut self, saturation: S)

where S: Into<Factor>,

Sets the saturation value.

pub fn set_alpha<A>(&mut self, alpha: A)

where A: Into<Factor>,

Sets the alpha value.

pub fn with_hue<H>(self, hue: H) -> Hsla

where H: Into<AngleDegree>,

Returns a copy of this color with a new hue.

pub fn with_lightness<L>(self, lightness: L) -> Hsla

where L: Into<Factor>,

Returns a copy of this color with a new lightness.

pub fn with_saturation<S>(self, saturation: S) -> Hsla

where S: Into<Factor>,

Returns a copy of this color with a new saturation.

pub fn with_alpha<A>(self, alpha: A) -> Hsla

where A: Into<Factor>,

Returns a copy of this color with a new alpha.

pub fn slerp(self, to: Hsla, factor: Factor) -> Hsla

Interpolate in the LerpSpace::Hsla mode.

pub fn is_chromatic(self) -> bool

If the saturation is more than zero.

If false the color is achromatic, the hue value does not affect the color.

pub fn slerp_chromatic(self, to: Hsla, factor: Factor) -> Hsla

Interpolate in the LerpSpace::HslaChromatic mode.

Trait Implementations

impl Clone for Hsla

fn clone(&self) -> Hsla

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hsla

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Hsla

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Hsla

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

Formats the value using the given formatter.

impl From<Hsla> for BorderSide

fn from(color: Hsla) -> BorderSide

Solid color.

impl From<Hsla> for BorderSides

fn from(color: Hsla) -> BorderSides

All sides solid color.

impl From<Hsla> for ColorStop

fn from(positional_color: Hsla) -> ColorStop

Converts to this type from the input type.

impl From<Hsla> for GradientStop

fn from(positional_color: Hsla) -> GradientStop

Conversion to positional color.

impl From<Hsla> for Hsva

fn from(hsla: Hsla) -> Hsva

Converts to this type from the input type.

impl From<Hsla> for LightDark

fn from(color: Hsla) -> LightDark

From same color to both.

impl From<Hsla> for PreMulRgba

fn from(c: Hsla) -> PreMulRgba

Converts to this type from the input type.

impl From<Hsla> for Rgba

fn from(hsla: Hsla) -> Rgba

Converts to this type from the input type.

impl From<Hsva> for Hsla

fn from(hsva: Hsva) -> Hsla

Converts to this type from the input type.

impl From<PreMulRgba> for Hsla

fn from(c: PreMulRgba) -> Hsla

Converts to this type from the input type.

impl From<Rgba> for Hsla

fn from(rgba: Rgba) -> Hsla

Converts to this type from the input type.

impl Hash for Hsla

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoVar<BorderSide> for Hsla

fn into_var(self) -> <Hsla as IntoVar<BorderSide>>::Var

Solid color.

type Var = LocalVar<BorderSide>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<BorderSides> for Hsla

fn into_var(self) -> <Hsla as IntoVar<BorderSides>>::Var

All sides solid color.

type Var = LocalVar<BorderSides>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<ColorStop> for Hsla

type Var = LocalVar<ColorStop>

Variable type that will wrap the T value.

fn into_var(self) -> <Hsla as IntoVar<ColorStop>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<GradientStop> for Hsla

fn into_var(self) -> <Hsla as IntoVar<GradientStop>>::Var

Conversion to positional color.

type Var = LocalVar<GradientStop>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Hsla> for Hsva

type Var = LocalVar<Hsla>

Variable type that will wrap the T value.

fn into_var(self) -> <Hsva as IntoVar<Hsla>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Hsla> for PreMulRgba

type Var = LocalVar<Hsla>

Variable type that will wrap the T value.

fn into_var(self) -> <PreMulRgba as IntoVar<Hsla>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Hsla> for Rgba

type Var = LocalVar<Hsla>

Variable type that will wrap the T value.

fn into_var(self) -> <Rgba as IntoVar<Hsla>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Hsva> for Hsla

type Var = LocalVar<Hsva>

Variable type that will wrap the T value.

fn into_var(self) -> <Hsla as IntoVar<Hsva>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<LightDark> for Hsla

fn into_var(self) -> <Hsla as IntoVar<LightDark>>::Var

From same color to both.

type Var = LocalVar<LightDark>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<PreMulRgba> for Hsla

type Var = LocalVar<PreMulRgba>

Variable type that will wrap the T value.

fn into_var(self) -> <Hsla as IntoVar<PreMulRgba>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Rgba> for Hsla

type Var = LocalVar<Rgba>

Variable type that will wrap the T value.

fn into_var(self) -> <Hsla as IntoVar<Rgba>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl MixAdjust for Hsla

fn mix_normal(self, background: Hsla) -> Hsla

MixAdjust background over self using the MixBlendMode::Normal.

fn mix_multiply(self, background: Hsla) -> Hsla

MixAdjust background over self using the MixBlendMode::Multiply.

fn mix_screen(self, background: Hsla) -> Hsla

MixAdjust background over self using the MixBlendMode::Screen.

fn mix_overlay(self, background: Hsla) -> Hsla

MixAdjust background over self using the MixBlendMode::Overlay.

fn mix_darken(self, background: Hsla) -> Hsla

MixAdjust background over self using the MixBlendMode::Darken.

fn mix_lighten(self, background: Hsla) -> Hsla

MixAdjust background over self using the MixBlendMode::Lighten.

fn mix_colordodge(self, background: Hsla) -> Hsla

MixAdjust background over self using the MixBlendMode::ColorDodge.

fn mix_colorburn(self, background: Hsla) -> Hsla

MixAdjust background over self using the MixBlendMode::ColorBurn.

fn mix_hardlight(self, background: Hsla) -> Hsla

MixAdjust background over self using the MixBlendMode::HardLight.

fn mix_softlight(self, background: Hsla) -> Hsla

MixAdjust background over self using the MixBlendMode::SoftLight.

fn mix_difference(self, background: Hsla) -> Hsla

MixAdjust background over self using the MixBlendMode::Difference.

fn mix_exclusion(self, background: Hsla) -> Hsla

MixAdjust background over self using the MixBlendMode::Exclusion.

fn mix_hue(self, background: Hsla) -> Hsla

MixAdjust self over background using the MixBlendMode::Hue`.

fn mix_saturation(self, background: Hsla) -> Hsla

MixAdjust self over background using the MixBlendMode::Saturation`.

fn mix_color(self, background: Hsla) -> Hsla

MixAdjust self over background using the MixBlendMode::Color`.

fn mix_luminosity(self, background: Hsla) -> Hsla

MixAdjust self over background using the MixBlendMode::Luminosity`.

fn lighten<A>(self, amount: A) -> Hsla

where A: Into<Factor>,

Adds the amount to the color lightness.

fn darken<A>(self, amount: A) -> Hsla

where A: Into<Factor>,

Subtracts the amount from the color lightness.

fn desaturate<A>(self, amount: A) -> Hsla

where A: Into<Factor>,

Subtracts the amount from the color saturation.

fn with_lightness<L>(self, lightness: L) -> Hsla

where L: Into<Factor>,

Returns a copy of this color with a new lightness.

fn mix(self, mode: MixBlendMode, background: Self) -> Self

where Self: Sized,

MixAdjust background over self using the mode.

impl PartialEq for Hsla

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

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 Transitionable for Hsla

fn lerp(self, to: &Hsla, step: Factor) -> Hsla

Sample the linear interpolation from self -> to by step.

impl Copy for Hsla

impl IntoValue<BorderSide> for Hsla

impl IntoValue<BorderSides> for Hsla

impl IntoValue<ColorStop> for Hsla

impl IntoValue<GradientStop> for Hsla

impl IntoValue<Hsla> for Hsva

impl IntoValue<Hsla> for PreMulRgba

impl IntoValue<Hsla> for Rgba

impl IntoValue<Hsva> for Hsla

impl IntoValue<LightDark> for Hsla

impl IntoValue<PreMulRgba> for Hsla

impl IntoValue<Rgba> for Hsla