Struct Hsl

#[repr(C)]
pub struct Hsl<S = Srgb, T = f32> {
    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.

HSL component values are typically real numbers (such as floats), but may also be converted to and from u8 for storage and interoperability purposes. The hue is then within the range [0, 255].

use approx::assert_relative_eq;
use palette::Hsl;

let hsl_u8 = Hsl::new_srgb(128u8, 85, 51);
let hsl_f32 = hsl_u8.into_format::<f32>();

assert_relative_eq!(hsl_f32, Hsl::new(180.0, 1.0 / 3.0, 0.2));

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>

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

Create an sRGB HSL color. This method can be used instead of Hsl::new to help type inference.

pub const fn new_srgb_const(hue: RgbHue<T>, saturation: T, lightness: T) -> Self

Create an sRGB HSL color. This is the same as Hsl::new_srgb without the generic hue type. It’s temporary until const fn supports traits.

impl<S, T> Hsl<S, T>

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

Create an HSL color.

pub const fn new_const(hue: RgbHue<T>, saturation: T, lightness: T) -> Self

Create an HSL color. This is the same as Hsl::new without the generic hue type. It’s temporary until const fn supports traits.

pub fn into_format<U>(self) -> Hsl<S, U>

where U: FromStimulus<T> + FromAngle<T>,

Convert into another component type.

pub fn from_format<U>(color: Hsl<S, U>) -> Self

where T: FromStimulus<U> + FromAngle<U>,

Convert from another component type.

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.

impl<S, T> Hsl<S, T>

where T: Stimulus,

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.

impl<S, T> Hsl<S, &T>

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

where T: Copy,

Get an owned, copied version of this color.

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

where T: Clone,

Get an owned, cloned version of this color.

impl<S, T> Hsl<S, &mut T>

pub fn set(&mut self, value: Hsl<S, T>)

Update this color with new values.

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

Borrow this color’s components as shared references.

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

where T: Copy,

Get an owned, copied version of this color.

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

where T: Clone,

Get an owned, cloned version of this color.

impl<S, C> Hsl<S, C>

pub fn iter<'a>(&'a self) -> <&'a Self as IntoIterator>::IntoIter

where &'a Self: IntoIterator,

Return an iterator over the colors in the wrapped collections.

pub fn iter_mut<'a>(&'a mut self) -> <&'a mut Self as IntoIterator>::IntoIter

where &'a mut Self: IntoIterator,

Return an iterator that allows modifying the colors in the wrapped collections.

pub fn get<'a, I, T>( &'a self, index: I, ) -> Option<Hsl<S, &<I as SliceIndex<[T]>>::Output>>

where T: 'a, C: AsRef<[T]>, I: SliceIndex<[T]> + Clone,

Get a color, or slice of colors, with references to the components at index. See slice::get for details.

pub fn get_mut<'a, I, T>( &'a mut self, index: I, ) -> Option<Hsl<S, &mut <I as SliceIndex<[T]>>::Output>>

where T: 'a, C: AsMut<[T]>, I: SliceIndex<[T]> + Clone,

Get a color, or slice of colors, that allows modifying the components at index. See slice::get_mut for details.

impl<S, T> Hsl<S, Vec<T>>

pub fn with_capacity(capacity: usize) -> Self

Create a struct of vectors with a minimum capacity. See Vec::with_capacity for details.

pub fn push(&mut self, value: Hsl<S, T>)

Push an additional color’s components onto the component vectors. See Vec::push for details.

pub fn pop(&mut self) -> Option<Hsl<S, T>>

Pop a color’s components from the component vectors. See Vec::pop for details.

pub fn clear(&mut self)

Clear the component vectors. See Vec::clear for details.

pub fn drain<R>(&mut self, range: R) -> Iter<Drain<'_, T>, S>

where R: RangeBounds<usize> + Clone,

Return an iterator that moves colors out of the specified range.

Trait Implementations

