Type Alias palette::Xyza

pub type Xyza<Wp = D65, T = f32> = Alpha<Xyz<Wp, T>, T>;

CIE 1931 XYZ with an alpha component. See the Xyza implementation in Alpha.

Aliased Type

struct Xyza<Wp = D65, T = f32> {
    pub color: Xyz<Wp, T>,
    pub alpha: T,
}

Fields

color: Xyz<Wp, T>

The color.

alpha: T

The transparency component. 0.0 is fully transparent and 1.0 is fully opaque.

Implementations

impl<T, A> Alpha<Xyz<D65, T>, A>

where T: Component + Float, A: Component,

Xyza implementations.

pub fn new(x: T, y: T, luma: T, alpha: A) -> Self

CIE Yxy and transparency with white point D65.

impl<Wp, T, A> Alpha<Xyz<Wp, T>, A>

where T: Component + Float, A: Component, Wp: WhitePoint,

Xyza implementations.

pub fn with_wp(x: T, y: T, z: T, alpha: A) -> Self

CIE XYZ and transparency.

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

Convert to a (X, Y, Z, alpha) tuple.

pub fn from_components((x, y, z, alpha): (T, T, T, A)) -> Self

Convert from a (X, Y, Z, alpha) tuple.

Trait Implementations

impl<C, T> Serialize for Alpha<C, T>

where C: Serialize, 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> From<Alpha<Lab<Wp, T>, T>> for Alpha<Xyz<Wp, T>, T>

where T: Component + Float + Component + _FloatTrait, Wp: WhitePoint,

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

Converts to this type from the input type.

impl<C, T> AbsDiffEq for Alpha<C, T>

where C: AbsDiffEq<Epsilon = T::Epsilon>, 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: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of ApproxEq::abs_diff_eq.

impl<Wp, T, _S> From<Alpha<Luma<_S, T>, T>> for Alpha<Xyz<Wp, T>, T>

where T: Component + Float + Component + _FloatTrait, Wp: WhitePoint, _S: LumaStandard<WhitePoint = Wp>,

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

Converts to this type from the input type.

impl<T: Div + Clone, C: Div<T>> Div<T> for Alpha<C, T>

type Output = Alpha<<C as Div<T>>::Output, <T as Div>::Output>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<Wp, T, _S> From<Alpha<Hsl<_S, T>, T>> for Alpha<Xyz<Wp, T>, T>

where T: Component + Float + Component + _FloatTrait, Wp: WhitePoint, _S: RgbSpace<WhitePoint = Wp>,

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

Converts to this type from the input type.

impl<C: Mul, T: Float> Mul for Alpha<C, T>

type Output = Alpha<<C as Mul>::Output, <T as Mul>::Output>

The resulting type after applying the * operator.

fn mul(self, other: Alpha<C, T>) -> Self::Output

Performs the * operation.

impl<C, T> DerefMut for Alpha<C, T>

fn deref_mut(&mut self) -> &mut C

Mutably dereferences the value.

impl<C: Hue, T: Clone> Hue for Alpha<C, T>

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

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

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

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

impl<C: Sub, T: Float> Sub for Alpha<C, T>

type Output = Alpha<<C as Sub>::Output, <T as Sub>::Output>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<C: GetHue, T> GetHue for Alpha<C, T>

type Hue = <C as GetHue>::Hue

The kind of hue unit this color space uses.

fn get_hue(&self) -> Option<C::Hue>

Calculate a hue if possible.

impl<Wp, T, _S> From<Hsv<_S, T>> for Alpha<Xyz<Wp, T>, T>

where T: Component + Float + Component + _FloatTrait, Wp: WhitePoint, _S: RgbSpace<WhitePoint = Wp>,

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

Converts to this type from the input type.

impl<C, T> StructuralPartialEq for Alpha<C, T>

impl<C: Saturate> Saturate for Alpha<C, C::Scalar>

type Scalar = <C as Saturate>::Scalar

The type of the (de)saturation factor.

fn saturate(&self, factor: C::Scalar) -> Alpha<C, C::Scalar>

Increase the saturation by factor.

fn desaturate(&self, factor: Self::Scalar) -> Self

Decrease the saturation by factor.

