Struct palette::Alpha

#[repr(C)]
pub struct Alpha<C, T> {
    pub color: C,
    pub alpha: T,
}

An alpha component wrapper for colors.

Fields

color: C

The color.

alpha: T

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

Implementations

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

pub fn min_alpha() -> T

Return the alpha value minimum.

pub fn max_alpha() -> T

Return the alpha value maximum.

impl<T, A> Alpha<Hsl<Srgb, T>, A> where
    T: FloatComponent,
    A: Component, 

Hsla implementations.

pub fn new<H: Into<RgbHue<T>>>(
    hue: H,
    saturation: T,
    lightness: T,
    alpha: A
) -> Self

HSL and transparency for linear sRGB.

impl<S, T, A> Alpha<Hsl<S, T>, A> where
    T: FloatComponent,
    A: Component,
    S: RgbStandard, 

Hsla implementations.

pub fn with_wp<H: Into<RgbHue<T>>>(
    hue: H,
    saturation: T,
    lightness: T,
    alpha: A
) -> Self

Linear HSL and transparency.

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

Convert to a (hue, saturation, lightness, alpha) tuple.

pub fn from_components<H: Into<RgbHue<T>>>(
    (hue, saturation, lightness, alpha): (H, T, T, A)
) -> Self

Convert from a (hue, saturation, lightness, alpha) tuple.

impl<T, A> Alpha<Hsluv<D65, T>, A> where
    T: FloatComponent,
    A: Component, 

Hsluva implementations.

pub fn new<H: Into<LuvHue<T>>>(hue: H, saturation: T, l: T, alpha: A) -> Self

HSLuv and transparency with standard D65 whitepoint.

impl<Wp, T, A> Alpha<Hsluv<Wp, T>, A> where
    T: FloatComponent,
    A: Component,
    Wp: WhitePoint, 

Hsluva implementations.

pub fn with_wp<H: Into<LuvHue<T>>>(
    hue: H,
    saturation: T,
    l: T,
    alpha: A
) -> Self

HSLuv and transparency.

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

Convert to a (hue, saturation, l, alpha) tuple.

pub fn from_components<H: Into<LuvHue<T>>>(
    (hue, saturation, l, alpha): (H, T, T, A)
) -> Self

Convert from a (hue, saturation, l, alpha) tuple.

impl<T, A> Alpha<Hsv<Srgb, T>, A> where
    T: FloatComponent,
    A: Component, 

Hsva implementations.

pub fn new<H: Into<RgbHue<T>>>(
    hue: H,
    saturation: T,
    value: T,
    alpha: A
) -> Self

HSV and transparency for linear sRGB.

impl<S, T, A> Alpha<Hsv<S, T>, A> where
    T: FloatComponent,
    A: Component,
    S: RgbStandard, 

Hsva implementations.

pub fn with_wp<H: Into<RgbHue<T>>>(
    hue: H,
    saturation: T,
    value: T,
    alpha: A
) -> Self

Linear HSV and transparency.

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

Convert to a (hue, saturation, value, alpha) tuple.

pub fn from_components<H: Into<RgbHue<T>>>(
    (hue, saturation, value, alpha): (H, T, T, A)
) -> Self

Convert from a (hue, saturation, value, alpha) tuple.

impl<T, A> Alpha<Hwb<Srgb, T>, A> where
    T: FloatComponent,
    A: Component, 

Hwba implementations.

pub fn new<H: Into<RgbHue<T>>>(
    hue: H,
    whiteness: T,
    blackness: T,
    alpha: A
) -> Self

HWB and transparency for linear sRGB.

impl<S, T, A> Alpha<Hwb<S, T>, A> where
    T: FloatComponent,
    A: Component,
    S: RgbStandard, 

Hwba implementations.

pub fn with_wp<H: Into<RgbHue<T>>>(
    hue: H,
    whiteness: T,
    blackness: T,
    alpha: A
) -> Self

Linear HWB and transparency.

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

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

pub fn from_components<H: Into<RgbHue<T>>>(
    (hue, whiteness, blackness, alpha): (H, T, T, A)
) -> Self

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

impl<T, A> Alpha<Lab<D65, T>, A> where
    T: FloatComponent,
    A: Component, 

