Type Alias Cam16Jmha

pub type Cam16Jmha<T> = Alpha<Cam16Jmh<T>, T>;

Partial CIE CAM16 with lightness, colorfulness, and an alpha component.

See the Cam16Jmha implementation in Alpha.

Aliased Type

struct Cam16Jmha<T> {
    pub color: Cam16Jmh<T>,
    pub alpha: T,
}

Fields

color: Cam16Jmh<T>

The color.

alpha: T

The transparency component. 0.0 (or 0u8) is fully transparent and 1.0 (or 255u8) is fully opaque.

Implementations

impl<C: Premultiply> Alpha<C, C::Scalar>

pub fn premultiply(self) -> PreAlpha<C>

Alpha mask the color by its transparency.

impl<C, A> Alpha<C, A>

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.

impl<C, T: Stimulus> 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<Cam16Jmh<&T>, &A>

pub fn copied(&self) -> Alpha<Cam16Jmh<T>, A>

where T: Copy, A: Copy,

Get an owned, copied version of this color.

pub fn cloned(&self) -> Alpha<Cam16Jmh<T>, A>

where T: Clone, A: Clone,

Get an owned, cloned version of this color.

impl<T, A> Alpha<Cam16Jmh<&mut T>, &mut A>

pub fn set(&mut self, value: Alpha<Cam16Jmh<T>, A>)

Update this color with new values.

pub fn as_refs(&self) -> Alpha<Cam16Jmh<&T>, &A>

Borrow this color’s components as shared references.

pub fn copied(&self) -> Alpha<Cam16Jmh<T>, A>

where T: Copy, A: Copy,

Get an owned, copied version of this color.

pub fn cloned(&self) -> Alpha<Cam16Jmh<T>, A>

where T: Clone, A: Clone,

Get an owned, cloned version of this color.

impl<Ct, Ca> Alpha<Cam16Jmh<Ct>, Ca>

pub fn get<'a, I, T, A>( &'a self, index: I, ) -> Option<Alpha<Cam16Jmh<&<I as SliceIndex<[T]>>::Output>, &<I as SliceIndex<[A]>>::Output>>

