Struct Yxy

#[repr(C)]
pub struct Yxy<Wp = D65, T = f32> {
    pub x: T,
    pub y: T,
    pub luma: T,
    pub white_point: PhantomData<Wp>,
}

The CIE 1931 Yxy (xyY) color space.

Yxy is a luminance-chromaticity color space derived from the CIE XYZ color space. It is widely used to define colors. The chromaticity diagrams for the color spaces are a plot of this color space’s x and y coordinates.

Conversions and operations on this color space depend on the white point.

Fields

x: T

x chromaticity co-ordinate derived from XYZ color space as X/(X+Y+Z). Typical range is between 0 and 1

y: T

y chromaticity co-ordinate derived from XYZ color space as Y/(X+Y+Z). Typical range is between 0 and 1

luma: T

luma (Y) was a measure of the brightness or luminance of a color. It is the same as the Y from the XYZ color space. Its range is from 0 to 1, where 0 is black and 1 is white.

white_point: PhantomData<Wp>

The white point associated with the color’s illuminant and observer. D65 for 2 degree observer is used by default.

Implementations

impl<Wp, T> Yxy<Wp, T>

pub const fn new(x: T, y: T, luma: T) -> Yxy<Wp, T>

Create a CIE Yxy color.

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

Convert to a (x, y, luma), a.k.a. (x, y, Y) tuple.

pub fn from_components((x, y, luma): (T, T, T)) -> Self

Convert from a (x, y, luma), a.k.a. (x, y, Y) tuple.

pub fn with_white_point<NewWp>(self) -> Yxy<NewWp, T>

Changes the reference white point without changing the color value.

This function doesn’t change the numerical values, and thus the color it represents in an absolute sense. However, the appearance of the color may not be the same when observed with the new white point. The effect would be similar to taking a photo with an incorrect white balance.

See chromatic_adaptation for operations that can change the white point while preserving the color’s appearance.

impl<Wp, T> Yxy<Wp, T>

where T: Zero + One,

pub fn min_x() -> T

Return the x value minimum.

pub fn max_x() -> T

Return the x value maximum.

pub fn min_y() -> T

Return the y value minimum.

pub fn max_y() -> T

Return the y value maximum.

pub fn min_luma() -> T

Return the luma value minimum.

pub fn max_luma() -> T

Return the luma value maximum.

impl<Wp, T> Yxy<Wp, &T>

pub fn copied(&self) -> Yxy<Wp, T>

where T: Copy,

Get an owned, copied version of this color.

pub fn cloned(&self) -> Yxy<Wp, T>

where T: Clone,

Get an owned, cloned version of this color.

impl<Wp, T> Yxy<Wp, &mut T>

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

Update this color with new values.

pub fn as_refs(&self) -> Yxy<Wp, &T>

Borrow this color’s components as shared references.

pub fn copied(&self) -> Yxy<Wp, T>

where T: Copy,

Get an owned, copied version of this color.

pub fn cloned(&self) -> Yxy<Wp, T>

where T: Clone,

Get an owned, cloned version of this color.

impl<Wp, C> Yxy<Wp, C>

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

where &'a Self: IntoIterator,

Return an iterator over the colors in the wrapped collections.

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

where &'a mut Self: IntoIterator,

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

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

pub fn with_capacity(capacity: usize) -> Self

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

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

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

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

where R: RangeBounds<usize> + Clone,

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

Trait Implementations

impl<Wp, T> AbsDiffEq for Yxy<Wp, T>

where T: AbsDiffEq, T::Epsilon: Clone,

type Epsilon = <T as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

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

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

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

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

The inverse of AbsDiffEq::abs_diff_eq.

impl<Wp, T> Add<T> for Yxy<Wp, T>

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

type Output = Yxy<Wp, T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<Wp, T> Add for Yxy<Wp, T>

where T: Add<Output = T>,

type Output = Yxy<Wp, T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<Wp, T> AddAssign<T> for Yxy<Wp, T>

where T: AddAssign + Clone,

fn add_assign(&mut self, c: T)

Performs the += operation.

impl<Wp, T> AddAssign for Yxy<Wp, T>

where T: AddAssign,

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<Wp, T> ArrayCast for Yxy<Wp, T>

type Array = [T; 3]

The output type of a cast to an array.

impl<Wp, T> AsMut<[T]> for Yxy<Wp, T>

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

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

impl<Wp, T> AsMut<[T; 3]> for Yxy<Wp, T>

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

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

impl<Wp, T> AsMut<Yxy<Wp, T>> for [T; 3]

fn as_mut(&mut self) -> &mut Yxy<Wp, T>

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

impl<Wp, T> AsRef<[T]> for Yxy<Wp, T>

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

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

impl<Wp, T> AsRef<[T; 3]> for Yxy<Wp, T>

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

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