Laba implementations.

pub fn new(l: T, a: T, b: T, alpha: A) -> Self

CIE L*a*b* and transparency and white point D65.

impl<Wp, T, A> Alpha<Lab<Wp, T>, A> where
    T: FloatComponent,
    A: Component,
    Wp: WhitePoint, 

Laba implementations.

pub fn with_wp(l: T, a: T, b: T, alpha: A) -> Self

CIE L*a*b* and transparency.

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

Convert to a (L\*, a\*, b\*, alpha) tuple.

pub fn from_components((l, a, b, alpha): (T, T, T, A)) -> Self

Convert from a (L\*, a\*, b\*, alpha) tuple.

impl<T, A> Alpha<Lch<D65, T>, A> where
    T: FloatComponent,
    A: Component, 

Lcha implementations.

pub fn new<H: Into<LabHue<T>>>(l: T, chroma: T, hue: H, alpha: A) -> Self

CIE L*C*h° and transparency with white point D65.

impl<Wp, T, A> Alpha<Lch<Wp, T>, A> where
    T: FloatComponent,
    A: Component,
    Wp: WhitePoint, 

Lcha implementations.

pub fn with_wp<H: Into<LabHue<T>>>(l: T, chroma: T, hue: H, alpha: A) -> Self

CIE L*C*h° and transparency.

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

Convert to a (L\*, C\*, h°, alpha) tuple.

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

Convert from a (L\*, C\*, h°, alpha) tuple.

impl<T, A> Alpha<Lchuv<D65, T>, A> where
    T: FloatComponent,
    A: Component, 

Lchuva implementations.

pub fn new<H: Into<LuvHue<T>>>(l: T, chroma: T, hue: H, alpha: A) -> Self

CIE L*C*uv h°uv and transparency with white point D65.

impl<Wp, T, A> Alpha<Lchuv<Wp, T>, A> where
    T: FloatComponent,
    A: Component,
    Wp: WhitePoint, 

Lchuva implementations.

pub fn with_wp<H: Into<LuvHue<T>>>(l: T, chroma: T, hue: H, alpha: A) -> Self

CIE L*C*uv h°uv and transparency.

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

Convert to a (L\*, C\*uv, h°uv, alpha) tuple.

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

Convert from a (L\*, C\*uv, h°uv, alpha) tuple.

impl<S, T, A> Alpha<Luma<S, T>, A> where
    T: Component,
    A: Component,
    S: LumaStandard, 

Lumaa implementations.

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

Create a luminance color with transparency.

pub fn into_format<U, B>(self) -> Alpha<Luma<S, U>, B> where
    U: Component + FromComponent<T>,
    B: Component + FromComponent<A>, 

Convert into another component type.

pub fn from_format<U, B>(color: Alpha<Luma<S, U>, B>) -> Self where
    T: FromComponent<U>,
    U: Component,
    A: FromComponent<B>,
    B: Component, 

Convert from another component type.

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

Convert to a (luma, alpha) tuple.

pub fn from_components((luma, alpha): (T, A)) -> Self

Convert from a (luma, alpha) tuple.

impl<S, T, A> Alpha<Luma<S, T>, A> where
    T: FloatComponent,
    A: Component,
    S: LumaStandard, 

Lumaa implementations.

pub fn into_linear(self) -> Alpha<Luma<Linear<S::WhitePoint>, T>, A>

Convert the color to linear luminance with transparency.

pub fn from_linear(
    color: Alpha<Luma<Linear<S::WhitePoint>, T>, A>
) -> Alpha<Luma<S, T>, A>

Convert linear luminance to nonlinear luminance with transparency.

pub fn into_encoding<St: LumaStandard<WhitePoint = S::WhitePoint>>(
    self
) -> Alpha<Luma<St, T>, A>

Convert the color to a different encoding with transparency.

pub fn from_encoding<St: LumaStandard<WhitePoint = S::WhitePoint>>(
    color: Alpha<Luma<St, T>, A>
) -> Alpha<Luma<S, T>, A>

Convert luminance from a different encoding with transparency.

impl<T, A> Alpha<Luv<D65, T>, A> where
    T: FloatComponent,
    A: Component, 

Luva implementations.