impl<C: Debug, T: Debug> Debug for Alpha<C, T>

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

Formats the value using the given formatter.

impl<C: Div, T: Float> Div for Alpha<C, T>

type Output = Alpha<<C as Div>::Output, <T as Div>::Output>

The resulting type after applying the / operator.

fn div(self, other: Alpha<C, T>) -> Self::Output

Performs the / operation.

impl<T: MulAssign + Copy, C: MulAssign<T>> MulAssign<T> for Alpha<C, T>

fn mul_assign(&mut self, c: T)

Performs the *= operation.

impl<C, T, P> AsMut<P> for Alpha<C, T>

where C: Pixel<T>, 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<Wp, T, _S> From<Alpha<Hsv<_S, T>, T>> for Alpha<Xyz<Wp, T>, T>

where T: Component + Float + Component + _FloatTrait, Wp: WhitePoint, _S: RgbSpace<WhitePoint = Wp>,

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

Converts to this type from the input type.

impl<T: Sub + Clone, C: Sub<T>> Sub<T> for Alpha<C, T>

type Output = Alpha<<C as Sub<T>>::Output, <T as Sub>::Output>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T, C: Pixel<T>> Pixel<T> for Alpha<C, T>

const CHANNELS: usize = _

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 from 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<Wp, T, _S> From<Rgb<_S, T>> for Alpha<Xyz<Wp, T>, T>

where T: Component + Float + Component + _FloatTrait, Wp: WhitePoint, _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = Wp>,

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

Converts to this type from the input type.

impl<C: Limited, T: Component> Limited for Alpha<C, T>

fn is_valid(&self) -> bool

Check if the color’s components are within the expected ranges.

fn clamp(&self) -> Alpha<C, T>

Return a new color where the components has been clamped to the nearest valid values.

fn clamp_self(&mut self)

Clamp the color’s components to the nearest valid values.

impl<Wp, T, _S> From<Hwb<_S, T>> for Alpha<Xyz<Wp, T>, T>

where T: Component + Float + Component + _FloatTrait, Wp: WhitePoint, _S: RgbSpace<WhitePoint = Wp>,

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

Converts to this type from the input type.

impl<C: SubAssign, T: Float + SubAssign> SubAssign for Alpha<C, T>

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

Performs the -= operation.

impl<Wp, T, _S> From<Luma<_S, T>> for Alpha<Xyz<Wp, T>, T>

where T: Component + Float + Component + _FloatTrait, Wp: WhitePoint, _S: LumaStandard<WhitePoint = Wp>,

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

Converts to this type from the input type.

impl<Wp, T> From<Alpha<Lch<Wp, T>, T>> for Alpha<Xyz<Wp, T>, T>

where T: Component + Float + Component + _FloatTrait, Wp: WhitePoint,

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

Converts to this type from the input type.

impl<C: Clone, T: Clone> Clone for Alpha<C, T>

fn clone(&self) -> Alpha<C, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Wp, T, _S> From<Hsl<_S, T>> for Alpha<Xyz<Wp, T>, T>

where T: Component + Float + Component + _FloatTrait, Wp: WhitePoint, _S: RgbSpace<WhitePoint = Wp>,

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

Converts to this type from the input type.

impl<T: AddAssign + Copy, C: AddAssign<T>> AddAssign<T> for Alpha<C, T>

fn add_assign(&mut self, c: T)

Performs the += operation.

impl<C, T, P> AsRef<P> for Alpha<C, T>

where C: Pixel<T>, P: RawPixel<T> + ?Sized,

fn as_ref(&self) -> &P

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

impl<C: DivAssign, T: Float + DivAssign> DivAssign for Alpha<C, T>

fn div_assign(&mut self, other: Alpha<C, T>)

Performs the /= operation.

impl<C: Blend, T: Float> Blend for Alpha<C, T>

where C::Color: ComponentWise<Scalar = T>, Alpha<C, T>: Into<Alpha<C::Color, T>> + From<Alpha<C::Color, T>>,

type Color = <C as Blend>::Color

The core color type. Typically Self for color types without alpha.

fn into_premultiplied(self) -> PreAlpha<C::Color, T>

Convert the color to premultiplied alpha.