impl<S, T> AbsDiffEq for Hsl<S, T>

where T: AbsDiffEq, T::Epsilon: Clone, RgbHue<T>: AbsDiffEq<Epsilon = T::Epsilon>,

type Epsilon = <T as AbsDiffEq>::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: &Self, epsilon: T::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<S, T> Add<T> for Hsl<S, T>

where T: Add<Output = T> + Clone,

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> Add for Hsl<S, T>

where T: Add<Output = T>,

type Output = Hsl<S, T>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl<S, T> AddAssign<T> for Hsl<S, T>

where T: AddAssign + Clone,

fn add_assign(&mut self, c: T)

Performs the += operation.

impl<S, T> AddAssign for Hsl<S, T>

where T: AddAssign,

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<S, T> ArrayCast for Hsl<S, T>

type Array = [T; 3]

The output type of a cast to an array.

impl<S, T> AsMut<[T]> for Hsl<S, T>

fn as_mut(&mut self) -> &mut [T]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<S, T> AsMut<[T; 3]> for Hsl<S, T>

fn as_mut(&mut self) -> &mut [T; 3]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<S, T> AsMut<Hsl<S, T>> for [T; 3]

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<S, T> AsRef<[T]> for Hsl<S, T>

fn as_ref(&self) -> &[T]

Converts this type into a shared reference of the (usually inferred) input type.

impl<S, T> AsRef<[T; 3]> for Hsl<S, T>

fn as_ref(&self) -> &[T; 3]

Converts this type into a shared reference of the (usually inferred) input type.

impl<S, T> AsRef<Hsl<S, T>> for [T; 3]

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

Converts this type into a shared reference of the (usually inferred) input type.

impl<S, T> Clamp for Hsl<S, T>

where T: Clamp + Stimulus,

fn clamp(self) -> Self

Return a new color where out-of-bounds components have been changed to the nearest valid values.

impl<S, T> ClampAssign for Hsl<S, T>

where T: ClampAssign + Stimulus,

fn clamp_assign(&mut self)

Changes out-of-bounds components to the nearest valid values.

impl<S, T> Clone for Hsl<S, T>

where T: Clone,

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: Debug, T: Debug> Debug for Hsl<S, T>

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

Formats the value using the given formatter.

impl<S, T> Default for Hsl<S, T>

where T: Stimulus, RgbHue<T>: Default,

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

Returns the “default value” for a type.

impl<'de, S, T> Deserialize<'de> for Hsl<S, T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S, T, C> Extend<Hsl<S, T>> for Hsl<S, C>

where C: Extend<T>,

fn extend<I: IntoIterator<Item = Hsl<S, T>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a, S, T> From<&'a [T; 3]> for &'a Hsl<S, T>