pub fn new(l: T, u: T, v: T, alpha: A) -> Self

CIE L*u*v* and transparency and white point D65.

impl<Wp, T, A> Alpha<Luv<Wp, T>, A> where
    T: FloatComponent,
    A: Component,
    Wp: WhitePoint, 

Luva implementations.

pub fn with_wp(l: T, u: T, v: T, alpha: A) -> Self

CIE L*u*v* and transparency.

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

Convert to u (L\*, u\*, v\*, alpha) tuple.

pub fn from_components((l, u, v, alpha): (T, T, T, A)) -> Self

Convert from u (L\*, u\*, v\*, alpha) tuple.

impl<S: RgbStandard, T: Component, A: Component> Alpha<Rgb<S, T>, A>

Rgba implementations.

pub fn new(red: T, green: T, blue: T, alpha: A) -> Self

Nonlinear RGB.

pub fn into_format<U, B>(self) -> Alpha<Rgb<S, U>, B> where
    U: Component + FromComponent<T>,
    B: Component + FromComponent<A>, 

Convert into another component type.

pub fn from_format<U, B>(color: Alpha<Rgb<S, U>, B>) -> Self where
    T: FromComponent<U>,
    U: Component,
    A: FromComponent<B>,
    B: Component, 

Convert from another component type.

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

Convert to a (red, green, blue, alpha) tuple.

pub fn from_components((red, green, blue, alpha): (T, T, T, A)) -> Self

Convert from a (red, green, blue, alpha) tuple.

impl<S: RgbStandard> Alpha<Rgb<S, T>, T>

Convenience functions to convert between a packed u32 and Rgba.

use palette::Srgba;

let rgba = Srgba::from(0x607F00FF);
assert_eq!(Srgba::new(96u8, 127, 0, 255), rgba);

let integer = u32::from(rgba);
assert_eq!(0x607F00FF, integer);

pub fn into_u32<C: RgbChannels>(self) -> u32

Convert to a packed u32 with with specifiable component order. Defaults to ARGB ordering (0xAARRGGBB).

See Packed for more details.

pub fn from_u32<C: RgbChannels>(color: u32) -> Self

Convert from a packed u32 with specifiable component order. Defaults to ARGB ordering (0xAARRGGBB).

See Packed for more details.

impl<S: RgbStandard, T: FloatComponent, A: Component> Alpha<Rgb<S, T>, A>

Rgba implementations.

pub fn into_linear(self) -> Alpha<Rgb<Linear<S::Space>, T>, A>

Convert the color to linear RGB with transparency.

pub fn from_linear(color: Alpha<Rgb<Linear<S::Space>, T>, A>) -> Self

Convert linear RGB to nonlinear RGB with transparency.

pub fn into_encoding<St: RgbStandard<Space = S::Space>>(
    self
) -> Alpha<Rgb<St, T>, A>

Convert the color to a different encoding with transparency.

pub fn from_encoding<St: RgbStandard<Space = S::Space>>(
    color: Alpha<Rgb<St, T>, A>
) -> Self

Convert RGB from a different encoding with transparency.

impl<T, A> Alpha<Xyz<D65, T>, A> where
    T: FloatComponent,
    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: FloatComponent,
    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.

impl<T, A> Alpha<Yxy<D65, T>, A> where
    T: FloatComponent,
    A: Component, 

Yxya 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<Yxy<Wp, T>, A> where
    T: FloatComponent,
    A: Component,
    Wp: WhitePoint, 

Yxya implementations.

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

CIE Yxy and transparency.

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

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

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

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

Trait Implementations

impl<C, T> AbsDiffEq<Alpha<C, T>> for Alpha<C, T> where
    C: AbsDiffEq<Epsilon = T::Epsilon>,
    T: AbsDiffEq,
    T::Epsilon: Clone, 

type Epsilon = 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.

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

The inverse of AbsDiffEq::abs_diff_eq.

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

type Output = Alpha<C::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<T: Add + Clone, C: Add<T>> Add<T> for Alpha<C, T>

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

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

Performs the += operation.

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: ?Sized> AsMut<P> for Alpha<C, T> where
    C: Pixel<T>,
    P: RawPixel<T>, 

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

Performs the conversion.