fn from_premultiplied(color: PreAlpha<C::Color, T>) -> Alpha<C, T>

Convert the color from premultiplied alpha.

fn blend<F>(self, destination: Self, blend_function: F) -> Self

where F: BlendFunction<Self::Color>,

Blend self, as the source color, with destination, using blend_function. Anything that implements BlendFunction is acceptable, including functions and closures.

fn over(self, other: Self) -> Self

Place self over other. This is the good old common alpha composition equation.

fn inside(self, other: Self) -> Self

Results in the parts of self that overlaps the visible parts of other.

fn outside(self, other: Self) -> Self

Results in the parts of self that lies outside the visible parts of other.

fn atop(self, other: Self) -> Self

Place self over only the visible parts of other.

fn xor(self, other: Self) -> Self

Results in either self or other, where they do not overlap.

fn plus(self, other: Self) -> Self

Add self and other. This uses the alpha component to regulate the effect, so it’s not just plain component wise addition.

fn multiply(self, other: Self) -> Self

Multiply self with other. This uses the alpha component to regulate the effect, so it’s not just plain component wise multiplication.

fn screen(self, other: Self) -> Self

Make a color which is at least as light as self or other.

fn overlay(self, other: Self) -> Self

Multiply self or other if other is dark, or screen them if other is light. This results in an S curve.

fn darken(self, other: Self) -> Self

Return the darkest parts of self and other.

fn lighten(self, other: Self) -> Self

Return the lightest parts of self and other.

fn dodge(self, other: Self) -> Self

Lighten other to reflect self. Results in other if self is black.

fn burn(self, other: Self) -> Self

Darken other to reflect self. Results in other if self is white.

fn hard_light(self, other: Self) -> Self

Multiply self or other if other is dark, or screen them if self is light. This is similar to overlay, but depends on self instead of other.

fn soft_light(self, other: Self) -> Self

Lighten other if self is light, or darken other as if it’s burned if self is dark. The effect is increased if the components of self is further from 0.5.

fn difference(self, other: Self) -> Self

Return the absolute difference between self and other. It’s basically abs(self - other), but regulated by the alpha component.

fn exclusion(self, other: Self) -> Self

Similar to difference, but appears to result in a lower contrast. other is inverted if self is white, and preserved if self is black.

impl<C: MulAssign, T: Float + MulAssign> MulAssign for Alpha<C, T>

fn mul_assign(&mut self, other: Alpha<C, T>)

Performs the *= operation.

impl<C, T> RelativeEq for Alpha<C, T>

where C: RelativeEq<Epsilon = T::Epsilon>, T: RelativeEq, T::Epsilon: Clone,

fn default_max_relative() -> Self::Epsilon

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

