Struct palette::Oklch

#[repr(C)]
pub struct Oklch<T = f32> where
    T: FloatComponent,  {
    pub l: T,
    pub chroma: T,
    pub hue: OklabHue<T>,
}

Oklch, a polar version of Oklab.

It is Oklab’s equivalent of CIE L*C*h°.

It’s a cylindrical color space, like HSL and HSV. This gives it the same ability to directly change the hue and colorfulness of a color, while preserving other visual aspects.

It assumes a D65 whitepoint and normal well-lit viewing conditions, like Oklab.

Fields

l: T

L is the lightness of the color. 0 gives absolute black and 1 gives the brightest white.

chroma: T

C is the colorfulness of the color, from greyscale at 0 to the most colorful at 1.

hue: OklabHue<T>

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

Implementations

impl<T> Oklch<T> where
    T: FloatComponent, 

pub fn new<H: Into<OklabHue<T>>>(l: T, chroma: T, hue: H) -> Oklch<T>

Create an Oklch color.

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

Convert to a (L, C, h) tuple.

pub fn from_components<H: Into<OklabHue<T>>>(
    (l, chroma, hue): (T, T, H)
) -> Self

Convert from a (L, C, h) tuple.

pub fn min_l() -> T

Return the l value minimum.

pub fn max_l() -> T

Return the l value maximum.

pub fn min_chroma() -> T

Return the chroma value minimum.

pub fn max_chroma() -> T

Return the chroma value maximum.

Trait Implementations

impl<T> AbsDiffEq<Oklch<T>> for Oklch<T> where
    T: FloatComponent + AbsDiffEq,
    T::Epsilon: Copy + FloatComponent, 

type Epsilon = <T as AbsDiffEq<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 AbsDiffEq::abs_diff_eq.

impl<T> Add<Oklch<T>> for Oklch<T> where
    T: FloatComponent, 

type Output = Oklch<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> Add<T> for Oklch<T> where
    T: FloatComponent, 

type Output = Oklch<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> AddAssign<Oklch<T>> for Oklch<T> where
    T: FloatComponent + AddAssign, 

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

Performs the += operation.

impl<T> AddAssign<T> for Oklch<T> where
    T: FloatComponent + AddAssign, 

fn add_assign(&mut self, c: T)

Performs the += operation.

impl<T, P> AsMut<P> for Oklch<T> where
    T: FloatComponent,
    P: RawPixel<T> + ?Sized, 

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

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

impl<T, P> AsRef<P> for Oklch<T> where
    T: FloatComponent,
    P: RawPixel<T> + ?Sized, 

fn as_ref(&self) -> &P

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

impl<T> Clamp for Oklch<T> where
    T: FloatComponent, 

fn is_within_bounds(&self) -> bool

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

fn clamp(&self) -> Oklch<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<T> Clone for Oklch<T> where
    T: FloatComponent, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Oklch<T> where
    T: FloatComponent, 

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

Formats the value using the given formatter.

impl<T> Default for Oklch<T> where
    T: FloatComponent, 

fn default() -> Oklch<T>

Returns the “default value” for a type.

impl<T: FloatComponent, H: Into<OklabHue<T>>> From<(T, T, H)> for Oklch<T>

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

Converts to this type from the input type.

impl<T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Oklch<T> where
    T: FloatComponent,
    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<T, _S> FromColorUnclamped<Hsl<_S, T>> for Oklch<T> where
    T: FloatComponent,
    T: FloatComponent,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = D65>, 

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

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

impl<T> FromColorUnclamped<Hsluv<D65, T>> for Oklch<T> where
    T: FloatComponent,
    T: FloatComponent,
    T: FloatComponent, 

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

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

impl<T, _S> FromColorUnclamped<Hsv<_S, T>> for Oklch<T> where
    T: FloatComponent,
    T: FloatComponent,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = D65>, 

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

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

impl<T, _S> FromColorUnclamped<Hwb<_S, T>> for Oklch<T> where
    T: FloatComponent,
    T: FloatComponent,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = D65>, 

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

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

impl<T> FromColorUnclamped<Lab<D65, T>> for Oklch<T> where
    T: FloatComponent,
    T: FloatComponent,
    T: FloatComponent, 

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

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

impl<T> FromColorUnclamped<Lch<D65, T>> for Oklch<T> where
    T: FloatComponent,
    T: FloatComponent,
    T: FloatComponent, 

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

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

impl<T> FromColorUnclamped<Lchuv<D65, T>> for Oklch<T> where
    T: FloatComponent,
    T: FloatComponent,
    T: FloatComponent, 

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

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

impl<T, _S> FromColorUnclamped<Luma<_S, T>> for Oklch<T> where
    T: FloatComponent,
    T: FloatComponent,
    T: FloatComponent,
    _S: LumaStandard<WhitePoint = D65>, 

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

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

impl<T> FromColorUnclamped<Luv<D65, T>> for Oklch<T> where
    T: FloatComponent,
    T: FloatComponent,
    T: FloatComponent, 

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

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

impl<T> FromColorUnclamped<Oklab<T>> for Oklch<T> where
    T: FloatComponent, 

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
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent,
    Rgb<S, T>: FromColorUnclamped<Oklch<T>>, 

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

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