fn from(array: &'a [T; 3]) -> Self

Converts to this type from the input type.

impl<'a, S, T> From<&'a Hsl<S, T>> for &'a [T]

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

Converts to this type from the input type.

impl<'a, S, T> From<&'a Hsl<S, T>> for &'a [T; 3]

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

Converts to this type from the input type.

impl<'a, S, T> From<&'a mut [T; 3]> for &'a mut Hsl<S, T>

fn from(array: &'a mut [T; 3]) -> Self

Converts to this type from the input type.

impl<'a, S, T> From<&'a mut Hsl<S, T>> for &'a mut [T]

fn from(color: &'a mut Hsl<S, T>) -> Self

Converts to this type from the input type.

impl<'a, S, T> From<&'a mut Hsl<S, T>> for &'a mut [T; 3]

fn from(color: &'a mut Hsl<S, T>) -> Self

Converts to this type from the input type.

impl<S, T, V, const N: usize> From<[Hsl<S, T>; N]> for Hsl<S, V>

where [T; N]: Default, V: FromScalarArray<N, Scalar = T>,

fn from(colors: [Hsl<S, T>; N]) -> Self

Converts to this type from the input type.

impl<S, T> From<[T; 3]> for Hsl<S, T>

fn from(array: [T; 3]) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<S, T> From<Box<[T; 3]>> for Box<Hsl<S, T>>

fn from(array: Box<[T; 3]>) -> Self

Converts to this type from the input type.

impl<S, T> From<Hsl<S, T>> for [T; 3]

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

Converts to this type from the input type.

impl<S, T> From<Hsl<S, T>> for (RgbHue<T>, T, T)

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

Converts to this type from the input type.

impl<S, T, V, const N: usize> From<Hsl<S, V>> for [Hsl<S, T>; N]

where Self: Default, V: IntoScalarArray<N, Scalar = T>,

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

Converts to this type from the input type.

impl<S, T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Hsl<S, T>

where _C: IntoColorUnclamped<Self>,

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: Real + Zero + One + IsValidDivisor + Arithmetics + PartialCmp + Clone, T::Mask: LazySelect<T>,

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 Hsv<S, T>: FromColorUnclamped<Hsl<S, T>> + IntoColorUnclamped<Self>,

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 T: Real + RealAngle + UnsignedAngle + Zero + One + Abs + Round + PartialCmp + Arithmetics + Clone, T::Mask: LazySelect<T> + BitOps + Clone,

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 S1: RgbStandard + 'static, S2: RgbStandard + 'static, S1::Space: RgbSpace<WhitePoint = <S2::Space as RgbSpace>::WhitePoint>, Rgb<S1, T>: FromColorUnclamped<Hsl<S1, T>>, Rgb<S2, T>: FromColorUnclamped<Rgb<S1, T>>, Self: FromColorUnclamped<Rgb<S2, T>>,

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 _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = Wp>, Wp: WhitePoint<T>, Lchuv<Wp, T>: FromColorUnclamped<Hsl<_S, T>> + IntoColorUnclamped<Self>,

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 _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = Wp>, Wp: WhitePoint<T>, Xyz<Wp, T>: FromColorUnclamped<Hsl<_S, T>> + IntoColorUnclamped<Self>,

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 _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = Wp>, Wp: WhitePoint<T>, Lab<Wp, T>: FromColorUnclamped<Hsl<_S, T>> + IntoColorUnclamped<Self>,

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 _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = Wp>, Wp: WhitePoint<T>, Luv<Wp, T>: FromColorUnclamped<Hsl<_S, T>> + IntoColorUnclamped<Self>,

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 _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = <S as LumaStandard>::WhitePoint>, S: LumaStandard, Xyz<<S as LumaStandard>::WhitePoint, T>: FromColorUnclamped<Hsl<_S, T>> + IntoColorUnclamped<Self>,

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 _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = Wp>, Wp: WhitePoint<T>, Xyz<Wp, T>: FromColorUnclamped<Hsl<_S, T>> + IntoColorUnclamped<Self>,

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

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

impl<T, _S> FromColorUnclamped<Hsl<_S, T>> for Okhsl<T>

where _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = D65>, D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Hsl<_S, T>> + IntoColorUnclamped<Self>,

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

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

impl<T, _S> FromColorUnclamped<Hsl<_S, T>> for Okhsv<T>

where _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = D65>, D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Hsl<_S, T>> + IntoColorUnclamped<Self>,

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

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

impl<T, _S> FromColorUnclamped<Hsl<_S, T>> for Okhwb<T>

where _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = D65>, D65: WhitePoint<T>, Okhsv<T>: FromColorUnclamped<Hsl<_S, T>> + IntoColorUnclamped<Self>,

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

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

impl<T, _S> FromColorUnclamped<Hsl<_S, T>> for Oklab<T>

where _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = D65>, D65: WhitePoint<T>, Rgb<_S, T>: FromColorUnclamped<Hsl<_S, T>> + IntoColorUnclamped<Self>,

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

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

impl<T, _S> FromColorUnclamped<Hsl<_S, T>> for Oklch<T>

where _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = D65>, D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Hsl<_S, T>> + IntoColorUnclamped<Self>,

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 _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = Wp>, Wp: WhitePoint<T>, Rgb<_S, T>: FromColorUnclamped<Hsl<_S, T>> + IntoColorUnclamped<Self>,

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 _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = Wp>, Wp: WhitePoint<T>, Xyz<Wp, T>: FromColorUnclamped<Hsl<_S, T>> + IntoColorUnclamped<Self>,

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 S: RgbStandard, Rgb<S, T>: FromColorUnclamped<Hsluv<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> + IntoColorUnclamped<Self>,

fn from_color_unclamped( color: Hsluv<<<S as RgbStandard>::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: Real + Zero + One + IsValidDivisor + Arithmetics + PartialCmp + Clone, T::Mask: LazySelect<T> + Not<Output = T::Mask>,

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 Hsv<S, T>: FromColorUnclamped<Hwb<S, T>> + IntoColorUnclamped<Self>,

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 S: RgbStandard, Rgb<S, T>: FromColorUnclamped<Lab<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> + IntoColorUnclamped<Self>,

fn from_color_unclamped( color: Lab<<<S as RgbStandard>::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 S: RgbStandard, Rgb<S, T>: FromColorUnclamped<Lch<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> + IntoColorUnclamped<Self>,

fn from_color_unclamped( color: Lch<<<S as RgbStandard>::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 S: RgbStandard, Rgb<S, T>: FromColorUnclamped<Lchuv<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> + IntoColorUnclamped<Self>,

fn from_color_unclamped( color: Lchuv<<<S as RgbStandard>::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 _S: LumaStandard<WhitePoint = <<S as RgbStandard>::Space as RgbSpace>::WhitePoint>, S: RgbStandard, Rgb<S, T>: FromColorUnclamped<Luma<_S, T>> + IntoColorUnclamped<Self>,

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 S: RgbStandard, Rgb<S, T>: FromColorUnclamped<Luv<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> + IntoColorUnclamped<Self>,

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

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

impl<S, T> FromColorUnclamped<Okhsl<T>> for Hsl<S, T>

where Rgb<S, T>: FromColorUnclamped<Okhsl<T>> + IntoColorUnclamped<Self>,

fn from_color_unclamped(color: Okhsl<T>) -> Self

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

impl<S, T> FromColorUnclamped<Okhsv<T>> for Hsl<S, T>

where Rgb<S, T>: FromColorUnclamped<Okhsv<T>> + IntoColorUnclamped<Self>,

fn from_color_unclamped(color: Okhsv<T>) -> Self

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

impl<S, T> FromColorUnclamped<Okhwb<T>> for Hsl<S, T>

where Rgb<S, T>: FromColorUnclamped<Okhwb<T>> + IntoColorUnclamped<Self>,

fn from_color_unclamped(color: Okhwb<T>) -> Self

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

impl<S, T> FromColorUnclamped<Oklab<T>> for Hsl<S, T>

where Rgb<S, T>: FromColorUnclamped<Oklab<T>> + IntoColorUnclamped<Self>,

fn from_color_unclamped(color: Oklab<T>) -> Self

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

impl<S, T> FromColorUnclamped<Oklch<T>> for Hsl<S, T>

where Rgb<S, T>: FromColorUnclamped<Oklch<T>> + IntoColorUnclamped<Self>,

fn from_color_unclamped(color: Oklch<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: RealAngle + Zero + One + MinMax + Arithmetics + PartialCmp + Clone, T::Mask: BoolMask + BitOps + LazySelect<T> + Clone + 'static,

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 S: RgbStandard, Rgb<S, T>: FromColorUnclamped<Xyz<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> + IntoColorUnclamped<Self>,

fn from_color_unclamped( color: Xyz<<<S as RgbStandard>::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 S: RgbStandard, Rgb<S, T>: FromColorUnclamped<Yxy<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> + IntoColorUnclamped<Self>,

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

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

impl<S, T, C> FromIterator<Hsl<S, T>> for Hsl<S, C>

where Self: Extend<Hsl<S, T>>, C: Default,

fn from_iter<I: IntoIterator<Item = Hsl<S, T>>>(iter: I) -> Self

Creates a value from an iterator.

impl<S, T> GetHue for Hsl<S, T>

where T: Clone,

type Hue = RgbHue<T>

The kind of hue unit this color space uses.

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

Calculate a hue if possible.

impl<S, T> HasBoolMask for Hsl<S, T>

where T: HasBoolMask,

type Mask = <T as HasBoolMask>::Mask

The mask type to use for selecting Self values.

impl<'a, 'b, S, T> IntoIterator for &'a Hsl<S, &'b [T]>

type Item = Hsl<S, &'a T>

The type of the elements being iterated over.

type IntoIter = Iter<Iter<'a, T>, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, 'b, S, T> IntoIterator for &'a Hsl<S, &'b mut [T]>

type Item = Hsl<S, &'a T>

The type of the elements being iterated over.

type IntoIter = Iter<Iter<'a, T>, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, S, T, const N: usize> IntoIterator for &'a Hsl<S, [T; N]>

type Item = Hsl<S, &'a T>

The type of the elements being iterated over.

type IntoIter = Iter<Iter<'a, T>, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, S, T> IntoIterator for &'a Hsl<S, Box<[T]>>

type Item = Hsl<S, &'a T>

The type of the elements being iterated over.

type IntoIter = Iter<Iter<'a, T>, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, S, T> IntoIterator for &'a Hsl<S, Vec<T>>

type Item = Hsl<S, &'a T>

The type of the elements being iterated over.

type IntoIter = Iter<Iter<'a, T>, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, 'b, S, T> IntoIterator for &'a mut Hsl<S, &'b mut [T]>

type Item = Hsl<S, &'a mut T>

The type of the elements being iterated over.

type IntoIter = Iter<IterMut<'a, T>, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, S, T, const N: usize> IntoIterator for &'a mut Hsl<S, [T; N]>

type Item = Hsl<S, &'a mut T>

The type of the elements being iterated over.

type IntoIter = Iter<IterMut<'a, T>, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, S, T> IntoIterator for &'a mut Hsl<S, Box<[T]>>

type Item = Hsl<S, &'a mut T>

The type of the elements being iterated over.

type IntoIter = Iter<IterMut<'a, T>, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, S, T> IntoIterator for &'a mut Hsl<S, Vec<T>>

type Item = Hsl<S, &'a mut T>

The type of the elements being iterated over.

type IntoIter = Iter<IterMut<'a, T>, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, S, T> IntoIterator for Hsl<S, &'a [T]>

type Item = Hsl<S, &'a T>

The type of the elements being iterated over.

type IntoIter = Iter<Iter<'a, T>, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, S, T> IntoIterator for Hsl<S, &'a mut [T]>

type Item = Hsl<S, &'a mut T>

The type of the elements being iterated over.

type IntoIter = Iter<IterMut<'a, T>, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<S, T, const N: usize> IntoIterator for Hsl<S, [T; N]>

type Item = Hsl<S, T>

The type of the elements being iterated over.

type IntoIter = Iter<IntoIter<T, N>, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<S, T> IntoIterator for Hsl<S, Vec<T>>

type Item = Hsl<S, T>

The type of the elements being iterated over.

type IntoIter = Iter<IntoIter<T>, S>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<S, T> IsWithinBounds for Hsl<S, T>

where T: PartialCmp + Stimulus, T::Mask: BitAnd<Output = T::Mask>,

fn is_within_bounds(&self) -> T::Mask

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

impl<S, T> Lighten for Hsl<S, T>

where T: Real + Zero + MinMax + Clamp + Arithmetics + PartialCmp + Clone + Stimulus, T::Mask: LazySelect<T>,

type Scalar = T

The type of the lighten modifier.

fn lighten(self, factor: T) -> Self

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

fn lighten_fixed(self, amount: T) -> Self

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

impl<S, T> LightenAssign for Hsl<S, T>

where T: Real + Zero + MinMax + ClampAssign + AddAssign + Arithmetics + PartialCmp + Clone + Stimulus, T::Mask: LazySelect<T>,

type Scalar = T

The type of the lighten modifier.

fn lighten_assign(&mut self, factor: T)

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

fn lighten_fixed_assign(&mut self, amount: T)

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

impl<S, T> Mix for Hsl<S, T>

where T: RealAngle + SignedAngle + Zero + One + Clamp + Arithmetics + Clone,

type Scalar = T

The type of the mixing factor.

fn mix(self, other: Self, factor: T) -> Self

Mix the color with an other color, by factor.

impl<S, T> MixAssign for Hsl<S, T>

where T: RealAngle + SignedAngle + Zero + One + Clamp + AddAssign + Arithmetics + Clone,

type Scalar = T

The type of the mixing factor.

fn mix_assign(&mut self, other: Self, factor: T)

Mix the color with an other color, by factor.

impl<S, T> PartialEq for Hsl<S, T>

where T: PartialEq, RgbHue<T>: PartialEq,

fn eq(&self, other: &Self) -> 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<S, T> RelativeContrast for Hsl<S, T>

where T: Real + Arithmetics + PartialCmp, T::Mask: LazySelect<T>, S: RgbStandard, Xyz<<S::Space as RgbSpace>::WhitePoint, T>: FromColor<Self>,

type Scalar = T

👎Deprecated since 0.7.2: replaced by palette::color_difference::Wcag21RelativeContrast

The type of the contrast ratio.

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

👎Deprecated since 0.7.2: replaced by palette::color_difference::Wcag21RelativeContrast

Calculate the contrast ratio between two colors.

fn has_min_contrast_text( self, other: Self, ) -> <Self::Scalar as HasBoolMask>::Mask

👎Deprecated since 0.7.2: replaced by palette::color_difference::Wcag21RelativeContrast

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, ) -> <Self::Scalar as HasBoolMask>::Mask

👎Deprecated since 0.7.2: replaced by palette::color_difference::Wcag21RelativeContrast

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, ) -> <Self::Scalar as HasBoolMask>::Mask

👎Deprecated since 0.7.2: replaced by palette::color_difference::Wcag21RelativeContrast

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, ) -> <Self::Scalar as HasBoolMask>::Mask

👎Deprecated since 0.7.2: replaced by palette::color_difference::Wcag21RelativeContrast

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, ) -> <Self::Scalar as HasBoolMask>::Mask

👎Deprecated since 0.7.2: replaced by palette::color_difference::Wcag21RelativeContrast

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 for Hsl<S, T>

where T: RelativeEq, T::Epsilon: Clone, RgbHue<T>: RelativeEq + AbsDiffEq<Epsilon = T::Epsilon>,

fn default_max_relative() -> T::Epsilon

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

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

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

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

The inverse of RelativeEq::relative_eq.

impl<S, T> Saturate for Hsl<S, T>

where T: Real + Zero + MinMax + Clamp + Arithmetics + PartialCmp + Clone + Stimulus, T::Mask: LazySelect<T>,

type Scalar = T

The type of the saturation modifier.

fn saturate(self, factor: T) -> Self

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

fn saturate_fixed(self, amount: T) -> Self

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

impl<S, T> SaturateAssign for Hsl<S, T>

where T: Real + Zero + MinMax + ClampAssign + AddAssign + Arithmetics + PartialCmp + Clone + Stimulus, T::Mask: LazySelect<T>,

type Scalar = T

The type of the saturation modifier.

fn saturate_assign(&mut self, factor: T)

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

fn saturate_fixed_assign(&mut self, amount: T)

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

impl<S, T> SaturatingAdd<T> for Hsl<S, T>

where T: SaturatingAdd<Output = T> + Clone,

type Output = Hsl<S, T>

The resulting type.

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

Returns the sum of self and other, but saturates instead of overflowing.

impl<S, T> SaturatingAdd for Hsl<S, T>

where T: SaturatingAdd<Output = T>,

type Output = Hsl<S, T>

The resulting type.

fn saturating_add(self, other: Self) -> Self::Output

Returns the sum of self and other, but saturates instead of overflowing.

impl<S, T> SaturatingSub<T> for Hsl<S, T>

where T: SaturatingSub<Output = T> + Clone,

type Output = Hsl<S, T>

The resulting type.

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

Returns the difference of self and other, but saturates instead of overflowing.

impl<S, T> SaturatingSub for Hsl<S, T>

where T: SaturatingSub<Output = T>,

type Output = Hsl<S, T>

The resulting type.

fn saturating_sub(self, other: Self) -> Self::Output

Returns the difference of self and other, but saturates instead of overflowing.

impl<S, T> Serialize for Hsl<S, T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<S, T, H> SetHue<H> for Hsl<S, T>

where H: Into<RgbHue<T>>,

fn set_hue(&mut self, hue: H)

Change the hue to a specific value.

impl<S, T> ShiftHue for Hsl<S, T>

where T: Add<Output = T>,

type Scalar = T

The type of the hue modifier.

fn shift_hue(self, amount: Self::Scalar) -> Self

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

impl<S, T> ShiftHueAssign for Hsl<S, T>

where T: AddAssign,

type Scalar = T

The type of the hue modifier.

fn shift_hue_assign(&mut self, amount: Self::Scalar)

Shifts the hue by amount.

impl<S, T> Sub<T> for Hsl<S, T>

where T: Sub<Output = T> + Clone,

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> Sub for Hsl<S, T>

where T: Sub<Output = T>,

type Output = Hsl<S, T>

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl<S, T> SubAssign<T> for Hsl<S, T>

where T: SubAssign + Clone,

fn sub_assign(&mut self, c: T)

Performs the -= operation.

impl<S, T> SubAssign for Hsl<S, T>

where T: SubAssign,

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<'a, S, T> TryFrom<&'a [T]> for &'a Hsl<S, T>

type Error = <&'a [T; 3] as TryFrom<&'a [T]>>::Error

The type returned in the event of a conversion error.

fn try_from(slice: &'a [T]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, S, T> TryFrom<&'a mut [T]> for &'a mut Hsl<S, T>

type Error = <&'a mut [T; 3] as TryFrom<&'a mut [T]>>::Error

The type returned in the event of a conversion error.

fn try_from(slice: &'a mut [T]) -> Result<Self, Self::Error>

Performs the conversion.

impl<S, T> UlpsEq for Hsl<S, T>

where T: UlpsEq, T::Epsilon: Clone, RgbHue<T>: UlpsEq + AbsDiffEq<Epsilon = T::Epsilon>,

fn default_max_ulps() -> u32

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

fn ulps_eq(&self, other: &Self, epsilon: T::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: &Self, epsilon: T::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl<S, T, _A> WithAlpha<_A> for Hsl<S, T>

where _A: Stimulus,

type Color = Hsl<S, T>

The opaque color type, without any transparency.

type WithAlpha = Alpha<Hsl<S, T>, _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

where A: Stimulus,

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

where A: Zero,

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

impl<S, T, H> WithHue<H> for Hsl<S, T>

where H: Into<RgbHue<T>>,

fn with_hue(self, hue: H) -> Self

Return a copy of self with a specific hue.

impl<S, T> Copy for Hsl<S, T>

where T: Copy,

impl<S, T> Eq for Hsl<S, T>

where T: Eq, RgbHue<T>: Eq,