Struct palette::Hsl

#[repr(C)]
pub struct Hsl<S = Srgb, T = f32> where
    T: FloatComponent,
    S: RgbStandard,  {
    pub hue: RgbHue<T>,
    pub saturation: T,
    pub lightness: T,
    pub standard: PhantomData<S>,
}

HSL color space.

The HSL color space can be seen as a cylindrical version of RGB, where the hue is the angle around the color cylinder, the saturation is the distance from the center, and the lightness is the height from the bottom. Its composition makes it especially good for operations like changing green to red, making a color more gray, or making it darker.

See HSV for a very similar color space, with brightness instead of lightness.

Fields

hue: RgbHue<T>

The hue of the color, in degrees. Decides if it’s red, blue, purple, etc.

saturation: T

The colorfulness of the color. 0.0 gives gray scale colors and 1.0 will give absolutely clear colors.

lightness: T

Decides how light the color will look. 0.0 will be black, 0.5 will give a clear color, and 1.0 will give white.

standard: PhantomData<S>

The white point and RGB primaries this color is adapted to. The default is the sRGB standard.

Implementations

impl<T> Hsl<Srgb, T> where
    T: FloatComponent, 

pub fn new<H: Into<RgbHue<T>>>(
    hue: H,
    saturation: T,
    lightness: T
) -> Hsl<Srgb, T>

HSL for linear sRGB.

impl<S, T> Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

pub fn with_wp<H: Into<RgbHue<T>>>(
    hue: H,
    saturation: T,
    lightness: T
) -> Hsl<S, T>

Linear HSL.

pub fn into_components(self) -> (RgbHue<T>, T, T)

Convert to a (hue, saturation, lightness) tuple.

pub fn from_components<H: Into<RgbHue<T>>>(
    (hue, saturation, lightness): (H, T, T)
) -> Self

Convert from a (hue, saturation, lightness) tuple.

pub fn min_saturation() -> T

Return the saturation value minimum.

pub fn max_saturation() -> T

Return the saturation value maximum.

pub fn min_lightness() -> T

Return the lightness value minimum.

pub fn max_lightness() -> T

Return the lightness value maximum.

Trait Implementations

impl<S, T> AbsDiffEq<Hsl<S, T>> for Hsl<S, T> where
    T: FloatComponent + AbsDiffEq,
    T::Epsilon: Copy + Float + FromF64,
    S: RgbStandard + PartialEq, 

type Epsilon = T::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: T::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

pub fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<S, T> Add<Hsl<S, T>> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

type Output = Hsl<S, T>

The resulting type after applying the + operator.

fn add(self, other: Hsl<S, T>) -> Self::Output

Performs the + operation.

impl<S, T> Add<T> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

type Output = Hsl<S, T>

The resulting type after applying the + operator.

fn add(self, c: T) -> Self::Output

Performs the + operation.

impl<S, T> AddAssign<Hsl<S, T>> for Hsl<S, T> where
    T: FloatComponent + AddAssign,
    S: RgbStandard, 

fn add_assign(&mut self, other: Hsl<S, T>)

Performs the += operation.

impl<S, T> AddAssign<T> for Hsl<S, T> where
    T: FloatComponent + AddAssign,
    S: RgbStandard, 

fn add_assign(&mut self, c: T)

Performs the += operation.

impl<S, T, P: ?Sized> AsMut<P> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    P: RawPixel<T>, 

fn as_mut(&mut self) -> &mut P

Performs the conversion.

impl<S, T, P: ?Sized> AsRef<P> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    P: RawPixel<T>, 

fn as_ref(&self) -> &P

Performs the conversion.

impl<S, T> Clamp for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

fn is_within_bounds(&self) -> bool

Check if the color’s components are within the expected clamped range bounds.

fn clamp(&self) -> Hsl<S, T>

Return a new color where the components have been clamped to the nearest valid values.

fn clamp_self(&mut self)

Clamp the color’s components to the nearest valid values.

impl<S, T> Clone for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

fn clone(&self) -> Hsl<S, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug, T: Debug> Debug for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

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

Formats the value using the given formatter.

impl<S, T> Default for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

fn default() -> Hsl<S, T>

Returns the “default value” for a type.

impl<S: RgbStandard, T: FloatComponent, H: Into<RgbHue<T>>> From<(H, T, T)> for Hsl<S, T>

fn from(components: (H, T, T)) -> Self

Performs the conversion.

impl<S, T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    _C: IntoColorUnclamped<Self>,
    _A: Component, 