impl<C, T, P: ?Sized> AsRef<P> for Alpha<C, T> where
    C: Pixel<T>,
    P: RawPixel<T>, 

fn as_ref(&self) -> &P

Performs the conversion.

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::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: Clamp, T: Component> Clamp for Alpha<C, T>

fn is_within_bounds(&self) -> bool

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

fn clamp(&self) -> Alpha<C, 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<C: Clone, T: Clone> Clone for Alpha<C, T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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: Debug, T: Debug> Debug for Alpha<C, T>

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

Formats the value using the given formatter.

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

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

Returns the “default value” for a type.

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

type Target = C

The resulting type after dereferencing.

fn deref(&self) -> &C

Dereferences the value.

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

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

Mutably dereferences the value.

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

type Output = Alpha<C::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: Div + Clone, C: Div<T>> Div<T> for Alpha<C, T>

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

The resulting type after applying the / operator.

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

Performs the / operation.

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

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

Performs the /= operation.

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

fn div_assign(&mut self, c: T)

Performs the /= operation.

impl<S: RgbStandard, T: FloatComponent, H: Into<RgbHue<T>>, A: Component> From<(H, T, T, A)> for Alpha<Hsl<S, T>, A>

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

Performs the conversion.

impl<Wp: WhitePoint, T: FloatComponent, H: Into<LuvHue<T>>, A: Component> From<(H, T, T, A)> for Alpha<Hsluv<Wp, T>, A>

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

Performs the conversion.

impl<S: RgbStandard, T: FloatComponent, H: Into<RgbHue<T>>, A: Component> From<(H, T, T, A)> for Alpha<Hsv<S, T>, A>

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

Performs the conversion.

impl<S: RgbStandard, T: FloatComponent, H: Into<RgbHue<T>>, A: Component> From<(H, T, T, A)> for Alpha<Hwb<S, T>, A>

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

Performs the conversion.

impl<S: LumaStandard, T: Component, A: Component> From<(T, A)> for Alpha<Luma<S, T>, A>

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

Performs the conversion.

impl<Wp: WhitePoint, T: FloatComponent, H: Into<LabHue<T>>, A: Component> From<(T, T, H, A)> for Alpha<Lch<Wp, T>, A>

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

Performs the conversion.

impl<Wp: WhitePoint, T: FloatComponent, H: Into<LuvHue<T>>, A: Component> From<(T, T, H, A)> for Alpha<Lchuv<Wp, T>, A>

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

Performs the conversion.

impl<Wp: WhitePoint, T: FloatComponent, A: Component> From<(T, T, T, A)> for Alpha<Lab<Wp, T>, A>

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

Performs the conversion.

impl<Wp: WhitePoint, T: FloatComponent, A: Component> From<(T, T, T, A)> for Alpha<Luv<Wp, T>, A>

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

Performs the conversion.

impl<S: RgbStandard, T: Component, A: Component> From<(T, T, T, A)> for Alpha<Rgb<S, T>, A>

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

Performs the conversion.

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

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

Performs the conversion.

impl<Wp: WhitePoint, T: FloatComponent, A: Component> From<(T, T, T, A)> for Alpha<Yxy<Wp, T>, A>

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

Performs the conversion.

impl<C, T> From<Alpha<C, T>> for PreAlpha<C, T> where
    C: ComponentWise<Scalar = T>,
    T: Float, 

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

Performs the conversion.

impl<T, U> From<Alpha<Rgb<Linear<Srgb>, T>, T>> for Srgba<U> where
    T: FloatComponent,
    U: Component + FromComponent<T>, 

fn from(lin_srgba: LinSrgba<T>) -> Self

Performs the conversion.

impl<S: RgbStandard> From<Alpha<Rgb<S, u8>, u8>> for u32

fn from(color: Rgba<S, u8>) -> Self

Performs the conversion.

impl<S, C> From<Alpha<Rgb<S, u8>, u8>> for Packed<C> where
    S: RgbStandard,
    C: RgbChannels, 

fn from(color: Rgba<S, u8>) -> Self

Performs the conversion.

impl<T, U> From<Alpha<Rgb<Srgb, T>, T>> for LinSrgba<U> where
    T: FloatComponent,
    U: Component + FromComponent<T>, 