fn relative_eq( &self, other: &Alpha<C, T>, epsilon: Self::Epsilon, max_relative: Self::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 ApproxEq::relative_eq.

impl<C: Shade> Shade for Alpha<C, C::Scalar>

type Scalar = <C as Shade>::Scalar

The type of the lighten/darken amount.

fn lighten(&self, amount: C::Scalar) -> Alpha<C, C::Scalar>

Lighten the color by amount.

fn darken(&self, amount: Self::Scalar) -> Self

Darken the color by amount.

impl<C: AddAssign, T: Float + AddAssign> AddAssign for Alpha<C, T>

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

Performs the += operation.

impl<Wp: WhitePoint, T: Component + Float, A: Component> Into<(T, T, T, A)> for Alpha<Xyz<Wp, T>, A>

fn into(self) -> (T, T, T, A)

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

impl<C: Mix> Mix for Alpha<C, C::Scalar>

type Scalar = <C as Mix>::Scalar

The type of the mixing factor.

fn mix( &self, other: &Alpha<C, C::Scalar>, factor: C::Scalar ) -> Alpha<C, C::Scalar>

Mix the color with an other color, by factor.

impl<C, T> UlpsEq for Alpha<C, T>

where C: UlpsEq<Epsilon = T::Epsilon>, 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: &Alpha<C, T>, epsilon: Self::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 ApproxEq::ulps_eq.

impl<Wp, T, _S> From<Alpha<Hwb<_S, T>, T>> for Alpha<Xyz<Wp, T>, T>

where T: Component + Float + Component + _FloatTrait, Wp: WhitePoint, _S: RgbSpace<WhitePoint = Wp>,

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

Converts to this type from the input type.

impl<C: PartialEq, T: PartialEq> PartialEq for Alpha<C, T>

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

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

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

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

impl<T: SubAssign + Copy, C: SubAssign<T>> SubAssign<T> for Alpha<C, T>

fn sub_assign(&mut self, c: T)

Performs the -= operation.

impl<C: Add, T: Float> Add for Alpha<C, T>

type Output = Alpha<<C as Add>::Output, <T as Add>::Output>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<Wp, T> From<Yxy<Wp, T>> for Alpha<Xyz<Wp, T>, T>

where T: Component + Float + Component + _FloatTrait, Wp: WhitePoint,

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

Converts to this type from the input type.

impl<Wp: WhitePoint, T: Component + Float, A: Component> From<(T, T, T, A)> for Alpha<Xyz<Wp, T>, A>

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

Converts to this type from the input type.

impl<C, T> UpperHex for Alpha<C, T>

where T: UpperHex, C: UpperHex,

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

Formats the value using the given formatter.

impl<C: Copy, T: Copy> Copy for Alpha<C, T>

impl<C, T> From<PreAlpha<C, T>> for Alpha<C, T>

where C: ComponentWise<Scalar = T>, T: Float,

fn from(color: PreAlpha<C, T>) -> Alpha<C, T>

Converts to this type from the input type.

impl<C: Default, T: Component> Default for Alpha<C, T>

fn default() -> Alpha<C, T>

Returns the “default value” for a type.

impl<T: Mul + Clone, C: Mul<T>> Mul<T> for Alpha<C, T>

type Output = Alpha<<C as Mul<T>>::Output, <T as Mul>::Output>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<Wp, T> From<Lch<Wp, T>> for Alpha<Xyz<Wp, T>, T>

where T: Component + Float + Component + _FloatTrait, Wp: WhitePoint,

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

Converts to this type from the input type.

impl<'de, C, T> Deserialize<'de> for Alpha<C, T>

where C: Deserialize<'de>, 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> From<Lab<Wp, T>> for Alpha<Xyz<Wp, T>, T>

where T: Component + Float + Component + _FloatTrait, Wp: WhitePoint,

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

Converts to this type from the input type.

impl<T: DivAssign + Copy, C: DivAssign<T>> DivAssign<T> for Alpha<C, T>

fn div_assign(&mut self, c: T)

Performs the /= operation.

impl<C, T> LowerHex for Alpha<C, T>

where T: LowerHex, C: LowerHex,

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

Formats the value using the given formatter.

impl<C: ComponentWise<Scalar = T>, T: Clone> ComponentWise for Alpha<C, T>

type Scalar = T

The scalar type for color components.

fn component_wise<F: FnMut(T, T) -> T>( &self, other: &Alpha<C, T>, f: F ) -> Alpha<C, T>

Perform a binary operation on this and an other color.

fn component_wise_self<F: FnMut(T) -> T>(&self, f: F) -> Alpha<C, T>

Perform a unary operation on this color.

impl<C, T> Deref for Alpha<C, T>

type Target = C

The resulting type after dereferencing.

fn deref(&self) -> &C

Dereferences the value.

impl<Wp, T> From<Alpha<Yxy<Wp, T>, T>> for Alpha<Xyz<Wp, T>, T>

where T: Component + Float + Component + _FloatTrait, Wp: WhitePoint,

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

Converts to this type from the input type.

impl<Wp, T, _S> From<Alpha<Rgb<_S, T>, T>> for Alpha<Xyz<Wp, T>, T>

where T: Component + Float + Component + _FloatTrait, Wp: WhitePoint, _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = Wp>,

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

Converts to this type from the input type.

impl<C, T: Component> From<C> for Alpha<C, T>

fn from(color: C) -> Alpha<C, T>

Converts to this type from the input type.

impl<T: Add + Clone, C: Add<T>> Add<T> for Alpha<C, T>

type Output = Alpha<<C as Add<T>>::Output, <T as Add>::Output>

The resulting type after applying the + operator.

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

Performs the + operation.