Struct cosmic::cosmic_theme::palette::hwb::Hwb

#[repr(C)]
pub struct Hwb<S = Srgb, T = f32> {
    pub hue: RgbHue<T>,
    pub whiteness: T,
    pub blackness: T,
    pub standard: PhantomData<S>,
}

HWB color space.

HWB is a cylindrical version of RGB and it’s very closely related to HSV. It describes colors with a starting hue, then a degree of whiteness and blackness to mix into that base hue.

HWB 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::Hwb;

let hwb_u8 = Hwb::new_srgb(128u8, 85, 51);
let hwb_f32 = hwb_u8.into_format::<f32>();

assert_relative_eq!(hwb_f32, Hwb::new(180.0, 1.0 / 3.0, 0.2));

It is very intuitive for humans to use and many color-pickers are based on the HWB color system

Fields

hue: RgbHue<T>

The hue of the color, in degrees. Decides if it’s red, blue, purple, etc. Same as the hue for HSL and HSV.

whiteness: T

The whiteness of the color. It specifies the amount white to mix into the hue. It varies from 0 to 1, with 1 being always full white and 0 always being the color shade (a mixture of a pure hue with black) chosen with the other two controls.

blackness: T

The blackness of the color. It specifies the amount black to mix into the hue. It varies from 0 to 1, with 1 being always full black and 0 always being the color tint (a mixture of a pure hue with white) chosen with the other two

standard: PhantomData<S>

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

Implementations

impl<T> Hwb<Srgb, T>

pub fn new_srgb<H>(hue: H, whiteness: T, blackness: T) -> Hwb<Srgb, T>

where H: Into<RgbHue<T>>,

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

pub const fn new_srgb_const( hue: RgbHue<T>, whiteness: T, blackness: T, ) -> Hwb<Srgb, T>

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

impl<S, T> Hwb<S, T>

pub fn new<H>(hue: H, whiteness: T, blackness: T) -> Hwb<S, T>

where H: Into<RgbHue<T>>,

Create an HWB color.

pub const fn new_const(hue: RgbHue<T>, whiteness: T, blackness: T) -> Hwb<S, T>

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

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

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

Convert into another component type.

pub fn from_format<U>(color: Hwb<S, U>) -> Hwb<S, T>

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

Convert from another component type.

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

Convert to a (hue, whiteness, blackness) tuple.

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

where H: Into<RgbHue<T>>,

Convert from a (hue, whiteness, blackness) tuple.

impl<S, T> Hwb<S, T>

where T: Stimulus,

pub fn min_whiteness() -> T

Return the whiteness value minimum.

pub fn max_whiteness() -> T

Return the whiteness value maximum.

pub fn min_blackness() -> T

Return the blackness value minimum.

pub fn max_blackness() -> T

Return the blackness value maximum.

impl<S, T> Hwb<S, &T>

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

where T: Copy,

Get an owned, copied version of this color.

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

where T: Clone,

Get an owned, cloned version of this color.

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

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

Update this color with new values.

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

Borrow this color’s components as shared references.

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

where T: Copy,

Get an owned, copied version of this color.

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

where T: Clone,

Get an owned, cloned version of this color.

impl<S, C> Hwb<S, C>

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

where &'a Hwb<S, C>: IntoIterator,

Return an iterator over the colors in the wrapped collections.

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

where &'a mut Hwb<S, 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<Hwb<S, &'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<Hwb<S, &'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<S, T> Hwb<S, Vec<T>>

pub fn with_capacity(capacity: usize) -> Hwb<S, Vec<T>>

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

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

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

pub fn pop(&mut self) -> Option<Hwb<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 Hwb<S, T>

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

type Epsilon = <T as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> <Hwb<S, T> as AbsDiffEq>::Epsilon

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

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

The inverse of AbsDiffEq::abs_diff_eq.

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

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

type Output = Hwb<S, T>

The resulting type after applying the + operator.

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

Performs the + operation.

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

where T: Add<Output = T>,

type Output = Hwb<S, T>

The resulting type after applying the + operator.

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

Performs the + operation.

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