fn from(srgba: Srgba<T>) -> Self

Performs the conversion.

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

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

Performs the conversion.

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>

Performs the conversion.

impl<S, T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    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<Wp, T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Hsluv<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    _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<Wp, T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Xyz<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    _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<Wp, T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Yxy<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    _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<S, T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Hsv<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    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<S, T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    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<Wp, T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Lab<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    _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<Wp, T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Lch<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    _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<Wp, T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Lchuv<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    _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<S, T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    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<Wp, T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Luv<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    _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<S: RgbStandard, T: Component, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Rgb<S, T> where
    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<C1: WithAlpha<T>, C2, T: Component> FromColorUnclamped<C1> for Alpha<C2, T> where
    C1::Color: IntoColorUnclamped<C2>, 

fn from_color_unclamped(other: C1) -> Self

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

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

type Hue = C::Hue

The kind of hue unit this color space uses.

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

Calculate a hue if possible.

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<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(LuvHue<T>, T, T, A)> for Alpha<Hsluv<Wp, T>, A>

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

Performs the conversion.

impl<S: RgbStandard, T: FloatComponent, A: Component> Into<(RgbHue<T>, T, T, A)> for Alpha<Hsl<S, T>, A>

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

Performs the conversion.

impl<S: RgbStandard, T: FloatComponent, A: Component> Into<(RgbHue<T>, T, T, A)> for Alpha<Hsv<S, T>, A>

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

Performs the conversion.

impl<S: RgbStandard, T: FloatComponent, A: Component> Into<(RgbHue<T>, T, T, A)> for Alpha<Hwb<S, T>, A>

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

Performs the conversion.

impl<S: LumaStandard, T: Component, A: Component> Into<(T, A)> for Alpha<Luma<S, T>, A>

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

Performs the conversion.

impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(T, T, LabHue<T>, A)> for Alpha<Lch<Wp, T>, A>

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

Performs the conversion.

impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(T, T, LuvHue<T>, A)> for Alpha<Lchuv<Wp, T>, A>

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

Performs the conversion.

impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(T, T, T, A)> for Alpha<Lab<Wp, T>, A>

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

Performs the conversion.

impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(T, T, T, A)> for Alpha<Luv<Wp, T>, A>

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

Performs the conversion.

impl<S: RgbStandard, T: Component, A: Component> Into<(T, T, T, A)> for Alpha<Rgb<S, T>, A>

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

Performs the conversion.

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

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

Performs the conversion.

impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(T, T, T, A)> for Alpha<Yxy<Wp, T>, A>

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

Performs the conversion.

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: Mix> Mix for Alpha<C, C::Scalar>

type Scalar = C::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: Mul, T: Float> Mul<Alpha<C, T>> for Alpha<C, T>

type Output = Alpha<C::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<T: Mul + Clone, C: Mul<T>> Mul<T> for Alpha<C, T>

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

The resulting type after applying the * operator.

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

Performs the * operation.

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

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

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> PartialEq<Alpha<C, T>> for Alpha<C, T> where
    T: PartialEq,
    C: PartialEq, 

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

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

#[must_use]

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

This method tests for !=.

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 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<C, T> RelativeEq<Alpha<C, T>> 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.

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

The inverse of RelativeEq::relative_eq.

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

type Scalar = C::Scalar

The type of the (de)saturation modifier.

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

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

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

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<C: Shade> Shade for Alpha<C, C::Scalar>

type Scalar = C::Scalar

The type of the lighten/darken modifier.

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

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

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

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<C: Sub, T: Float> Sub<Alpha<C, T>> for Alpha<C, T>

type Output = Alpha<C::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<T: Sub + Clone, C: Sub<T>> Sub<T> for Alpha<C, T>

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

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

Performs the -= operation.

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, T> UlpsEq<Alpha<C, T>> 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.

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

The inverse of UlpsEq::ulps_eq.

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, A: Component> WithAlpha<A> for Alpha<C, A>

type Color = C

The opaque color type, without any transparency.

type WithAlpha = Self

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<C: Copy, T: Copy> Copy for Alpha<C, T>

impl<C, T> Eq for Alpha<C, T> where
    T: Eq,
    C: Eq,