Struct Okhsl

#[repr(C)]
pub struct Okhsl<T = f32> {
    pub hue: OklabHue<T>,
    pub saturation: T,
    pub lightness: T,
}

A Hue/Saturation/Lightness representation of Oklab in the sRGB color space.

Allows

• changing hue/chroma/saturation, while keeping perceived lightness constant (like HSLuv)
• changing lightness/chroma/saturation, while keeping perceived hue constant
• changing the perceived saturation (more or less) proportionally with the numerical amount of change (unlike HSLuv)

Fields

hue: OklabHue<T>

The hue of the color, in degrees of a circle.

For fully saturated, bright colors

• 0° corresponds to a kind of magenta-pink (RBG #ff0188),
• 90° to a kind of yellow (RBG RGB #ffcb00)
• 180° to a kind of cyan (RBG #00ffe1) and
• 240° to a kind of blue (RBG #00aefe).

For s == 0 or v == 0, the hue is irrelevant.

saturation: T

The saturation (freedom of black or white) of the color.

• 0.0 corresponds to pure mixture of black and white without any color. The black to white relation depends on v.
• 1.0 to a fully saturated color without any white.

For v == 0 the saturation is irrelevant.

lightness: T

The relative luminance of the color, where

• 0.0 corresponds to pure black
• 1.0 corresponds to white

This luminance is visually similar to Cielab’s luminance for a D65 reference white point.

Okhsv’s value component goes from black to non-black – a maximally bright color in the sRGB gamut.

Okhsl’s lightness component goes from black to white in the sRGB color space.

Implementations

impl<T> Okhsl<T>

pub fn new<H>(hue: H, saturation: T, lightness: T) -> Okhsl<T>

where H: Into<OklabHue<T>>,

Create an Okhsl color.

pub const fn new_const( hue: OklabHue<T>, saturation: T, lightness: T, ) -> Okhsl<T>

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

pub fn into_format<U>(self) -> Okhsl<U>

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

Convert into another component type.

pub fn from_format<U>(color: Okhsl<U>) -> Okhsl<T>

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

Convert from another component type.

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

Convert to a (h, s, l) tuple.

pub fn from_components<H>(_: (H, T, T)) -> Okhsl<T>

where H: Into<OklabHue<T>>,

Convert from a (h, s, l) tuple.

impl<T> Okhsl<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<T> Okhsl<&T>

pub fn copied(&self) -> Okhsl<T>

where T: Copy,

Get an owned, copied version of this color.

pub fn cloned(&self) -> Okhsl<T>

where T: Clone,

Get an owned, cloned version of this color.

impl<T> Okhsl<&mut T>

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

Update this color with new values.

pub fn as_refs(&self) -> Okhsl<&T>

Borrow this color’s components as shared references.

pub fn copied(&self) -> Okhsl<T>

where T: Copy,

Get an owned, copied version of this color.

pub fn cloned(&self) -> Okhsl<T>

where T: Clone,

Get an owned, cloned version of this color.

impl<C> Okhsl<C>

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

where &'a Okhsl<C>: IntoIterator,

Return an iterator over the colors in the wrapped collections.

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

where &'a mut Okhsl<C>: IntoIterator,

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

pub fn get<'a, I, T>( &'a self, index: I, ) -> Option<Okhsl<&'a <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<Okhsl<&'a 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<T> Okhsl<Vec<T>>

pub fn with_capacity(capacity: usize) -> Okhsl<Vec<T>>

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

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

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

pub fn pop(&mut self) -> Option<Okhsl<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>>

where R: RangeBounds<usize> + Clone,

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

Trait Implementations

impl<T> AbsDiffEq for Okhsl<T>

where T: AbsDiffEq, <T as AbsDiffEq>::Epsilon: Clone, OklabHue<T>: AbsDiffEq<Epsilon = <T as AbsDiffEq>::Epsilon>,

type Epsilon = <T as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> <Okhsl<T> as AbsDiffEq>::Epsilon

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

fn abs_diff_eq( &self, other: &Okhsl<T>, epsilon: <T as AbsDiffEq>::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: &Okhsl<T>, epsilon: <T as AbsDiffEq>::Epsilon, ) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<T> Add<T> for Okhsl<T>

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

type Output = Okhsl<T>

The resulting type after applying the + operator.

fn add(self, c: T) -> <Okhsl<T> as Add<T>>::Output

Performs the + operation.

impl<T> Add for Okhsl<T>

where T: Add<Output = T>,

type Output = Okhsl<T>

The resulting type after applying the + operator.

fn add(self, other: Okhsl<T>) -> <Okhsl<T> as Add>::Output

Performs the + operation.

impl<T> AddAssign<T> for Okhsl<T>

where T: AddAssign + Clone,

fn add_assign(&mut self, c: T)

Performs the += operation.

impl<T> AddAssign for Okhsl<T>

where T: AddAssign,

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

Performs the += operation.

impl<T> ArrayCast for Okhsl<T>

type Array = [T; 3]

The output type of a cast to an array.

impl<T> AsMut<[T]> for Okhsl<T>

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

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

impl<T> AsMut<[T; 3]> for Okhsl<T>

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

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

impl<T> AsRef<[T]> for Okhsl<T>

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

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

impl<T> AsRef<[T; 3]> for Okhsl<T>

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

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

impl<T> Clamp for Okhsl<T>

where T: Clamp + Stimulus,

fn clamp(self) -> Okhsl<T>

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

impl<T> ClampAssign for Okhsl<T>

where T: ClampAssign + Stimulus,

fn clamp_assign(&mut self)

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

impl<T> Clone for Okhsl<T>

where T: Clone,

fn clone(&self) -> Okhsl<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Okhsl<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Okhsl<T>

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

fn default() -> Okhsl<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Okhsl<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, C> Extend<Okhsl<T>> for Okhsl<C>

where C: Extend<T>,

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = Okhsl<T>>,

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, T> From<&'a [T; 3]> for &'a Okhsl<T>

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

Converts to this type from the input type.

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

fn from(color: &'a Okhsl<T>) -> &'a [T]

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn from(color: &'a mut Okhsl<T>) -> &'a mut [T]

Converts to this type from the input type.

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

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

fn from(colors: [Okhsl<T>; N]) -> Okhsl<V>

Converts to this type from the input type.

impl<T> From<[T; 3]> for Okhsl<T>

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

Converts to this type from the input type.

impl<T> From<Box<[T; 3]>> for Box<Okhsl<T>>

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

Converts to this type from the input type.

impl<T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Okhsl<T>

where _C: IntoColorUnclamped<Okhsl<T>>,

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

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 as RgbStandard>::Space: RgbSpace<WhitePoint = D65>, D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Hsl<_S, T>> + IntoColorUnclamped<Okhsl<T>>,

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

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

impl<T> FromColorUnclamped<Hsluv<D65, T>> for Okhsl<T>

where D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Hsluv<D65, T>> + IntoColorUnclamped<Okhsl<T>>,

fn from_color_unclamped(color: Hsluv<D65, T>) -> Okhsl<T>

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

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

where _S: RgbStandard, <_S as RgbStandard>::Space: RgbSpace<WhitePoint = D65>, D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Hsv<_S, T>> + IntoColorUnclamped<Okhsl<T>>,

fn from_color_unclamped(color: Hsv<_S, T>) -> Okhsl<T>

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

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

where _S: RgbStandard, <_S as RgbStandard>::Space: RgbSpace<WhitePoint = D65>, D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Hwb<_S, T>> + IntoColorUnclamped<Okhsl<T>>,

fn from_color_unclamped(color: Hwb<_S, T>) -> Okhsl<T>

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

impl<T> FromColorUnclamped<Lab<D65, T>> for Okhsl<T>

where D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Lab<D65, T>> + IntoColorUnclamped<Okhsl<T>>,

fn from_color_unclamped(color: Lab<D65, T>) -> Okhsl<T>

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

impl<T> FromColorUnclamped<Lch<D65, T>> for Okhsl<T>

where D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Lch<D65, T>> + IntoColorUnclamped<Okhsl<T>>,

fn from_color_unclamped(color: Lch<D65, T>) -> Okhsl<T>

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

impl<T> FromColorUnclamped<Lchuv<D65, T>> for Okhsl<T>

where D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Lchuv<D65, T>> + IntoColorUnclamped<Okhsl<T>>,

fn from_color_unclamped(color: Lchuv<D65, T>) -> Okhsl<T>

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

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

where _S: LumaStandard<WhitePoint = D65>, D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Luma<_S, T>> + IntoColorUnclamped<Okhsl<T>>,

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

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

impl<T> FromColorUnclamped<Luv<D65, T>> for Okhsl<T>

where D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Luv<D65, T>> + IntoColorUnclamped<Okhsl<T>>,

fn from_color_unclamped(color: Luv<D65, T>) -> Okhsl<T>

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

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

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

impl<Wp, T> FromColorUnclamped<Okhsl<T>> for Hsluv<Wp, T>

where Wp: WhitePoint<T>, Lchuv<Wp, T>: FromColorUnclamped<Okhsl<T>> + IntoColorUnclamped<Hsluv<Wp, T>>,

fn from_color_unclamped(color: Okhsl<T>) -> Hsluv<Wp, T>

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

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

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

fn from_color_unclamped(color: Okhsl<T>) -> Hsv<S, T>

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

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

where Hsv<S, T>: FromColorUnclamped<Okhsl<T>> + IntoColorUnclamped<Hwb<S, T>>,

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

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

impl<Wp, T> FromColorUnclamped<Okhsl<T>> for Lab<Wp, T>

where Wp: WhitePoint<T>, Xyz<Wp, T>: FromColorUnclamped<Okhsl<T>> + IntoColorUnclamped<Lab<Wp, T>>,

fn from_color_unclamped(color: Okhsl<T>) -> Lab<Wp, T>

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

impl<Wp, T> FromColorUnclamped<Okhsl<T>> for Lch<Wp, T>

where Wp: WhitePoint<T>, Lab<Wp, T>: FromColorUnclamped<Okhsl<T>> + IntoColorUnclamped<Lch<Wp, T>>,

fn from_color_unclamped(color: Okhsl<T>) -> Lch<Wp, T>

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

impl<Wp, T> FromColorUnclamped<Okhsl<T>> for Lchuv<Wp, T>

where Wp: WhitePoint<T>, Luv<Wp, T>: FromColorUnclamped<Okhsl<T>> + IntoColorUnclamped<Lchuv<Wp, T>>,

fn from_color_unclamped(color: Okhsl<T>) -> Lchuv<Wp, T>

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

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

where S: LumaStandard, Xyz<<S as LumaStandard>::WhitePoint, T>: FromColorUnclamped<Okhsl<T>> + IntoColorUnclamped<Luma<S, T>>,

fn from_color_unclamped(color: Okhsl<T>) -> Luma<S, T>

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

impl<Wp, T> FromColorUnclamped<Okhsl<T>> for Luv<Wp, T>

where Wp: WhitePoint<T>, Xyz<Wp, T>: FromColorUnclamped<Okhsl<T>> + IntoColorUnclamped<Luv<Wp, T>>,

fn from_color_unclamped(color: Okhsl<T>) -> Luv<Wp, T>

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

impl<T> FromColorUnclamped<Okhsl<T>> for Okhsl<T>

where Oklab<T>: FromColorUnclamped<Okhsl<T>> + IntoColorUnclamped<Okhsl<T>>,

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

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

impl<T> FromColorUnclamped<Okhsl<T>> for Okhsv<T>

where Oklab<T>: FromColorUnclamped<Okhsl<T>> + IntoColorUnclamped<Okhsv<T>>,

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

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

impl<T> FromColorUnclamped<Okhsl<T>> for Okhwb<T>

where Okhsv<T>: FromColorUnclamped<Okhsl<T>> + IntoColorUnclamped<Okhwb<T>>,

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

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

impl<T> FromColorUnclamped<Okhsl<T>> for Oklab<T>

where T: RealAngle + One + Zero + Arithmetics + Sqrt + MinMax + PartialOrd + HasBoolMask<Mask = bool> + Powi + Cbrt + Trigonometry + Clone, Oklab<T>: IntoColorUnclamped<Rgb<Linear<Srgb>, T>>,

See

See okhsl_to_srgb

fn from_color_unclamped(hsl: Okhsl<T>) -> Oklab<T>

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

impl<T> FromColorUnclamped<Okhsl<T>> for Oklch<T>

where Oklab<T>: FromColorUnclamped<Okhsl<T>> + IntoColorUnclamped<Oklch<T>>,

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

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

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

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

fn from_color_unclamped(color: Okhsl<T>) -> Rgb<S, T>

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

impl<Wp, T> FromColorUnclamped<Okhsl<T>> for Xyz<Wp, T>

where Oklab<T>: FromColorUnclamped<Okhsl<T>> + IntoColorUnclamped<Xyz<Wp, T>>,

fn from_color_unclamped(color: Okhsl<T>) -> Xyz<Wp, T>

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

impl<Wp, T> FromColorUnclamped<Okhsl<T>> for Yxy<Wp, T>

where Wp: WhitePoint<T>, Xyz<Wp, T>: FromColorUnclamped<Okhsl<T>> + IntoColorUnclamped<Yxy<Wp, T>>,

fn from_color_unclamped(color: Okhsl<T>) -> Yxy<Wp, T>

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

impl<T> FromColorUnclamped<Okhsv<T>> for Okhsl<T>

where Oklab<T>: FromColorUnclamped<Okhsv<T>> + IntoColorUnclamped<Okhsl<T>>,

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

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

impl<T> FromColorUnclamped<Okhwb<T>> for Okhsl<T>

where Oklab<T>: FromColorUnclamped<Okhwb<T>> + IntoColorUnclamped<Okhsl<T>>,

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

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

impl<T> FromColorUnclamped<Oklab<T>> for Okhsl<T>

where T: Zero + Arithmetics + Powi + Sqrt + Hypot + MinMax + Cbrt + IsValidDivisor<Mask = bool, Mask = bool> + HasBoolMask + Real + PartialOrd + Clone + One, Oklab<T>: GetHue<Hue = OklabHue<T>> + IntoColorUnclamped<Rgb<Linear<Srgb>, T>>,

See

See srgb_to_okhsl

fn from_color_unclamped(lab: Oklab<T>) -> Okhsl<T>

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

impl<T> FromColorUnclamped<Oklch<T>> for Okhsl<T>

where Oklab<T>: FromColorUnclamped<Oklch<T>> + IntoColorUnclamped<Okhsl<T>>,

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

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

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

where _S: RgbStandard, <_S as RgbStandard>::Space: RgbSpace<WhitePoint = D65>, D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Rgb<_S, T>> + IntoColorUnclamped<Okhsl<T>>,

fn from_color_unclamped(color: Rgb<_S, T>) -> Okhsl<T>

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

impl<T> FromColorUnclamped<Xyz<D65, T>> for Okhsl<T>

where D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Xyz<D65, T>> + IntoColorUnclamped<Okhsl<T>>,

fn from_color_unclamped(color: Xyz<D65, T>) -> Okhsl<T>

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

impl<T> FromColorUnclamped<Yxy<D65, T>> for Okhsl<T>

where D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Yxy<D65, T>> + IntoColorUnclamped<Okhsl<T>>,

fn from_color_unclamped(color: Yxy<D65, T>) -> Okhsl<T>

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

impl<T, C> FromIterator<Okhsl<T>> for Okhsl<C>

where Okhsl<C>: Extend<Okhsl<T>>, C: Default,

fn from_iter<I>(iter: I) -> Okhsl<C>

where I: IntoIterator<Item = Okhsl<T>>,

Creates a value from an iterator.

impl<T> GetHue for Okhsl<T>

where T: Clone,

type Hue = OklabHue<T>

The kind of hue unit this color space uses.

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

Calculate a hue if possible.

impl<T> HasBoolMask for Okhsl<T>

where T: HasBoolMask,

type Mask = <T as HasBoolMask>::Mask

The mask type to use for selecting Self values.

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

type Item = Okhsl<&'a T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a Okhsl<&'b [T]> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Okhsl<&'a T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a Okhsl<&'b mut [T]> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Okhsl<&'a T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a Okhsl<[T; N]> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Okhsl<&'a T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a Okhsl<Box<[T]>> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a Okhsl<Vec<T>>

type Item = Okhsl<&'a T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a Okhsl<Vec<T>> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Okhsl<&'a mut T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a mut Okhsl<&'b mut [T]> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Okhsl<&'a mut T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a mut Okhsl<[T; N]> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Okhsl<&'a mut T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a mut Okhsl<Box<[T]>> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Okhsl<&'a mut T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a mut Okhsl<Vec<T>> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Okhsl<&'a T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Okhsl<&'a [T]> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Okhsl<&'a mut T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Okhsl<&'a mut [T]> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Okhsl<T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Okhsl<[T; N]> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for Okhsl<Vec<T>>

type Item = Okhsl<T>

The type of the elements being iterated over.

type IntoIter = Iter<IntoIter<T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Okhsl<Vec<T>> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> IsWithinBounds for Okhsl<T>

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

fn is_within_bounds(&self) -> <T as HasBoolMask>::Mask

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

impl<T> Lighten for Okhsl<T>

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

type Scalar = T

The type of the lighten modifier.

fn lighten(self, factor: T) -> Okhsl<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) -> Okhsl<T>

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

impl<T> LightenAssign for Okhsl<T>

where T: Real + Zero + MinMax + ClampAssign + AddAssign + Arithmetics + PartialCmp + Clone + Stimulus, <T as HasBoolMask>::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<T> Mix for Okhsl<T>

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

type Scalar = T

The type of the mixing factor.

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

Mix the color with an other color, by factor.

impl<T> MixAssign for Okhsl<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: Okhsl<T>, factor: T)

Mix the color with an other color, by factor.

impl<T> PartialEq for Okhsl<T>

where T: PartialEq, OklabHue<T>: PartialEq,

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

where T: Real + Arithmetics + PartialCmp, <T as HasBoolMask>::Mask: LazySelect<T>, Xyz<D65, T>: FromColor<Okhsl<T>>,

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: Okhsl<T>) -> 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<T> RelativeEq for Okhsl<T>

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

fn default_max_relative() -> <T as AbsDiffEq>::Epsilon

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

fn relative_eq( &self, other: &Okhsl<T>, epsilon: <T as AbsDiffEq>::Epsilon, max_relative: <T as AbsDiffEq>::Epsilon, ) -> bool

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

fn relative_ne( &self, other: &Okhsl<T>, epsilon: <T as AbsDiffEq>::Epsilon, max_relative: <T as AbsDiffEq>::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.

impl<T> Saturate for Okhsl<T>

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

type Scalar = T

The type of the saturation modifier.

fn saturate(self, factor: T) -> Okhsl<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) -> Okhsl<T>

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

impl<T> SaturateAssign for Okhsl<T>

where T: Real + Zero + MinMax + ClampAssign + AddAssign + Arithmetics + PartialCmp + Clone + Stimulus, <T as HasBoolMask>::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<T> SaturatingAdd<T> for Okhsl<T>

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

type Output = Okhsl<T>

The resulting type.

fn saturating_add(self, c: T) -> <Okhsl<T> as SaturatingAdd<T>>::Output

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

impl<T> SaturatingAdd for Okhsl<T>

where T: SaturatingAdd<Output = T>,

type Output = Okhsl<T>

The resulting type.

fn saturating_add(self, other: Okhsl<T>) -> <Okhsl<T> as SaturatingAdd>::Output

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

impl<T> SaturatingSub<T> for Okhsl<T>

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

type Output = Okhsl<T>

The resulting type.

fn saturating_sub(self, c: T) -> <Okhsl<T> as SaturatingSub<T>>::Output

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

impl<T> SaturatingSub for Okhsl<T>

where T: SaturatingSub<Output = T>,

type Output = Okhsl<T>

The resulting type.

fn saturating_sub(self, other: Okhsl<T>) -> <Okhsl<T> as SaturatingSub>::Output

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

impl<T> Serialize for Okhsl<T>

where T: Serialize,

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<T, H> SetHue<H> for Okhsl<T>

where H: Into<OklabHue<T>>,

fn set_hue(&mut self, hue: H)

Change the hue to a specific value.

impl<T> ShiftHue for Okhsl<T>

where T: Add<Output = T>,

type Scalar = T

The type of the hue modifier.

fn shift_hue(self, amount: <Okhsl<T> as ShiftHue>::Scalar) -> Okhsl<T>

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

impl<T> ShiftHueAssign for Okhsl<T>

where T: AddAssign,

type Scalar = T

The type of the hue modifier.

fn shift_hue_assign(&mut self, amount: <Okhsl<T> as ShiftHueAssign>::Scalar)

Shifts the hue by amount.

impl<T> Sub<T> for Okhsl<T>

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

type Output = Okhsl<T>

The resulting type after applying the - operator.

fn sub(self, c: T) -> <Okhsl<T> as Sub<T>>::Output

Performs the - operation.

impl<T> Sub for Okhsl<T>

where T: Sub<Output = T>,

type Output = Okhsl<T>

The resulting type after applying the - operator.

fn sub(self, other: Okhsl<T>) -> <Okhsl<T> as Sub>::Output

Performs the - operation.

impl<T> SubAssign<T> for Okhsl<T>

where T: SubAssign + Clone,

fn sub_assign(&mut self, c: T)

Performs the -= operation.

impl<T> SubAssign for Okhsl<T>

where T: SubAssign,

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

Performs the -= operation.

impl<'a, T> TryFrom<&'a [T]> for &'a Okhsl<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<&'a Okhsl<T>, <&'a Okhsl<T> as TryFrom<&'a [T]>>::Error>

Performs the conversion.

impl<'a, T> TryFrom<&'a mut [T]> for &'a mut Okhsl<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<&'a mut Okhsl<T>, <&'a mut Okhsl<T> as TryFrom<&'a mut [T]>>::Error>

Performs the conversion.

impl<T> UlpsEq for Okhsl<T>

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

fn default_max_ulps() -> u32

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

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

The inverse of UlpsEq::ulps_eq.

impl<T, _A> WithAlpha<_A> for Okhsl<T>

where _A: Stimulus,

type Color = Okhsl<T>

The opaque color type, without any transparency.

type WithAlpha = Alpha<Okhsl<T>, _A>

The color type with transparency applied.

fn with_alpha(self, alpha: _A) -> <Okhsl<T> as WithAlpha<_A>>::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) -> <Okhsl<T> as WithAlpha<_A>>::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) -> (<Okhsl<T> as WithAlpha<_A>>::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<T, H> WithHue<H> for Okhsl<T>

where H: Into<OklabHue<T>>,

fn with_hue(self, hue: H) -> Okhsl<T>

Return a copy of self with a specific hue.

impl<T> Copy for Okhsl<T>

where T: Copy,

impl<T> Eq for Okhsl<T>

where T: Eq, OklabHue<T>: Eq,