where T: AddAssign + Clone,

fn add_assign(&mut self, c: T)

Performs the += operation.

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

where T: AddAssign,

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

Performs the += operation.

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

type Array = [T; 3]

The output type of a cast to an array.

impl<S, T> AsMut<[T]> for Hwb<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 Hwb<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> AsRef<[T]> for Hwb<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 Hwb<S, T>

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

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

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

where T: One + Clamp + PartialCmp + Add<Output = T> + DivAssign + Clone + Stimulus, <T as HasBoolMask>::Mask: Select<T>,

fn clamp(self) -> Hwb<S, T>

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

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

where T: One + ClampAssign + PartialCmp + Add<Output = T> + DivAssign + Clone + Stimulus, <T as HasBoolMask>::Mask: Select<T>,

fn clamp_assign(&mut self)

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

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

where T: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S, T> Debug for Hwb<S, T>

where S: Debug, T: Debug,

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

Formats the value using the given formatter.

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

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

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

Returns the “default value” for a type.

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

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

where C: Extend<T>,

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

where I: IntoIterator<Item = Hwb<S, 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, S, T> From<&'a [T; 3]> for &'a Hwb<S, T>

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

Converts to this type from the input type.

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

fn from(color: &'a Hwb<S, T>) -> &'a [T]

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

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

Converts to this type from the input type.

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

fn from(array: [T; 3]) -> Hwb<S, T>

Converts to this type from the input type.

impl<S, T, H> From<(H, T, T)> for Hwb<S, T>

where H: Into<RgbHue<T>>,

fn from(components: (H, T, T)) -> Hwb<S, T>

Converts to this type from the input type.

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

fn from(array: Box<[T; 3]>) -> Box<Hwb<S, T>>

Converts to this type from the input type.

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

where _C: IntoColorUnclamped<Hwb<S, T>>,

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

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

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

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

where S: RgbStandard, Hsv<S, T>: FromColorUnclamped<Hsluv<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> + IntoColorUnclamped<Hwb<S, T>>,

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

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

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

where T: One + Arithmetics,

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

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

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

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

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

where T: One + Zero + IsValidDivisor + Arithmetics, <T as HasBoolMask>::Mask: LazySelect<T>,

fn from_color_unclamped(hwb: Hwb<S, T>) -> Hsv<S, T>

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

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

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

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

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

impl<S1, S2, T> FromColorUnclamped<Hwb<S1, T>> for Hwb<S2, T>

where S1: RgbStandard + 'static, S2: RgbStandard + 'static, <S1 as RgbStandard>::Space: RgbSpace<WhitePoint = <<S2 as RgbStandard>::Space as RgbSpace>::WhitePoint>, Hsv<S1, T>: FromColorUnclamped<Hwb<S1, T>>, Hsv<S2, T>: FromColorUnclamped<Hsv<S1, T>>, Hwb<S2, T>: FromColorUnclamped<Hsv<S2, T>>,

fn from_color_unclamped(hwb: Hwb<S1, T>) -> Hwb<S2, T>

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

impl<Wp, T, _S> FromColorUnclamped<Hwb<_S, T>> for Hsluv<Wp, T>

where _S: RgbStandard, <_S as RgbStandard>::Space: RgbSpace<WhitePoint = Wp>, Wp: WhitePoint<T>, Lchuv<Wp, T>: FromColorUnclamped<Hwb<_S, T>> + IntoColorUnclamped<Hsluv<Wp, T>>,

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

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

impl<Wp, T, _S> FromColorUnclamped<Hwb<_S, T>> for Lab<Wp, T>

where _S: RgbStandard, <_S as RgbStandard>::Space: RgbSpace<WhitePoint = Wp>, Wp: WhitePoint<T>, Xyz<Wp, T>: FromColorUnclamped<Hwb<_S, T>> + IntoColorUnclamped<Lab<Wp, T>>,

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

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

impl<Wp, T, _S> FromColorUnclamped<Hwb<_S, T>> for Lch<Wp, T>

where _S: RgbStandard, <_S as RgbStandard>::Space: RgbSpace<WhitePoint = Wp>, Wp: WhitePoint<T>, Lab<Wp, T>: FromColorUnclamped<Hwb<_S, T>> + IntoColorUnclamped<Lch<Wp, T>>,

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

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

impl<Wp, T, _S> FromColorUnclamped<Hwb<_S, T>> for Lchuv<Wp, T>

where _S: RgbStandard, <_S as RgbStandard>::Space: RgbSpace<WhitePoint = Wp>, Wp: WhitePoint<T>, Luv<Wp, T>: FromColorUnclamped<Hwb<_S, T>> + IntoColorUnclamped<Lchuv<Wp, T>>,

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

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

impl<S, T, _S> FromColorUnclamped<Hwb<_S, T>> for Luma<S, T>

where _S: RgbStandard, <_S as RgbStandard>::Space: RgbSpace<WhitePoint = <S as LumaStandard>::WhitePoint>, S: LumaStandard, Xyz<<S as LumaStandard>::WhitePoint, T>: FromColorUnclamped<Hwb<_S, T>> + IntoColorUnclamped<Luma<S, T>>,

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

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

impl<Wp, T, _S> FromColorUnclamped<Hwb<_S, T>> for Luv<Wp, T>

where _S: RgbStandard, <_S as RgbStandard>::Space: RgbSpace<WhitePoint = Wp>, Wp: WhitePoint<T>, Xyz<Wp, T>: FromColorUnclamped<Hwb<_S, T>> + IntoColorUnclamped<Luv<Wp, T>>,

fn from_color_unclamped(color: Hwb<_S, T>) -> Luv<Wp, 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, _S> FromColorUnclamped<Hwb<_S, T>> for Okhsv<T>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<Wp, T, _S> FromColorUnclamped<Hwb<_S, T>> for Xyz<Wp, T>

where _S: RgbStandard, <_S as RgbStandard>::Space: RgbSpace<WhitePoint = Wp>, Wp: WhitePoint<T>, Rgb<_S, T>: FromColorUnclamped<Hwb<_S, T>> + IntoColorUnclamped<Xyz<Wp, T>>,

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

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

impl<Wp, T, _S> FromColorUnclamped<Hwb<_S, T>> for Yxy<Wp, T>

where _S: RgbStandard, <_S as RgbStandard>::Space: RgbSpace<WhitePoint = Wp>, Wp: WhitePoint<T>, Xyz<Wp, T>: FromColorUnclamped<Hwb<_S, T>> + IntoColorUnclamped<Yxy<Wp, T>>,

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

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

where S: RgbStandard, Hsv<S, T>: FromColorUnclamped<Lab<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> + IntoColorUnclamped<Hwb<S, T>>,

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

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

where S: RgbStandard, Hsv<S, T>: FromColorUnclamped<Lch<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> + IntoColorUnclamped<Hwb<S, T>>,

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

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

where S: RgbStandard, Hsv<S, T>: FromColorUnclamped<Lchuv<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> + IntoColorUnclamped<Hwb<S, T>>,

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

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

impl<S, T, _S> FromColorUnclamped<Luma<_S, T>> for Hwb<S, T>

where _S: LumaStandard<WhitePoint = <<S as RgbStandard>::Space as RgbSpace>::WhitePoint>, S: RgbStandard, Hsv<S, T>: FromColorUnclamped<Luma<_S, T>> + IntoColorUnclamped<Hwb<S, T>>,

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

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

where S: RgbStandard, Hsv<S, T>: FromColorUnclamped<Luv<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> + IntoColorUnclamped<Hwb<S, T>>,

fn from_color_unclamped( color: Luv<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>, ) -> Hwb<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<S, T> FromColorUnclamped<Okhsv<T>> for Hwb<S, T>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

where S: RgbStandard, Hsv<S, T>: FromColorUnclamped<Xyz<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> + IntoColorUnclamped<Hwb<S, T>>,

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

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

where S: RgbStandard, Hsv<S, T>: FromColorUnclamped<Yxy<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> + IntoColorUnclamped<Hwb<S, T>>,

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

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

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

where Hwb<S, C>: Extend<Hwb<S, T>>, C: Default,

fn from_iter<I>(iter: I) -> Hwb<S, C>

where I: IntoIterator<Item = Hwb<S, T>>,

Creates a value from an iterator.

impl<S, T> GetHue for Hwb<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 Hwb<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 Hwb<S, &'b [T]>

type Item = Hwb<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) -> <&'a Hwb<S, &'b [T]> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Hwb<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) -> <&'a Hwb<S, &'b mut [T]> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Hwb<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) -> <&'a Hwb<S, [T; N]> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Hwb<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) -> <&'a Hwb<S, Box<[T]>> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Hwb<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) -> <&'a Hwb<S, Vec<T>> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Hwb<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) -> <&'a mut Hwb<S, &'b mut [T]> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Hwb<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) -> <&'a mut Hwb<S, [T; N]> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Hwb<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) -> <&'a mut Hwb<S, Box<[T]>> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Hwb<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) -> <&'a mut Hwb<S, Vec<T>> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Hwb<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) -> <Hwb<S, &'a [T]> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Hwb<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) -> <Hwb<S, &'a mut [T]> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Hwb<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) -> <Hwb<S, [T; N]> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = Hwb<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) -> <Hwb<S, Vec<T>> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