where T: 'a, A: 'a, Ct: AsRef<[T]>, Ca: AsRef<[A]>, I: SliceIndex<[T]> + SliceIndex<[A]> + 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>( &'a mut self, index: I, ) -> Option<Alpha<Cam16Jmh<&mut <I as SliceIndex<[T]>>::Output>, &mut <I as SliceIndex<[A]>>::Output>>

where T: 'a, A: 'a, Ct: AsMut<[T]>, Ca: AsMut<[A]>, I: SliceIndex<[T]> + SliceIndex<[A]> + Clone,

Get a color, or slice of colors, that allows modifying the components at index. See slice::get_mut for details.

impl<T, A> Alpha<Cam16Jmh<T>, A>

“Cam16Jmha implementations.

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

Create a partial CIE CAM16 color with transparency.

pub const fn new_const( lightness: T, colorfulness: T, hue: Cam16Hue<T>, alpha: A, ) -> Self

Create a partial CIE CAM16 color with transparency. This is the same as Cam16Jmh::new without the generic hue type. It’s temporary until const fn supports traits.

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

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

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

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

pub fn from_xyz<WpParam>( color: Alpha<Xyz<WpParam::StaticWp, T>, A>, parameters: impl Into<BakedParameters<WpParam, T::Scalar>>, ) -> Self

where Xyz<WpParam::StaticWp, T>: IntoCam16Unclamped<WpParam, Cam16Jmh<T>, Scalar = T::Scalar>, T: FromScalar, WpParam: WhitePointParameter<T::Scalar>,

Derive partial CIE CAM16 attributes with transparency, for the provided color, under the provided viewing conditions.

use palette::{Srgba, IntoColor, cam16::{Cam16Jmha, Parameters}};

// Customize these according to the viewing conditions:
let mut example_parameters = Parameters::default_static_wp(40.0);

let rgba = Srgba::new(0.3f32, 0.8, 0.1, 0.9);
let partial = Cam16Jmha::from_xyz(rgba.into_color(), example_parameters);

It’s also possible to “pre-bake” the parameters, to avoid recalculate some of the derived values when converting multiple color value.

use palette::{Srgba, IntoColor, cam16::{Cam16Jmha, Parameters}};

// Customize these according to the viewing conditions:
let mut example_parameters = Parameters::default_static_wp(40.0);

let baked_parameters = example_parameters.bake();

let rgba = Srgba::new(0.3f32, 0.8, 0.1, 0.9);
let partial = Cam16Jmha::from_xyz(rgba.into_color(), baked_parameters);

pub fn into_xyz<WpParam>( self, parameters: impl Into<BakedParameters<WpParam, T::Scalar>>, ) -> Alpha<Xyz<WpParam::StaticWp, T>, A>

where Cam16Jmh<T>: Cam16IntoUnclamped<WpParam, Xyz<WpParam::StaticWp, T>, Scalar = T::Scalar>, WpParam: WhitePointParameter<T>, T: FromScalar,

Construct an XYZ color with transparency, from these CIE CAM16 attributes, under the provided viewing conditions.

use palette::{Srgba, FromColor, cam16::{Cam16Jmha, Parameters}};

// Customize these according to the viewing conditions:
let mut example_parameters = Parameters::default_static_wp(40.0);

let partial = Cam16Jmha::new(50.0f32, 80.0, 120.0, 0.9);
let rgba = Srgba::from_color(partial.into_xyz(example_parameters));

It’s also possible to “pre-bake” the parameters, to avoid recalculate some of the derived values when converting multiple color value.

use palette::{Srgba, FromColor, cam16::{Cam16Jmha, Parameters}};

// Customize these according to the viewing conditions:
let mut example_parameters = Parameters::default_static_wp(40.0);

let baked_parameters = example_parameters.bake();

let partial = Cam16Jmha::new(50.0f32, 80.0, 120.0, 0.9);
let rgba = Srgba::from_color(partial.into_xyz(baked_parameters));

pub fn from_full(full: Alpha<Cam16<T>, A>) -> Self

Create a partial set of CIE CAM16 attributes with transparency.

It’s also possible to use Cam16Jmha::from or Cam16a::into.

pub fn into_full<WpParam>( self, parameters: impl Into<BakedParameters<WpParam, T::Scalar>>, ) -> Alpha<Cam16<T>, A>

where Cam16Jmh<T>: IntoCam16Unclamped<WpParam, Cam16<T>, Scalar = T::Scalar>, WpParam: WhitePointParameter<T>, T: FromScalar,

Reconstruct a full set of CIE CAM16 attributes with transparency, using the original viewing conditions.

use palette::{Srgba, IntoColor, cam16::{Cam16a, Cam16Jmha, Parameters}};
use approx::assert_relative_eq;

// Customize these according to the viewing conditions:
let mut example_parameters = Parameters::default_static_wp(40.0);

// Optional, but saves some work:
let baked_parameters = example_parameters.bake();

let rgba = Srgba::new(0.3f64, 0.8, 0.1, 0.9);
let cam16a = Cam16a::from_xyz(rgba.into_color(), baked_parameters);
let partial = Cam16Jmha::from(cam16a);
let reconstructed = partial.into_full(baked_parameters);

assert_relative_eq!(cam16a, reconstructed, epsilon = 0.0000000000001);

impl<T, A> Alpha<Cam16Jmh<Vec<T>>, Vec<A>>

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: Alpha<Cam16Jmh<T>, A>)

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

pub fn pop(&mut self) -> Option<Alpha<Cam16Jmh<T>, A>>

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<Iter<Drain<'_, T>>, Drain<'_, A>>

where R: RangeBounds<usize> + Clone,

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

Trait Implementations

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 AbsDiffEq::abs_diff_eq.

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

where T: Add + Clone, C: Add<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.

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

where C: Add, T: Add,

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

where T: AddAssign + Clone, C: AddAssign<T>,

fn add_assign(&mut self, c: T)