fn from_color_unclamped(color: Alpha<_C, _A>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Hsl<S, T>> for Hsv<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

fn from_color_unclamped(hsl: Hsl<S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Hsl<S, T>> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(color: Hsl<S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Hsl<S, T>> for Rgb<S, T> where
    S: RgbStandard,
    T: FloatComponent, 

fn from_color_unclamped(hsl: Hsl<S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S1, S2, T> FromColorUnclamped<Hsl<S1, T>> for Hsl<S2, T> where
    T: FloatComponent,
    S1: RgbStandard,
    S2: RgbStandard,
    S1::Space: RgbSpace<WhitePoint = <S2::Space as RgbSpace>::WhitePoint>, 

fn from_color_unclamped(hsl: Hsl<S1, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, _S> FromColorUnclamped<Hsl<_S, T>> for Hsluv<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

fn from_color_unclamped(color: Hsl<_S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, _S> FromColorUnclamped<Hsl<_S, T>> for Lab<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

fn from_color_unclamped(color: Hsl<_S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, _S> FromColorUnclamped<Hsl<_S, T>> for Lch<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

fn from_color_unclamped(color: Hsl<_S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, _S> FromColorUnclamped<Hsl<_S, T>> for Lchuv<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

fn from_color_unclamped(color: Hsl<_S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T, _S> FromColorUnclamped<Hsl<_S, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: FloatComponent,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = S::WhitePoint>, 

fn from_color_unclamped(color: Hsl<_S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, _S> FromColorUnclamped<Hsl<_S, T>> for Luv<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

fn from_color_unclamped(color: Hsl<_S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, _S> FromColorUnclamped<Hsl<_S, T>> for Xyz<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

fn from_color_unclamped(color: Hsl<_S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, _S> FromColorUnclamped<Hsl<_S, T>> for Yxy<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

fn from_color_unclamped(color: Hsl<_S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Hsluv<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(
    color: Hsluv<<S::Space as RgbSpace>::WhitePoint, T>
) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Hsv<S, T>> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

fn from_color_unclamped(hsv: Hsv<S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Hwb<S, T>> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(color: Hwb<S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Lab<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(
    color: Lab<<S::Space as RgbSpace>::WhitePoint, T>
) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Lch<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(
    color: Lch<<S::Space as RgbSpace>::WhitePoint, T>
) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Lchuv<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(
    color: Lchuv<<S::Space as RgbSpace>::WhitePoint, T>
) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T, _S> FromColorUnclamped<Luma<_S, T>> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent,
    _S: LumaStandard<WhitePoint = <S::Space as RgbSpace>::WhitePoint>, 

fn from_color_unclamped(color: Luma<_S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Luv<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(
    color: Luv<<S::Space as RgbSpace>::WhitePoint, T>
) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Rgb<S, T>> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

fn from_color_unclamped(rgb: Rgb<S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Xyz<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(
    color: Xyz<<S::Space as RgbSpace>::WhitePoint, T>
) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Yxy<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(
    color: Yxy<<S::Space as RgbSpace>::WhitePoint, T>
) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> GetHue for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

type Hue = RgbHue<T>

The kind of hue unit this color space uses.

fn get_hue(&self) -> Option<RgbHue<T>>

Calculate a hue if possible.

impl<S, T> Hue for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

fn with_hue<H: Into<Self::Hue>>(&self, hue: H) -> Hsl<S, T>

Return a new copy of self, but with a specific hue.

fn shift_hue<H: Into<Self::Hue>>(&self, amount: H) -> Hsl<S, T>

Return a new copy of self, but with the hue shifted by amount.

impl<S: RgbStandard, T: FloatComponent> Into<(RgbHue<T>, T, T)> for Hsl<S, T>

fn into(self) -> (RgbHue<T>, T, T)

Performs the conversion.

impl<S, T> Mix for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

type Scalar = T

The type of the mixing factor.

fn mix(&self, other: &Hsl<S, T>, factor: T) -> Hsl<S, T>

Mix the color with an other color, by factor.

impl<S, T> PartialEq<Hsl<S, T>> for Hsl<S, T> where
    T: FloatComponent + PartialEq,
    S: RgbStandard, 

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

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

#[must_use]

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

This method tests for !=.

impl<S, T> Pixel<T> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

const CHANNELS: usize

The number of color channels.

fn as_raw<P: RawPixel<T> + ?Sized>(&self) -> &P

Cast as a reference to raw color components.

fn as_raw_mut<P: RawPixel<T> + ?Sized>(&mut self) -> &mut P

Cast as a mutable reference to raw color components.

fn into_raw<P: RawPixelSized<T>>(self) -> P

Convert into raw color components.

fn from_raw<P: RawPixel<T> + ?Sized>(pixel: &P) -> &Self

Cast from a reference to raw color components.

fn from_raw_mut<P: RawPixel<T> + ?Sized>(pixel: &mut P) -> &mut Self

Cast from a mutable reference to raw color components.

fn from_raw_slice(slice: &[T]) -> &[Self]

Cast a slice of raw color components to a slice of colors.

fn from_raw_slice_mut(slice: &mut [T]) -> &mut [Self]

Cast a mutable slice of raw color components to a mutable slice of colors.

fn into_raw_slice(slice: &[Self]) -> &[T]

Cast a slice of colors to a slice of raw color components.

fn into_raw_slice_mut(slice: &mut [Self]) -> &mut [T]

Cast a mutable slice of colors to a mutable slice of raw color components.

impl<S, T> RelativeContrast for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

type Scalar = T

The type of the contrast ratio.

fn get_contrast_ratio(&self, other: &Self) -> T

Calculate the contrast ratio between two colors.

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

Verify the contrast between two colors satisfies SC 1.4.3. Contrast is at least 4.5:1 (Level AA).

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

Verify the contrast between two colors satisfies SC 1.4.3 for large text. Contrast is at least 3:1 (Level AA).

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

Verify the contrast between two colors satisfies SC 1.4.6. Contrast is at least 7:1 (Level AAA).

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

Verify the contrast between two colors satisfies SC 1.4.6 for large text. Contrast is at least 4.5:1 (Level AAA).

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

Verify the contrast between two colors satisfies SC 1.4.11 for graphical objects. Contrast is at least 3:1 (Level AA).

impl<S, T> RelativeEq<Hsl<S, T>> for Hsl<S, T> where
    T: FloatComponent + RelativeEq,
    T::Epsilon: Copy + Float + FromF64,
    S: RgbStandard + PartialEq, 

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq(
    &self,
    other: &Self,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

A test for equality that uses a relative comparison if the values are far apart.

pub fn relative_ne(
    &self,
    other: &Rhs,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

The inverse of RelativeEq::relative_eq.

impl<S, T> Saturate for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

type Scalar = T

The type of the (de)saturation modifier.

fn saturate(&self, factor: T) -> Hsl<S, T>

Scale the color towards the maximum saturation by factor, a value ranging from 0.0 to 1.0.

fn saturate_fixed(&self, amount: T) -> Hsl<S, T>

Increase the saturation by amount, a value ranging from 0.0 to 1.0.

fn desaturate(&self, factor: Self::Scalar) -> Self

Scale the color towards the minimum saturation by factor, a value ranging from 0.0 to 1.0.

fn desaturate_fixed(&self, amount: Self::Scalar) -> Self

Increase the saturation by amount, a value ranging from 0.0 to 1.0.

impl<S, T> Shade for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

type Scalar = T

The type of the lighten/darken modifier.

fn lighten(&self, factor: T) -> Hsl<S, T>

Scale the color towards the maximum lightness by factor, a value ranging from 0.0 to 1.0.

fn lighten_fixed(&self, amount: T) -> Hsl<S, T>

Lighten the color by amount, a value ranging from 0.0 to 1.0.

fn darken(&self, factor: Self::Scalar) -> Self

Scale the color towards the minimum lightness by factor, a value ranging from 0.0 to 1.0.

fn darken_fixed(&self, amount: Self::Scalar) -> Self

Darken the color by amount, a value ranging from 0.0 to 1.0.

impl<S, T> Sub<Hsl<S, T>> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

type Output = Hsl<S, T>

The resulting type after applying the - operator.

fn sub(self, other: Hsl<S, T>) -> Self::Output

Performs the - operation.

impl<S, T> Sub<T> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

type Output = Hsl<S, T>

The resulting type after applying the - operator.

fn sub(self, c: T) -> Self::Output

Performs the - operation.

impl<S, T> SubAssign<Hsl<S, T>> for Hsl<S, T> where
    T: FloatComponent + SubAssign,
    S: RgbStandard, 

fn sub_assign(&mut self, other: Hsl<S, T>)

Performs the -= operation.

impl<S, T> SubAssign<T> for Hsl<S, T> where
    T: FloatComponent + SubAssign,
    S: RgbStandard, 

fn sub_assign(&mut self, c: T)

Performs the -= operation.

impl<S, T> UlpsEq<Hsl<S, T>> for Hsl<S, T> where
    T: FloatComponent + UlpsEq,
    T::Epsilon: Copy + Float + FromF64,
    S: RgbStandard + PartialEq, 

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

pub fn ulps_ne(
    &self,
    other: &Rhs,
    epsilon: Self::Epsilon,
    max_ulps: u32
) -> bool

The inverse of UlpsEq::ulps_eq.

impl<S, T, _A> WithAlpha<_A> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    _A: Component, 

type Color = Self

The opaque color type, without any transparency.

type WithAlpha = Alpha<Self, _A>

The color type with transparency applied.

fn with_alpha(self, alpha: _A) -> Self::WithAlpha

Transforms the color into a transparent color with the provided alpha value. If Self already has a transparency, it is overwritten.

fn without_alpha(self) -> Self::Color

Removes the transparency from the color. If Self::Color has an internal transparency field, that field will be set to A::max_intensity() to make it opaque.

fn split(self) -> (Self::Color, _A)

Splits the color into separate color and transparency values.

fn opaque(self) -> Self::WithAlpha

Transforms the color into a fully opaque color with a transparency field. If Self already has a transparency, it is overwritten.

fn transparent(self) -> Self::WithAlpha

Transforms the color into a fully transparent color. If Self already has a transparency, it is overwritten.

impl<S, T> Copy for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

impl<S, T> Eq for Hsl<S, T> where
    T: FloatComponent + Eq,
    S: RgbStandard,