Struct palette::Alpha [−][src]
#[repr(C)]pub struct Alpha<C, T> { pub color: C, pub alpha: T, }
Expand description
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
Hsla
implementations.
Hsla
implementations.
Linear HSL and transparency.
Convert to a (hue, saturation, lightness, alpha)
tuple.
Hsluva
implementations.
Hsva
implementations.
Hsva
implementations.
Linear HSV and transparency.
Convert to a (hue, saturation, value, alpha)
tuple.
Hwba
implementations.
Hwba
implementations.
Linear HWB and transparency.
Convert to a (hue, whiteness, blackness, alpha)
tuple.
Laba
implementations.
Laba
implementations.
Convert to a (L\*, a\*, b\*, alpha)
tuple.
Convert from a (L\*, a\*, b\*, alpha)
tuple.
Lcha
implementations.
Lchuva
implementations.
Lchuva
implementations.
CIE L*C*uv h°uv and transparency.
Convert to a (L\*, C\*uv, h°uv, alpha)
tuple.
Lumaa
implementations.
pub fn into_format<U, B>(self) -> Alpha<Luma<S, U>, B> where
U: Component + FromComponent<T>,
B: Component + FromComponent<A>,
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,
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.
Convert to a (luma, alpha)
tuple.
Convert from a (luma, alpha)
tuple.
Lumaa
implementations.
Convert the color to linear luminance with transparency.
Convert linear luminance to non-linear luminance with transparency.
pub fn into_encoding<St: LumaStandard<WhitePoint = S::WhitePoint>>(
self
) -> Alpha<Luma<St, T>, A>
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>
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.
Luva
implementations.
Luva
implementations.
Convert to u (L\*, u\*, v\*, alpha)
tuple.
Convert from u (L\*, u\*, v\*, alpha)
tuple.
Rgba
implementations.
pub fn into_format<U, B>(self) -> Alpha<Rgb<S, U>, B> where
U: Component + FromComponent<T>,
B: Component + FromComponent<A>,
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,
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.
Convert to a (red, green, blue, alpha)
tuple.
Convert from a (red, green, blue, alpha)
tuple.
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);
Rgba
implementations.
Convert the color to linear RGB with transparency.
Convert linear RGB to non-linear RGB with transparency.
Convert the color to a different encoding with transparency.
Convert RGB from a different encoding with transparency.
Xyza
implementations.
Yxya
implementations.
Yxya
implementations.
Convert to a (x, y, luma)
, a.k.a. (x, y, Y)
tuple.
Convert from a (x, y, luma)
, a.k.a. (x, y, Y)
tuple.
Trait Implementations
The default tolerance to use when testing values that are close together. Read more
A test for equality that uses the absolute difference to compute the approximate equality of two numbers. Read more
The inverse of AbsDiffEq::abs_diff_eq
.
Performs the +=
operation. Read more
Performs the +=
operation. Read more
Convert the color to premultiplied alpha.
Convert the color from premultiplied alpha.
fn blend<F>(self, destination: Self, blend_function: F) -> Self where
F: BlendFunction<Self::Color>,
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. Read more
Place self
over other
. This is the good old common alpha
composition equation. Read more
Results in the parts of self
that overlaps the visible parts of
other
. Read more
Results in the parts of self
that lies outside the visible parts of
other
. Read more
Add self
and other
. This uses the alpha component to regulate the
effect, so it’s not just plain component wise addition. Read more
Multiply self
with other
. This uses the alpha component to regulate
the effect, so it’s not just plain component wise multiplication. Read more
Multiply self
or other
if other is dark, or screen them if other
is light. This results in an S curve. Read more
Lighten other
to reflect self
. Results in other
if self
is
black. Read more
Darken other
to reflect self
. Results in other
if self
is
white. Read more
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
. Read more
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. Read more
Return the absolute difference between self
and other
. It’s
basically abs(self - other)
, but regulated by the alpha component. Read more
type Scalar = T
type Scalar = T
The scalar type for color components.
Perform a binary operation on this and an other color.
Perform a unary operation on this color.
Performs the /=
operation. Read more
Performs the /=
operation. Read more
impl<Wp: WhitePoint, T: FloatComponent, A: Component> From<(T, T, T, A)> for Alpha<Lab<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> From<(T, T, T, A)> for Alpha<Lab<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> From<(T, T, T, A)> for Alpha<Luv<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> From<(T, T, T, A)> for Alpha<Luv<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> From<(T, T, T, A)> for Alpha<Xyz<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> From<(T, T, T, A)> for Alpha<Xyz<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> From<(T, T, T, A)> for Alpha<Yxy<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> From<(T, T, T, A)> for Alpha<Yxy<Wp, T>, A>
impl<T, U> From<Alpha<Rgb<Linear<Srgb>, T>, T>> for Srgba<U> where
T: FloatComponent,
U: Component + FromComponent<T>,
impl<T, U> From<Alpha<Rgb<Linear<Srgb>, T>, T>> for Srgba<U> where
T: FloatComponent,
U: Component + FromComponent<T>,
impl<T, U> From<Alpha<Rgb<Srgb, T>, T>> for LinSrgba<U> where
T: FloatComponent,
U: Component + FromComponent<T>,
impl<T, U> From<Alpha<Rgb<Srgb, T>, T>> for LinSrgba<U> where
T: FloatComponent,
U: Component + FromComponent<T>,
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,
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,
Convert from T. The resulting color might be invalid in its color space. Read more
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,
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,
Convert from T. The resulting color might be invalid in its color space. Read more
impl<T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Oklch<T> where
T: FloatComponent,
T: FloatComponent,
_C: IntoColorUnclamped<Self>,
_A: Component,
impl<T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Oklch<T> where
T: FloatComponent,
T: FloatComponent,
_C: IntoColorUnclamped<Self>,
_A: Component,
Convert from T. The resulting color might be invalid in its color space. Read more
impl<S: RgbStandard, T: Component, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Rgb<S, T> where
T: FloatComponent,
_C: IntoColorUnclamped<Self>,
_A: Component,
impl<S: RgbStandard, T: Component, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Rgb<S, T> where
T: FloatComponent,
_C: IntoColorUnclamped<Self>,
_A: Component,
Convert from T. The resulting color might be invalid in its color space. Read more
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,
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,
Convert from T. The resulting color might be invalid in its color space. Read more
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,
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,
Convert from T. The resulting color might be invalid in its color space. Read more
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,
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,
Convert from T. The resulting color might be invalid in its color space. Read more
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,
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,
Convert from T. The resulting color might be invalid in its color space. Read more
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,
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,
Convert from T. The resulting color might be invalid in its color space. Read more
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,
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,
Convert from T. The resulting color might be invalid in its color space. Read more
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,
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,
Convert from T. The resulting color might be invalid in its color space. Read more
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,
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,
Convert from T. The resulting color might be invalid in its color space. Read more
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,
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,
Convert from T. The resulting color might be invalid in its color space. Read more
impl<T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Oklab<T> where
T: FloatComponent,
T: FloatComponent,
_C: IntoColorUnclamped<Self>,
_A: Component,
impl<T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Oklab<T> where
T: FloatComponent,
T: FloatComponent,
_C: IntoColorUnclamped<Self>,
_A: Component,
Convert from T. The resulting color might be invalid in its color space. Read more
impl<C1: WithAlpha<T>, C2, T: Component> FromColorUnclamped<C1> for Alpha<C2, T> where
C1::Color: IntoColorUnclamped<C2>,
impl<C1: WithAlpha<T>, C2, T: Component> FromColorUnclamped<C1> for Alpha<C2, T> where
C1::Color: IntoColorUnclamped<C2>,
Convert from T. The resulting color might be invalid in its color space. Read more
impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(LuvHue<T>, T, T, A)> for Alpha<Hsluv<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(LuvHue<T>, T, T, A)> for Alpha<Hsluv<Wp, T>, A>
impl<S: RgbStandard, T: FloatComponent, A: Component> Into<(RgbHue<T>, T, T, A)> for Alpha<Hsl<S, T>, A>
impl<S: RgbStandard, T: FloatComponent, A: Component> Into<(RgbHue<T>, T, T, A)> for Alpha<Hsl<S, T>, A>
impl<S: RgbStandard, T: FloatComponent, A: Component> Into<(RgbHue<T>, T, T, A)> for Alpha<Hsv<S, T>, A>
impl<S: RgbStandard, T: FloatComponent, A: Component> Into<(RgbHue<T>, T, T, A)> for Alpha<Hsv<S, T>, A>
impl<S: RgbStandard, T: FloatComponent, A: Component> Into<(RgbHue<T>, T, T, A)> for Alpha<Hwb<S, T>, A>
impl<S: RgbStandard, T: FloatComponent, A: Component> Into<(RgbHue<T>, T, T, A)> for Alpha<Hwb<S, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(T, T, LabHue<T>, A)> for Alpha<Lch<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(T, T, LabHue<T>, A)> for Alpha<Lch<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(T, T, LuvHue<T>, A)> for Alpha<Lchuv<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(T, T, LuvHue<T>, A)> for Alpha<Lchuv<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(T, T, T, A)> for Alpha<Lab<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(T, T, T, A)> for Alpha<Lab<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(T, T, T, A)> for Alpha<Luv<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(T, T, T, A)> for Alpha<Luv<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(T, T, T, A)> for Alpha<Xyz<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(T, T, T, A)> for Alpha<Xyz<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(T, T, T, A)> for Alpha<Yxy<Wp, T>, A>
impl<Wp: WhitePoint, T: FloatComponent, A: Component> Into<(T, T, T, A)> for Alpha<Yxy<Wp, T>, A>
Performs the *=
operation. Read more
Performs the *=
operation. Read more
Cast as a mutable reference to raw color components.
Convert into raw color components.
Cast from a reference to raw color components.
Cast from a mutable reference to raw color components.
Cast a slice of raw color components to a slice of colors. Read more
Cast a mutable slice of raw color components to a mutable slice of colors. Read more
Cast a slice of colors to a slice of raw color components. Read more
Cast a mutable slice of colors to a mutable slice of raw color components. Read more
impl<C, T> RelativeEq<Alpha<C, T>> for Alpha<C, T> where
C: RelativeEq<Epsilon = T::Epsilon>,
T: RelativeEq,
T::Epsilon: Clone,
impl<C, T> RelativeEq<Alpha<C, T>> for Alpha<C, T> where
C: RelativeEq<Epsilon = T::Epsilon>,
T: RelativeEq,
T::Epsilon: Clone,
The default relative tolerance for testing values that are far-apart. Read more
A test for equality that uses a relative comparison if the values are far apart.
The inverse of RelativeEq::relative_eq
.
Scale the color towards the maximum saturation by factor
, a value
ranging from 0.0
to 1.0
. Read more
Increase the saturation by amount
, a value ranging from 0.0
to
1.0
. Read more
Scale the color towards the minimum saturation by factor
, a value
ranging from 0.0
to 1.0
. Read more
Increase the saturation by amount
, a value ranging from 0.0
to
1.0
. Read more
Scale the color towards the maximum lightness by factor
, a value
ranging from 0.0
to 1.0
. Read more
Lighten the color by amount
, a value ranging from 0.0
to 1.0
. Read more
Scale the color towards the minimum lightness by factor
, a value
ranging from 0.0
to 1.0
. Read more
Darken the color by amount
, a value ranging from 0.0
to 1.0
. Read more
Performs the -=
operation. Read more
Performs the -=
operation. Read more
The default ULPs to tolerate when testing values that are far-apart. Read more
A test for equality that uses units in the last place (ULP) if the values are far apart.
Transforms the color into a transparent color with the provided
alpha value. If Self
already has a transparency, it is
overwritten. Read more
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. Read more
Splits the color into separate color and transparency values. Read more
Transforms the color into a fully opaque color with a transparency
field. If Self
already has a transparency, it is overwritten. Read more
Transforms the color into a fully transparent color. If Self
already has a transparency, it is overwritten. Read more
Auto Trait Implementations
impl<C, T> RefUnwindSafe for Alpha<C, T> where
C: RefUnwindSafe,
T: RefUnwindSafe,
impl<C, T> UnwindSafe for Alpha<C, T> where
C: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<S, D, Swp, Dwp, T> AdaptFrom<S, Swp, Dwp, T> for D where
T: FloatComponent,
S: IntoColorUnclamped<Xyz<Swp, T>>,
Swp: WhitePoint,
Dwp: WhitePoint,
D: FromColorUnclamped<Xyz<Dwp, T>>,
impl<S, D, Swp, Dwp, T> AdaptFrom<S, Swp, Dwp, T> for D where
T: FloatComponent,
S: IntoColorUnclamped<Xyz<Swp, T>>,
Swp: WhitePoint,
Dwp: WhitePoint,
D: FromColorUnclamped<Xyz<Dwp, T>>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
T: FloatComponent,
Swp: WhitePoint,
Dwp: WhitePoint,
D: AdaptFrom<S, Swp, Dwp, T>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
T: FloatComponent,
Swp: WhitePoint,
Dwp: WhitePoint,
D: AdaptFrom<S, Swp, Dwp, T>,
Mutably borrows from an owned value. Read more
Convert from T with values clamped to the color defined bounds. Read more
Convert into T with values clamped to the color defined bounds Read more
Convert into T. The resulting color might be invalid in its color space Read more
Convert from T, returning ok if the color is inside of its defined
range, otherwise an OutOfBounds
error is returned which contains
the unclamped color. Read more
Convert into T, returning ok if the color is inside of its defined
range, otherwise an OutOfBounds
error is returned which contains
the unclamped color. Read more