Performs the += operation.

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

where C: AddAssign, T: AddAssign,

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

Performs the += operation.

impl<C> ArrayCast for Alpha<C, <<C as ArrayCast>::Array as ArrayExt>::Item>

where C: ArrayCast, C::Array: NextArray,

type Array = <<C as ArrayCast>::Array as NextArray>::Next

The output type of a cast to an array.

impl<C, T, const N: usize> AsMut<[T]> for Alpha<C, T>

where Alpha<C, T>: ArrayCast<Array = [T; N]>,

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

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

impl<C, T, const N: usize> AsMut<[T; N]> for Alpha<C, T>

where Alpha<C, T>: ArrayCast<Array = [T; N]>,

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

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

impl<C, T, const N: usize> AsRef<[T]> for Alpha<C, T>

where Alpha<C, T>: ArrayCast<Array = [T; N]>,

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

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

impl<C, T, const N: usize> AsRef<[T; N]> for Alpha<C, T>

where Alpha<C, T>: ArrayCast<Array = [T; N]>,

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

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

impl<C, T, const N: usize> Blend for Alpha<C, T>

where C: Premultiply<Scalar = T> + StimulusColor + ArrayCast<Array = [T; N]> + Clone, T: Real + Zero + One + MinMax + Clamp + Sqrt + Abs + Arithmetics + PartialCmp + Clone, T::Mask: LazySelect<T>,

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

where C: Premultiply,

type Color = C

The base color type of Self.

fn blend_with<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.

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

where C: Clamp, T: Stimulus + Clamp,

fn clamp(self) -> Self

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

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

where C: ClampAssign, T: Stimulus + ClampAssign,

fn clamp_assign(&mut self)

Changes out-of-bounds 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.

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

Performs copy-assignment from source.

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

where C: Premultiply, PreAlpha<C>: Compose,

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.

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: Stimulus> 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<'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<T, C> Div<T> for Alpha<C, T>

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

where C: Div, T: Div,

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

where T: DivAssign + Clone, C: DivAssign<T>,

fn div_assign(&mut self, c: T)

Performs the /= operation.

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

where C: DivAssign, T: DivAssign,

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

Performs the /= operation.

impl<Tc, Ta, C, A> Extend<Alpha<Tc, Ta>> for Alpha<C, A>

where C: Extend<Tc>, A: Extend<Ta>,

fn extend<T: IntoIterator<Item = Alpha<Tc, Ta>>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

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

impl<T, V, const N: usize> From<[Alpha<Cam16Jmh<T>, T>; N]> for Alpha<Cam16Jmh<V>, V>

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

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

Converts to this type from the input type.

impl<C, T, const N: usize> From<[T; N]> for Alpha<C, T>

where Alpha<C, T>: ArrayCast<Array = [T; N]>,

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

Converts to this type from the input type.

impl<T, H: Into<Cam16Hue<T>>, A> From<(T, T, H, A)> for Alpha<Cam16Jmh<T>, A>

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

Converts to this type from the input type.

impl<T, A> From<Alpha<Cam16<T>, A>> for Alpha<Cam16Jmh<T>, A>

fn from(value: Alpha<Cam16<T>, A>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<C> From<PreAlpha<C>> for Alpha<C, C::Scalar>

where C: Premultiply,

fn from(color: PreAlpha<C>) -> Self

Converts to this type from the input type.

impl<C1: WithAlpha<T>, C2, T> 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<Tc, Ta, C, A> FromIterator<Alpha<Tc, Ta>> for Alpha<C, A>

where C: Extend<Tc> + FromIterator<Tc>, A: Extend<Ta> + Default,

fn from_iter<T: IntoIterator<Item = Alpha<Tc, Ta>>>(iter: T) -> Self

Creates a value from an iterator.

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) -> C::Hue

Calculate a hue if possible.

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

where C: HasBoolMask, T: HasBoolMask<Mask = C::Mask>,

type Mask = <C as HasBoolMask>::Mask

The mask type to use for selecting Self values.

impl<'a, T> IntoIterator for Alpha<Cam16Jmh<&'a [T]>, &'a [T]>