impl<Wp, T> FromColorUnclamped<Oklch<T>> for Hsluv<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Lchuv<Wp, T>: FromColorUnclamped<Oklch<T>>, 

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

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

impl<T> FromColorUnclamped<Oklch<T>> for Oklch<T> where
    T: FloatComponent, 

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

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

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

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

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

impl<T> FromColorUnclamped<Oklch<T>> for Xyz<D65, T> where
    T: FloatComponent, 

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

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

impl<Wp, T> FromColorUnclamped<Oklch<T>> for Yxy<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Xyz<Wp, T>: FromColorUnclamped<Oklch<T>>, 

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<Oklch<T>> for Hsv<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent,
    Rgb<S, T>: FromColorUnclamped<Oklch<T>>, 

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<Oklch<T>> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent,
    Hsv<S, T>: FromColorUnclamped<Oklch<T>>, 

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

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

impl<Wp, T> FromColorUnclamped<Oklch<T>> for Lab<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Xyz<Wp, T>: FromColorUnclamped<Oklch<T>>, 

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

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

impl<Wp, T> FromColorUnclamped<Oklch<T>> for Lch<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Xyz<Wp, T>: FromColorUnclamped<Oklch<T>>, 

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

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

impl<Wp, T> FromColorUnclamped<Oklch<T>> for Lchuv<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Luv<Wp, T>: FromColorUnclamped<Oklch<T>>, 

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<Oklch<T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: FloatComponent,
    T: FloatComponent,
    Xyz<S::WhitePoint, T>: FromColorUnclamped<Oklch<T>>, 

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

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

impl<Wp, T> FromColorUnclamped<Oklch<T>> for Luv<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Xyz<Wp, T>: FromColorUnclamped<Oklch<T>>, 

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

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

impl<T> FromColorUnclamped<Oklch<T>> for Oklab<T> where
    T: FloatComponent, 

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

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

impl<T, _S> FromColorUnclamped<Rgb<_S, T>> for Oklch<T> where
    T: FloatComponent,
    T: FloatComponent,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = D65>, 

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

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

impl<T> FromColorUnclamped<Xyz<D65, T>> for Oklch<T> where
    T: FloatComponent, 

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

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

impl<T> FromColorUnclamped<Yxy<D65, T>> for Oklch<T> where
    T: FloatComponent,
    T: FloatComponent,
    T: FloatComponent, 

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

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

impl<T> GetHue for Oklch<T> where
    T: FloatComponent, 

type Hue = OklabHue<T>

The kind of hue unit this color space uses.

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

Calculate a hue if possible.

impl<T> Hue for Oklch<T> where
    T: FloatComponent, 

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

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

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

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

impl<T: FloatComponent> Into<(T, T, OklabHue<T>)> for Oklch<T>

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

Converts this type into the (usually inferred) input type.

impl<T> Mix for Oklch<T> where
    T: FloatComponent, 

type Scalar = T

The type of the mixing factor.

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

Mix the color with an other color, by factor.

impl<T: PartialEq> PartialEq<Oklch<T>> for Oklch<T> where
    T: FloatComponent, 

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

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

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

This method tests for !=.

impl<T> Pixel<T> for Oklch<T> where
    T: FloatComponent, 

const CHANNELS: usize = 3usize

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<T> RelativeContrast for Oklch<T> where
    T: FloatComponent, 

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<T> RelativeEq<Oklch<T>> for Oklch<T> where
    T: FloatComponent + RelativeEq,
    T::Epsilon: Copy + FloatComponent, 

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: &Rhs,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

The inverse of RelativeEq::relative_eq.

impl<T> Saturate for Oklch<T> where
    T: FloatComponent, 

type Scalar = T

The type of the (de)saturation modifier.

fn saturate(&self, factor: T) -> Oklch<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) -> Oklch<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<T> Shade for Oklch<T> where
    T: FloatComponent, 

type Scalar = T

The type of the lighten/darken modifier.

fn lighten(&self, factor: T) -> Oklch<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) -> Oklch<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<T> Sub<Oklch<T>> for Oklch<T> where
    T: FloatComponent, 

type Output = Oklch<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Sub<T> for Oklch<T> where
    T: FloatComponent, 

type Output = Oklch<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> SubAssign<Oklch<T>> for Oklch<T> where
    T: FloatComponent + SubAssign, 

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

Performs the -= operation.

impl<T> SubAssign<T> for Oklch<T> where
    T: FloatComponent + SubAssign, 

fn sub_assign(&mut self, c: T)

Performs the -= operation.

impl<T> UlpsEq<Oklch<T>> for Oklch<T> where
    T: FloatComponent + UlpsEq,
    T::Epsilon: Copy + FloatComponent, 

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: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl<T, _A> WithAlpha<_A> for Oklch<T> where
    T: FloatComponent,
    _A: Component, 

type Color = Oklch<T>

The opaque color type, without any transparency.

type WithAlpha = Alpha<Oklch<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

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<T> Copy for Oklch<T> where
    T: FloatComponent, 

impl<T> Eq for Oklch<T> where
    T: FloatComponent + Eq, 

impl<T> StructuralPartialEq for Oklch<T> where
    T: FloatComponent,