where T: PartialCmp + Add<Output = T> + Clone + 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<S, T> Lighten for Hwb<S, T>

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

type Scalar = T

The type of the lighten modifier.

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

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

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

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

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

where T: Real + Zero + MinMax + ClampAssign + AddAssign + SubAssign + 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<S, T> Mix for Hwb<S, T>

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

type Scalar = T

The type of the mixing factor.

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

Mix the color with an other color, by factor.

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

Mix the color with an other color, by factor.

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

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

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

where T: Real + Arithmetics + PartialCmp, <T as HasBoolMask>::Mask: LazySelect<T>, S: RgbStandard, Xyz<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>: FromColor<Hwb<S, 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: Hwb<S, 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<S, T> RelativeEq for Hwb<S, T>

where T: RelativeEq, <T as AbsDiffEq>::Epsilon: Clone, RgbHue<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: &Hwb<S, 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: &Hwb<S, T>, epsilon: <T as AbsDiffEq>::Epsilon, max_relative: <T as AbsDiffEq>::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.

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

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

type Output = Hwb<S, T>

The resulting type.

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

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

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

where T: SaturatingAdd<Output = T>,

type Output = Hwb<S, T>

The resulting type.

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

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

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

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

type Output = Hwb<S, T>

The resulting type.

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

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

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

