Struct palette::Hsl

#[repr(C)]
pub struct Hsl<S = Srgb, T = f32> where
    T: Component + Float,
    S: RgbSpace,  {
    pub hue: RgbHue<T>,
    pub saturation: T,
    pub lightness: T,
    pub space: PhantomData<S>,
}

Linear 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.

space: PhantomData<S>

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

Methods

impl<T> Hsl<Srgb, T> where
    T: Component + Float, 

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: Component + Float,
    S: RgbSpace, 

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.

Trait Implementations

impl<S, T> FromColor<<S as RgbSpace>::WhitePoint, T> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait, 

fn from_xyz(color: Xyz<S::WhitePoint, T>) -> Self

Convert from XYZ color space

fn from_rgb<_S: RgbSpace<WhitePoint = S::WhitePoint>>(
    color: Rgb<Linear<_S>, T>
) -> Self

Convert from RGB color space

fn from_hsv<_S: RgbSpace<WhitePoint = S::WhitePoint>>(color: Hsv<_S, T>) -> Self

Convert from HSV color space

fn from_hsl<_S: RgbSpace<WhitePoint = S::WhitePoint>>(color: Hsl<_S, T>) -> Self

Convert from HSL color space

fn from_yxy(inp: Yxy<Wp, T>) -> Self

Convert from Yxy color space

fn from_lab(inp: Lab<Wp, T>) -> Self

Convert from Lab* color space

fn from_lch(inp: Lch<Wp, T>) -> Self

Convert from LCh° color space

fn from_hwb<S: RgbSpace<WhitePoint = Wp>>(inp: Hwb<S, T>) -> Self

Convert from HWB color space

fn from_luma(inp: Luma<Linear<Wp>, T>) -> Self

Convert from Luma

impl<S, Wp, T> IntoColor<Wp, T> for Hsl<S, T> where
    T: Component + Float,
    Wp: WhitePoint,
    S: RgbSpace<WhitePoint = Wp>, 

fn into_xyz(self) -> Xyz<Wp, T>

Convert into XYZ space

fn into_yxy(self) -> Yxy<Wp, T>

Convert into Yxy color space

fn into_lab(self) -> Lab<Wp, T>

Convert into Lab* color space

fn into_lch(self) -> Lch<Wp, T>

Convert into LCh° color space

fn into_rgb<Sp: RgbSpace<WhitePoint = Wp>>(self) -> Rgb<Linear<Sp>, T>

Convert into RGB color space.

fn into_hsl<Sp: RgbSpace<WhitePoint = Wp>>(self) -> Hsl<Sp, T>

Convert into HSL color space

fn into_hsv<Sp: RgbSpace<WhitePoint = Wp>>(self) -> Hsv<Sp, T>

Convert into HSV color space

fn into_luma(self) -> Luma<Linear<Wp>, T>

Convert into Luma

fn into_hwb<S: RgbSpace<WhitePoint = Wp>>(self) -> Hwb<S, T>

Convert into HWB color space

impl<S, T> Pixel<T> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace, 

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 from 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> Limited for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace, 

fn is_valid(&self) -> bool

Check if the color's components are within the expected ranges.

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

Return a new color where the components has 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> Mix for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace, 

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> Shade for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace, 

type Scalar = T

The type of the lighten/darken amount.

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

Lighten the color by amount.

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

Darken the color by amount.

impl<S, T> GetHue for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace, 

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: Component + Float,
    S: RgbSpace, 

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, T> Saturate for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace, 

type Scalar = T

The type of the (de)saturation factor.

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

Increase the saturation by factor.

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

Decrease the saturation by factor.

impl<S, T, P: ?Sized> AsRef<P> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    P: RawPixel<T>, 

fn as_ref(&self) -> &P

Performs the conversion.

impl<S, T, P: ?Sized> AsMut<P> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    P: RawPixel<T>, 

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

Performs the conversion.

impl<S: RgbSpace, T: Component + Float> Into<(RgbHue<T>, T, T)> for Hsl<S, T>

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

Performs the conversion.

impl<S, T, _S> From<Rgb<_S, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait,
    _S: RgbStandard<Space = S>, 

fn from(color: Rgb<_S, T>) -> Self

Performs the conversion.

impl<S, T, _S> From<Alpha<Rgb<_S, T>, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait,
    _S: RgbStandard<Space = S>, 