impl<Wp, T> AsRef<Yxy<Wp, T>> for [T; 3]

fn as_ref(&self) -> &Yxy<Wp, T>

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

impl<Wp, T> Clamp for Yxy<Wp, T>

where T: Clamp + Zero + One,

fn clamp(self) -> Self

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

impl<Wp, T> ClampAssign for Yxy<Wp, T>

where T: ClampAssign + Zero + One,

fn clamp_assign(&mut self)

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

impl<Wp, T> Clone for Yxy<Wp, T>

where T: Clone,

fn clone(&self) -> Yxy<Wp, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Wp: Debug, T: Debug> Debug for Yxy<Wp, T>

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

Formats the value using the given formatter.

impl<Wp, T> Default for Yxy<Wp, T>

where T: Zero, Wp: WhitePoint<T>, Xyz<Wp, T>: IntoColorUnclamped<Self>,

fn default() -> Yxy<Wp, T>

Returns the “default value” for a type.

impl<'de, Wp, T> Deserialize<'de> for Yxy<Wp, T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Wp, T> Div<T> for Yxy<Wp, T>

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

type Output = Yxy<Wp, T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<Wp, T> Div for Yxy<Wp, T>

where T: Div<Output = T>,

type Output = Yxy<Wp, T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<Wp, T> DivAssign<T> for Yxy<Wp, T>

where T: DivAssign + Clone,

fn div_assign(&mut self, c: T)

Performs the /= operation.

impl<Wp, T> DivAssign for Yxy<Wp, T>

where T: DivAssign,

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl<Wp, T> EuclideanDistance for Yxy<Wp, T>

where T: Real + Sub<T, Output = T> + Add<T, Output = T> + Mul<T, Output = T> + Clone,

type Scalar = T

The type for the distance value.

fn distance_squared(self, other: Self) -> Self::Scalar

Calculate the squared Euclidean distance from self to other.

impl<Wp, T, C> Extend<Yxy<Wp, T>> for Yxy<Wp, C>

where C: Extend<T>,

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

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

impl<'a, Wp, T> From<&'a [T; 3]> for &'a Yxy<Wp, T>

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

Converts to this type from the input type.

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