where T: SaturatingSub<Output = T>,

type Output = Hwb<S, T>

The resulting type.

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

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

impl<S, T> Serialize for Hwb<S, 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<S, T, H> SetHue<H> for Hwb<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 Hwb<S, T>

where T: Add<Output = T>,

type Scalar = T

The type of the hue modifier.

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

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

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

where T: AddAssign,

type Scalar = T

The type of the hue modifier.

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

Shifts the hue by amount.

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

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

type Output = Hwb<S, T>

The resulting type after applying the - operator.

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

Performs the - operation.

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

where T: Sub<Output = T>,

type Output = Hwb<S, T>

The resulting type after applying the - operator.

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

Performs the - operation.

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

where T: SubAssign + Clone,

fn sub_assign(&mut self, c: T)

Performs the -= operation.

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

where T: SubAssign,

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

Performs the -= operation.

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

Performs the conversion.

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

Performs the conversion.

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

where T: UlpsEq, <T as AbsDiffEq>::Epsilon: Clone, RgbHue<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: &Hwb<S, 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: &Hwb<S, T>, epsilon: <T as AbsDiffEq>::Epsilon, max_ulps: u32, ) -> bool

The inverse of UlpsEq::ulps_eq.

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

where _A: Stimulus,

type Color = Hwb<S, T>

The opaque color type, without any transparency.

type WithAlpha = Alpha<Hwb<S, T>, _A>

The color type with transparency applied.

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

where H: Into<RgbHue<T>>,

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

Return a copy of self with a specific hue.

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

where T: Copy,

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

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