fn from(color: Alpha<Rgb<_S, T>, T>) -> Self

Performs the conversion.

impl<S, T, _S> From<Luma<_S, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait,
    _S: LumaStandard<WhitePoint = S::WhitePoint>, 

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

Performs the conversion.

impl<S, T, _S> From<Alpha<Luma<_S, T>, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait,
    _S: LumaStandard<WhitePoint = S::WhitePoint>, 

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

Performs the conversion.

impl<S, T> From<Alpha<Hsl<S, T>, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait, 

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

Performs the conversion.

impl<S, T> From<Alpha<Hsv<S, T>, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait, 

fn from(color: Alpha<Hsv<S, T>, T>) -> Self

Performs the conversion.

impl<S, T> From<Hwb<S, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait, 

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

Performs the conversion.

impl<S, T> From<Alpha<Hwb<S, T>, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait, 

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

Performs the conversion.

impl<S, T> From<Lab<<S as RgbSpace>::WhitePoint, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait, 

fn from(color: Lab<S::WhitePoint, T>) -> Self

Performs the conversion.

impl<S, T> From<Alpha<Lab<<S as RgbSpace>::WhitePoint, T>, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait, 

fn from(color: Alpha<Lab<S::WhitePoint, T>, T>) -> Self

Performs the conversion.

impl<S, T> From<Lch<<S as RgbSpace>::WhitePoint, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait, 

fn from(color: Lch<S::WhitePoint, T>) -> Self

Performs the conversion.

impl<S, T> From<Alpha<Lch<<S as RgbSpace>::WhitePoint, T>, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait, 

fn from(color: Alpha<Lch<S::WhitePoint, T>, T>) -> Self

Performs the conversion.

impl<S, T> From<Alpha<Xyz<<S as RgbSpace>::WhitePoint, T>, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait, 

fn from(color: Alpha<Xyz<S::WhitePoint, T>, T>) -> Self

Performs the conversion.

impl<S, T> From<Yxy<<S as RgbSpace>::WhitePoint, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait, 

fn from(color: Yxy<S::WhitePoint, T>) -> Self

Performs the conversion.

impl<S, T> From<Alpha<Yxy<<S as RgbSpace>::WhitePoint, T>, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait, 

fn from(color: Alpha<Yxy<S::WhitePoint, T>, T>) -> Self

Performs the conversion.

impl<S, T> From<Xyz<<S as RgbSpace>::WhitePoint, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace, 

fn from(color: Xyz<S::WhitePoint, T>) -> Self

Performs the conversion.

impl<S, Sp, T> From<Hsv<Sp, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    Sp: RgbSpace<WhitePoint = S::WhitePoint>, 

fn from(color: Hsv<Sp, T>) -> Self

Performs the conversion.

impl<S: RgbSpace, T: Component + Float, 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> From<Hsl<S, T>> for Alpha<Hsv<S, T>, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait, 

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

Performs the conversion.

impl<S, Sp, T> From<Hsl<Sp, T>> for Hsv<S, T> where
    T: Component + Float,
    S: RgbSpace,
    Sp: RgbSpace<WhitePoint = S::WhitePoint>, 

fn from(color: Hsl<Sp, T>) -> Self

Performs the conversion.

impl<S, T> From<Hsl<S, T>> for Hwb<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait, 

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

Performs the conversion.

impl<S, T> From<Hsl<S, T>> for Alpha<Hwb<S, T>, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait, 

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

Performs the conversion.

impl<Wp, T, _S> From<Hsl<_S, T>> for Lab<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + _FloatTrait,
    _S: RgbSpace<WhitePoint = Wp>, 

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

Performs the conversion.

impl<Wp, T, _S> From<Hsl<_S, T>> for Alpha<Lab<Wp, T>, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + _FloatTrait,
    _S: RgbSpace<WhitePoint = Wp>, 

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

Performs the conversion.

impl<Wp, T, _S> From<Hsl<_S, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + _FloatTrait,
    _S: RgbSpace<WhitePoint = Wp>, 

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

Performs the conversion.

impl<Wp, T, _S> From<Hsl<_S, T>> for Alpha<Lch<Wp, T>, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + _FloatTrait,
    _S: RgbSpace<WhitePoint = Wp>, 

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