type Item = Alpha<Cam16Jmh<&'a T>, &'a T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for Alpha<Cam16Jmh<&'a mut [T]>, &'a mut [T]>

type Item = Alpha<Cam16Jmh<&'a mut T>, &'a mut T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T, const N: usize> IntoIterator for Alpha<Cam16Jmh<[T; N]>, [T; N]>

type Item = Alpha<Cam16Jmh<T>, T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for Alpha<Cam16Jmh<Vec<T>>, Vec<T>>

type Item = Alpha<Cam16Jmh<T>, T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

where C: IsWithinBounds, T: Stimulus + PartialCmp + IsWithinBounds<Mask = C::Mask>, C::Mask: BitAnd<Output = C::Mask>,

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

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

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

type Scalar = <C as Lighten>::Scalar

The type of the lighten modifier.

fn lighten(self, factor: C::Scalar) -> Self

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

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

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

type Scalar = <C as LightenAssign>::Scalar

The type of the lighten modifier.

fn lighten_assign(&mut self, factor: C::Scalar)

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: C::Scalar)

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

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

where C: Mix, C::Scalar: Zero + One + Clamp + Arithmetics + Clone,

type Scalar = <C as Mix>::Scalar

The type of the mixing factor.

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

Mix the color with an other color, by factor.

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

where C: MixAssign, C::Scalar: Zero + One + Clamp + Arithmetics + AddAssign + Clone,

type Scalar = <C as MixAssign>::Scalar

The type of the mixing factor.

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

Mix the color with an other color, by factor.

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

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

where C: Mul, T: Mul,

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

where T: MulAssign + Clone, C: MulAssign<T>,

fn mul_assign(&mut self, c: T)

Performs the *= operation.

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

where C: MulAssign, T: MulAssign,

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

Performs the *= operation.

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

where T: PartialEq, C: 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<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 RelativeEq::relative_eq.

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

type Scalar = <C as Saturate>::Scalar

The type of the saturation modifier.

fn saturate(self, factor: C::Scalar) -> Self

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

Increase the saturation by amount, a value ranging from 0.0 to 1.0.

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

type Scalar = <C as SaturateAssign>::Scalar

The type of the saturation modifier.

fn saturate_assign(&mut self, factor: C::Scalar)

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

fn saturate_fixed_assign(&mut self, amount: C::Scalar)

Increase the saturation by amount, a value ranging from 0.0 to 1.0.

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

where T: SaturatingAdd + Clone, C: SaturatingAdd<T>,

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

The resulting type.

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

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

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

where C: SaturatingAdd, T: SaturatingAdd,

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

The resulting type.

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

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

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

where T: SaturatingSub + Clone, C: SaturatingSub<T>,

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

The resulting type.

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

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

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

where C: SaturatingSub, T: SaturatingSub,

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

The resulting type.

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

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

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<C, T, H> SetHue<H> for Alpha<C, T>

where C: SetHue<H>,

fn set_hue(&mut self, hue: H)

Change the hue to a specific value.

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

where C: ShiftHue,

type Scalar = <C as ShiftHue>::Scalar

The type of the hue modifier.

fn shift_hue(self, amount: Self::Scalar) -> Self

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

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

where C: ShiftHueAssign,

type Scalar = <C as ShiftHueAssign>::Scalar

The type of the hue modifier.

fn shift_hue_assign(&mut self, amount: Self::Scalar)

Shifts the hue by amount.

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

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

where C: Sub, T: Sub,

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

where T: SubAssign + Clone, C: SubAssign<T>,

fn sub_assign(&mut self, c: T)

Performs the -= operation.

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

where C: SubAssign, T: SubAssign,

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

Performs the -= operation.

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

type Color = C

The opaque color type, without any transparency.

type WithAlpha = Alpha<C, 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<C, T, H> WithHue<H> for Alpha<C, T>

where C: WithHue<H>,

fn with_hue(self, hue: H) -> Self

Return a copy of self with a specific hue.

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

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

where T: Eq, C: Eq,