fn from(color: &'a Yxy<Wp, T>) -> Self

Converts to this type from the input type.

impl<'a, Wp, T> From<&'a Yxy<Wp, T>> for &'a [T; 3]

fn from(color: &'a Yxy<Wp, T>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<Wp, T> From<[T; 3]> for Yxy<Wp, T>

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

Converts to this type from the input type.

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

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

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

Converts to this type from the input type.

impl<Wp, T> From<(T, T, T)> for Yxy<Wp, T>

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

Converts to this type from the input type.

impl<Wp, T> From<Box<[T; 3]>> for Box<Yxy<Wp, T>>

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

Converts to this type from the input type.

impl<Wp, T> From<PreAlpha<Yxy<Wp, T>>> for Yxy<Wp, T>

where Self: Premultiply<Scalar = T>,

fn from(premultiplied: PreAlpha<Self>) -> Self

Converts to this type from the input type.

impl<Wp, T> From<Yxy<Wp, T>> for [T; 3]

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

Converts to this type from the input type.

impl<Wp, T> From<Yxy<Wp, T>> for (T, T, T)

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

Converts to this type from the input type.

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

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

fn from(color: Yxy<Wp, V>) -> Self

Converts to this type from the input type.

impl<Wp, T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Yxy<Wp, T>

where _C: IntoColorUnclamped<Self>,

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

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

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

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

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

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

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

where Wp: WhitePoint<T>, Xyz<Wp, T>: FromColorUnclamped<Hsluv<Wp, T>> + IntoColorUnclamped<Self>,

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

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

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

where _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = Wp>, Wp: WhitePoint<T>, Xyz<Wp, T>: FromColorUnclamped<Hsv<_S, T>> + IntoColorUnclamped<Self>,

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

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

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

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

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

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

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

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

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

where Wp: WhitePoint<T>, Xyz<Wp, T>: FromColorUnclamped<Lch<Wp, T>> + IntoColorUnclamped<Self>,

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

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

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

where Wp: WhitePoint<T>, Xyz<Wp, T>: FromColorUnclamped<Lchuv<Wp, T>> + IntoColorUnclamped<Self>,

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

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

impl<T, S> FromColorUnclamped<Luma<S, T>> for Yxy<S::WhitePoint, T>

where S: LumaStandard, S::TransferFn: IntoLinear<T, T>, Self: Default,

fn from_color_unclamped(luma: Luma<S, T>) -> Self

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

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

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

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

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<Self>,

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

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

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

where Wp: WhitePoint<T>, Xyz<Wp, T>: FromColorUnclamped<Okhsv<T>> + IntoColorUnclamped<Self>,

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

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

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

where Wp: WhitePoint<T>, Xyz<Wp, T>: FromColorUnclamped<Okhwb<T>> + IntoColorUnclamped<Self>,

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

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

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

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

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

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

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

where Wp: WhitePoint<T>, Xyz<Wp, T>: FromColorUnclamped<Oklch<T>> + IntoColorUnclamped<Self>,

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

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

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

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

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

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

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

where T: Zero + IsValidDivisor + Arithmetics + Clone, T::Mask: LazySelect<T> + Clone,

fn from_color_unclamped(xyz: Xyz<Wp, T>) -> Self

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

impl<S, T> FromColorUnclamped<Yxy<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Hsl<S, T>

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

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

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

impl<S, T> FromColorUnclamped<Yxy<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Hsv<S, T>

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

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

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

impl<S, T> 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<Self>,

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

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

impl<S, T> FromColorUnclamped<Yxy<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Rgb<S, T>

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

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

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

impl<S, T> FromColorUnclamped<Yxy<<S as LumaStandard>::WhitePoint, T>> for Luma<S, T>

where S: LumaStandard, S::TransferFn: FromLinear<T, T>,

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

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<Self>,

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

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

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

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

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

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

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

where D65: WhitePoint<T>, Okhsv<T>: FromColorUnclamped<Yxy<D65, T>> + IntoColorUnclamped<Self>,

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

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

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

where D65: WhitePoint<T>, Xyz<D65, T>: FromColorUnclamped<Yxy<D65, T>> + IntoColorUnclamped<Self>,

fn from_color_unclamped(color: Yxy<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 D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Yxy<D65, T>> + IntoColorUnclamped<Self>,

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

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

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

where Wp: WhitePoint<T>, Lchuv<Wp, T>: FromColorUnclamped<Yxy<Wp, T>> + IntoColorUnclamped<Self>,

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

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

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

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

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

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

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

where Wp: WhitePoint<T>, Lab<Wp, T>: FromColorUnclamped<Yxy<Wp, T>> + IntoColorUnclamped<Self>,

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

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

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

where Wp: WhitePoint<T>, Luv<Wp, T>: FromColorUnclamped<Yxy<Wp, T>> + IntoColorUnclamped<Self>,

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<Wp, T, C> FromIterator<Yxy<Wp, T>> for Yxy<Wp, C>

where Self: Extend<Yxy<Wp, T>>, C: Default,

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

Creates a value from an iterator.

impl<Wp, T> HasBoolMask for Yxy<Wp, T>

where T: HasBoolMask,

type Mask = <T as HasBoolMask>::Mask

The mask type to use for selecting Self values.

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

type Item = Yxy<Wp, &'a T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

type Item = Yxy<Wp, &'a T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

type Item = Yxy<Wp, &'a T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

type Item = Yxy<Wp, &'a T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, Wp, T> IntoIterator for &'a Yxy<Wp, Vec<T>>

type Item = Yxy<Wp, &'a T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

type Item = Yxy<Wp, &'a mut T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

type Item = Yxy<Wp, &'a mut T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

where T: 'a,

type Item = Yxy<Wp, &'a mut T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

type Item = Yxy<Wp, &'a mut T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

type Item = Yxy<Wp, &'a T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

type Item = Yxy<Wp, &'a mut T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

type Item = Yxy<Wp, T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<Wp, T> IntoIterator for Yxy<Wp, Vec<T>>

type Item = Yxy<Wp, T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<Wp, T> IsWithinBounds for Yxy<Wp, T>

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

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

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

impl<Wp, T> Lighten for Yxy<Wp, T>

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

type Scalar = T

The type of the lighten modifier.

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

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

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

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

impl<Wp, T> LightenAssign for Yxy<Wp, T>

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

type Scalar = T

The type of the lighten modifier.

fn lighten_assign(&mut self, factor: T)

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

fn lighten_fixed_assign(&mut self, amount: T)

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

impl<Wp, T> Mix for Yxy<Wp, T>

where T: Real + Zero + One + Arithmetics + Clamp + Clone,

type Scalar = T

The type of the mixing factor.

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

Mix the color with an other color, by factor.

impl<Wp, T> MixAssign for Yxy<Wp, T>

where T: Real + Zero + One + AddAssign + Arithmetics + Clamp + Clone,

type Scalar = T

The type of the mixing factor.

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

Mix the color with an other color, by factor.

impl<Wp, T> Mul<T> for Yxy<Wp, T>

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

type Output = Yxy<Wp, T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<Wp, T> Mul for Yxy<Wp, T>

where T: Mul<Output = T>,

type Output = Yxy<Wp, T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<Wp, T> MulAssign<T> for Yxy<Wp, T>

where T: MulAssign + Clone,

fn mul_assign(&mut self, c: T)

Performs the *= operation.

impl<Wp, T> MulAssign for Yxy<Wp, T>

where T: MulAssign,

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl<Wp, T> PartialEq for Yxy<Wp, T>

where T: PartialEq,

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Wp, T> Premultiply for Yxy<Wp, T>

where T: Real + Stimulus + Zero + IsValidDivisor + Mul<T, Output = T> + Div<T, Output = T> + Clone, T::Mask: LazySelect<T> + Clone,

type Scalar = T

The color’s component type.

fn premultiply(self, alpha: T) -> PreAlpha<Self>

Alpha mask the color.

fn unpremultiply(premultiplied: PreAlpha<Self>) -> (Self, T)

Alpha unmask the color, resulting in a color and transparency pair.

impl<Wp, T> RelativeContrast for Yxy<Wp, T>

where T: Real + Arithmetics + PartialCmp, T::Mask: LazySelect<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: Self) -> T

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

Calculate the contrast ratio between two colors.

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

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

Verify the contrast between two colors satisfies SC 1.4.3. Contrast is at least 4.5:1 (Level AA).

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

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

Verify the contrast between two colors satisfies SC 1.4.3 for large text. Contrast is at least 3:1 (Level AA).

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

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

Verify the contrast between two colors satisfies SC 1.4.6. Contrast is at least 7:1 (Level AAA).

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

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

Verify the contrast between two colors satisfies SC 1.4.6 for large text. Contrast is at least 4.5:1 (Level AAA).

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

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

Verify the contrast between two colors satisfies SC 1.4.11 for graphical objects. Contrast is at least 3:1 (Level AA).

impl<Wp, T> RelativeEq for Yxy<Wp, T>

where T: RelativeEq, T::Epsilon: Clone,

fn default_max_relative() -> T::Epsilon

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

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

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

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

The inverse of RelativeEq::relative_eq.

impl<Wp, T> SaturatingAdd<T> for Yxy<Wp, T>

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

type Output = Yxy<Wp, T>

The resulting type.

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

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

impl<Wp, T> SaturatingAdd for Yxy<Wp, T>

where T: SaturatingAdd<Output = T>,

type Output = Yxy<Wp, T>

The resulting type.

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

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

impl<Wp, T> SaturatingSub<T> for Yxy<Wp, T>

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

type Output = Yxy<Wp, T>

The resulting type.

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

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

impl<Wp, T> SaturatingSub for Yxy<Wp, T>

where T: SaturatingSub<Output = T>,

type Output = Yxy<Wp, T>

The resulting type.

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

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

impl<Wp, T> Serialize for Yxy<Wp, T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Wp, T> Sub<T> for Yxy<Wp, T>

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

type Output = Yxy<Wp, T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<Wp, T> Sub for Yxy<Wp, T>

where T: Sub<Output = T>,

type Output = Yxy<Wp, T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<Wp, T> SubAssign<T> for Yxy<Wp, T>

where T: SubAssign + Clone,

fn sub_assign(&mut self, c: T)

Performs the -= operation.

impl<Wp, T> SubAssign for Yxy<Wp, T>

where T: SubAssign,

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<'a, Wp, T> TryFrom<&'a [T]> for &'a Yxy<Wp, T>

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a, Wp, T> TryFrom<&'a mut [T]> for &'a mut Yxy<Wp, T>

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<Wp, T> UlpsEq for Yxy<Wp, T>

where T: UlpsEq, T::Epsilon: Clone,

fn default_max_ulps() -> u32

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

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

A test for equality that uses units in the last place (ULP) if the values are far apart.

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

The inverse of UlpsEq::ulps_eq.

impl<Wp, T, _A> WithAlpha<_A> for Yxy<Wp, T>

where _A: Stimulus,

type Color = Yxy<Wp, T>

The opaque color type, without any transparency.

type WithAlpha = Alpha<Yxy<Wp, T>, _A>

The color type with transparency applied.

fn with_alpha(self, alpha: _A) -> Self::WithAlpha

Transforms the color into a transparent color with the provided alpha value. If Self already has a transparency, it is overwritten.

fn without_alpha(self) -> Self::Color

Removes the transparency from the color. If Self::Color has an internal transparency field, that field will be set to A::max_intensity() to make it opaque.

fn split(self) -> (Self::Color, _A)

Splits the color into separate color and transparency values.

fn opaque(self) -> Self::WithAlpha

where A: Stimulus,

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

fn transparent(self) -> Self::WithAlpha

where A: Zero,

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

impl<Wp, T> Copy for Yxy<Wp, T>

where T: Copy,

impl<Wp, T> Eq for Yxy<Wp, T>

where T: Eq,