Performs the conversion.

impl<S, T, _S> From<Hsl<_S, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + _FloatTrait,
    _S: RgbSpace<WhitePoint = S::WhitePoint>, 

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

Performs the conversion.

impl<S, T, _S> From<Hsl<_S, T>> for Alpha<Luma<S, T>, T> where
    T: Component,
    S: LumaStandard,
    T: Component + _FloatTrait,
    _S: RgbSpace<WhitePoint = S::WhitePoint>, 

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

Performs the conversion.

impl<S: RgbStandard, T: Component> From<Hsl<<S as RgbStandard>::Space, T>> for Alpha<Rgb<S, T>, T> where
    T: Component + _FloatTrait, 

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

Performs the conversion.

impl<S, T, Sp, Wp> From<Hsl<Sp, T>> for Rgb<S, T> where
    S: RgbStandard,
    T: Component + Float,
    Wp: WhitePoint,
    S::Space: RgbSpace<WhitePoint = Wp>,
    Sp: RgbSpace<WhitePoint = Wp>, 

fn from(color: Hsl<Sp, T>) -> Self

Performs the conversion.

impl<Wp, T, _S> From<Hsl<_S, T>> for Xyz<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + _FloatTrait,
    _S: RgbSpace<WhitePoint = Wp>, 

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

Performs the conversion.

impl<Wp, T, _S> From<Hsl<_S, T>> for Alpha<Xyz<Wp, T>, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + _FloatTrait,
    _S: RgbSpace<WhitePoint = Wp>, 

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

Performs the conversion.

impl<Wp, T, _S> From<Hsl<_S, T>> for Yxy<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + _FloatTrait,
    _S: RgbSpace<WhitePoint = Wp>, 

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

Performs the conversion.

impl<Wp, T, _S> From<Hsl<_S, T>> for Alpha<Yxy<Wp, T>, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + _FloatTrait,
    _S: RgbSpace<WhitePoint = Wp>, 

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

Performs the conversion.

impl<S, T> Clone for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S, T> Copy for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace, 

impl<S, T> Default for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace, 

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

Returns the "default value" for a type.

impl<S: PartialEq, T: PartialEq> PartialEq<Hsl<S, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace, 

fn eq(&self, other: &Hsl<S, T>) -> bool

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

fn ne(&self, other: &Hsl<S, T>) -> bool

This method tests for !=.

impl<S: Debug, T: Debug> Debug for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace, 

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

Formats the value using the given formatter.

impl<S, T> Sub<Hsl<S, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace, 

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: Component + Float,
    S: RgbSpace, 

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> Add<Hsl<S, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace, 

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: Component + Float,
    S: RgbSpace, 

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: Component + Float + AddAssign,
    S: RgbSpace, 

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

Performs the += operation.

impl<S, T> AddAssign<T> for Hsl<S, T> where
    T: Component + Float + AddAssign,
    S: RgbSpace, 

fn add_assign(&mut self, c: T)

Performs the += operation.

impl<S, T> SubAssign<Hsl<S, T>> for Hsl<S, T> where
    T: Component + Float + SubAssign,
    S: RgbSpace, 

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

Performs the -= operation.

impl<S, T> SubAssign<T> for Hsl<S, T> where
    T: Component + Float + SubAssign,
    S: RgbSpace, 

fn sub_assign(&mut self, c: T)

Performs the -= operation.

impl<S, T> StructuralPartialEq for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace, 

impl<S, T> AbsDiffEq<Hsl<S, T>> for Hsl<S, T> where
    T: Component + Float + AbsDiffEq,
    T::Epsilon: Copy + Float,
    S: RgbSpace + 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.

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

The inverse of ApproxEq::abs_diff_eq.

impl<S, T> RelativeEq<Hsl<S, T>> for Hsl<S, T> where
    T: Component + Float + RelativeEq,
    T::Epsilon: Copy + Float,
    S: RgbSpace + 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.

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

The inverse of ApproxEq::relative_eq.

impl<S, T> UlpsEq<Hsl<S, T>> for Hsl<S, T> where
    T: Component + Float + UlpsEq,
    T::Epsilon: Copy + Float,
    S: RgbSpace + 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.

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

The inverse of ApproxEq::ulps_eq.