Struct palette::luma::Luma

source ·
#[repr(C)]
pub struct Luma<S = Srgb, T = f32> { pub luma: T, pub standard: PhantomData<S>, }
Expand description

Luminance.

Luma is a purely gray scale color space, which is included more for completeness than anything else, and represents how bright a color is perceived to be. It’s basically the Y component of CIE XYZ. The lack of any form of hue representation limits the set of operations that can be performed on it.

Fields§

§luma: T

The lightness of the color. 0.0 is black and 1.0 is white.

§standard: PhantomData<S>

The kind of RGB standard. sRGB is the default.

Implementations§

source§

impl<S, T> Luma<S, T>

source

pub const fn new(luma: T) -> Luma<S, T>

Create a luminance color.

source

pub fn into_format<U>(self) -> Luma<S, U>
where U: FromStimulus<T>,

Convert into another component type.

source

pub fn from_format<U>(color: Luma<S, U>) -> Self
where T: FromStimulus<U>,

Convert from another component type.

source

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

Convert to a (luma,) tuple.

source

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

Convert from a (luma,) tuple.

source§

impl<S, T> Luma<S, T>
where T: Stimulus,

source

pub fn min_luma() -> T

Return the luma value minimum.

source

pub fn max_luma() -> T

Return the luma value maximum.

source§

impl<S> Luma<S, u8>

source

pub fn into_u16<O>(self) -> u16
where O: ComponentOrder<Lumaa<S, u8>, u16>,

Convert to a packed u16 with with specifiable component order.

use palette::{luma, SrgbLuma};

let integer = SrgbLuma::new(96u8).into_u16::<luma::channels::La>();
assert_eq!(0x60FF, integer);

It’s also possible to use From and Into, which defaults to the 0xAALL component order:

use palette::SrgbLuma;

let integer = u16::from(SrgbLuma::new(96u8));
assert_eq!(0xFF60, integer);

See Packed for more details.

source

pub fn from_u16<O>(color: u16) -> Self
where O: ComponentOrder<Lumaa<S, u8>, u16>,

Convert from a packed u16 with specifiable component order.

use palette::{luma, SrgbLuma};

let luma = SrgbLuma::from_u16::<luma::channels::La>(0x60FF);
assert_eq!(SrgbLuma::new(96u8), luma);

It’s also possible to use From and Into, which defaults to the 0xAALL component order:

use palette::SrgbLuma;

let luma = SrgbLuma::from(0x60u16);
assert_eq!(SrgbLuma::new(96u8), luma);

See Packed for more details.

source§

impl<S, T> Luma<S, T>
where S: LumaStandard,

source

pub fn into_linear<U>(self) -> Luma<Linear<S::WhitePoint>, U>
where S::TransferFn: IntoLinear<U, T>,

Convert the color to linear luminance.

Some transfer functions allow the component type to be converted at the same time. This is usually offered with increased performance, compared to using into_format.

use palette::{SrgbLuma, LinLuma};

let linear: LinLuma<_, f32> = SrgbLuma::new(96u8).into_linear();

See the transfer function types in the encoding module for details and performance characteristics.

source

pub fn from_linear<U>(color: Luma<Linear<S::WhitePoint>, U>) -> Luma<S, T>
where S::TransferFn: FromLinear<U, T>,

Convert linear luminance to non-linear luminance.

Some transfer functions allow the component type to be converted at the same time. This is usually offered with increased performance, compared to using into_format.

use palette::{SrgbLuma, LinLuma};

let encoded = SrgbLuma::<u8>::from_linear(LinLuma::new(0.95f32));

See the transfer function types in the encoding module for details and performance characteristics.

source§

impl<Wp, T> Luma<Linear<Wp>, T>

source

pub fn into_encoding<U, St>(self) -> Luma<St, U>
where St: LumaStandard<WhitePoint = Wp>, St::TransferFn: FromLinear<T, U>,

Convert a linear color to a different encoding.

Some transfer functions allow the component type to be converted at the same time. This is usually offered with increased performance, compared to using into_format.

use palette::{SrgbLuma, LinLuma};

let encoded: SrgbLuma<u8> = LinLuma::new(0.95f32).into_encoding();

See the transfer function types in the encoding module for details and performance characteristics.

source

pub fn from_encoding<U, St>(color: Luma<St, U>) -> Self
where St: LumaStandard<WhitePoint = Wp>, St::TransferFn: IntoLinear<T, U>,

Convert from linear luminance from a different encoding.

Some transfer functions allow the component type to be converted at the same time. This is usually offered with increased performance, compared to using into_format.

use palette::{SrgbLuma, LinLuma};

let linear = LinLuma::<_, f32>::from_encoding(SrgbLuma::new(96u8));

See the transfer function types in the encoding module for details and performance characteristics.

source§

impl<S, T> Luma<S, &T>

source

pub fn copied(&self) -> Luma<S, T>
where T: Copy,

Get an owned, copied version of this color.

source

pub fn cloned(&self) -> Luma<S, T>
where T: Clone,

Get an owned, cloned version of this color.

source§

impl<S, T> Luma<S, &mut T>

source

pub fn set(&mut self, value: Luma<S, T>)

Update this color with new values.

source

pub fn as_refs(&self) -> Luma<S, &T>

Borrow this color’s components as shared references.

source

pub fn copied(&self) -> Luma<S, T>
where T: Copy,

Get an owned, copied version of this color.

source

pub fn cloned(&self) -> Luma<S, T>
where T: Clone,

Get an owned, cloned version of this color.

source§

impl<S, C> Luma<S, C>

source

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

Return an iterator over the colors in the wrapped collections.

source

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

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

source

pub fn get<'a, I, T>( &'a self, index: I ) -> Option<Luma<S, &<I as SliceIndex<[T]>>::Output>>
where T: 'a, C: AsRef<[T]>, I: SliceIndex<[T]> + Clone,

Get a color, or slice of colors, with references to the components at index. See slice::get for details.

source

pub fn get_mut<'a, I, T>( &'a mut self, index: I ) -> Option<Luma<S, &mut <I as SliceIndex<[T]>>::Output>>
where T: 'a, C: AsMut<[T]>, I: SliceIndex<[T]> + Clone,

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

source§

impl<S, T> Luma<S, Vec<T>>

source

pub fn with_capacity(capacity: usize) -> Self

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

source

pub fn push(&mut self, value: Luma<S, T>)

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

source

pub fn pop(&mut self) -> Option<Luma<S, T>>

Pop a color’s components from the component vectors. See Vec::pop for details.

source

pub fn clear(&mut self)

Clear the component vectors. See Vec::clear for details.

source

pub fn drain<R>(&mut self, range: R) -> Iter<Drain<'_, T>, S>
where R: RangeBounds<usize> + Clone,

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

Trait Implementations§

source§

impl<S, T> AbsDiffEq for Luma<S, T>
where T: AbsDiffEq,

§

type Epsilon = <T as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.
source§

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together. Read more
source§

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.
source§

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

The inverse of AbsDiffEq::abs_diff_eq.
source§

impl<S, T> Add<T> for Luma<S, T>
where T: Add<Output = T> + Clone,

§

type Output = Luma<S, T>

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl<S, T> Add for Luma<S, T>
where T: Add<Output = T>,

§

type Output = Luma<S, T>

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl<S, T> AddAssign<T> for Luma<S, T>
where T: AddAssign + Clone,

source§

fn add_assign(&mut self, c: T)

Performs the += operation. Read more
source§

impl<S, T> AddAssign for Luma<S, T>
where T: AddAssign,

source§

fn add_assign(&mut self, other: Self)

Performs the += operation. Read more
source§

impl<S, T> ArrayCast for Luma<S, T>

§

type Array = [T; 1]

The output type of a cast to an array.
source§

impl<S, T> AsMut<[T]> for Luma<S, T>

source§

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

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

impl<S, T> AsMut<[T; 1]> for Luma<S, T>

source§

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

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

impl<S> AsMut<Luma<S>> for f32

source§

fn as_mut(&mut self) -> &mut Luma<S, f32>

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

impl<S, T> AsMut<Luma<S, T>> for [T; 1]

source§

fn as_mut(&mut self) -> &mut Luma<S, T>

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

impl<S> AsMut<Luma<S, f64>> for f64

source§

fn as_mut(&mut self) -> &mut Luma<S, f64>

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

impl<S> AsMut<Luma<S, u128>> for u128

source§

fn as_mut(&mut self) -> &mut Luma<S, u128>

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

impl<S> AsMut<Luma<S, u16>> for u16

source§

fn as_mut(&mut self) -> &mut Luma<S, u16>

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

impl<S> AsMut<Luma<S, u32>> for u32

source§

fn as_mut(&mut self) -> &mut Luma<S, u32>

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

impl<S> AsMut<Luma<S, u64>> for u64

source§

fn as_mut(&mut self) -> &mut Luma<S, u64>

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

impl<S> AsMut<Luma<S, u8>> for u8

source§

fn as_mut(&mut self) -> &mut Luma<S, u8>

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

impl<S, T> AsMut<T> for Luma<S, T>

source§

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

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

impl<S, T> AsRef<[T]> for Luma<S, T>

source§

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

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

impl<S, T> AsRef<[T; 1]> for Luma<S, T>

source§

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

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

impl<S> AsRef<Luma<S>> for f32

source§

fn as_ref(&self) -> &Luma<S, f32>

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

impl<S, T> AsRef<Luma<S, T>> for [T; 1]

source§

fn as_ref(&self) -> &Luma<S, T>

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

impl<S> AsRef<Luma<S, f64>> for f64

source§

fn as_ref(&self) -> &Luma<S, f64>

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

impl<S> AsRef<Luma<S, u128>> for u128

source§

fn as_ref(&self) -> &Luma<S, u128>

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

impl<S> AsRef<Luma<S, u16>> for u16

source§

fn as_ref(&self) -> &Luma<S, u16>

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

impl<S> AsRef<Luma<S, u32>> for u32

source§

fn as_ref(&self) -> &Luma<S, u32>

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

impl<S> AsRef<Luma<S, u64>> for u64

source§

fn as_ref(&self) -> &Luma<S, u64>

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

impl<S> AsRef<Luma<S, u8>> for u8

source§

fn as_ref(&self) -> &Luma<S, u8>

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

impl<S, T> AsRef<T> for Luma<S, T>

source§

fn as_ref(&self) -> &T

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

impl<S, T> Clamp for Luma<S, T>
where T: Clamp + Stimulus,

source§

fn clamp(self) -> Self

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

impl<S, T> ClampAssign for Luma<S, T>
where T: ClampAssign + Stimulus,

source§

fn clamp_assign(&mut self)

Changes out-of-bounds components to the nearest valid values. Read more
source§

impl<S, T> Clone for Luma<S, T>
where T: Clone,

source§

fn clone(&self) -> Luma<S, T>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<S: Debug, T: Debug> Debug for Luma<S, T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<S, T> Default for Luma<S, T>
where T: Stimulus,

source§

fn default() -> Luma<S, T>

Returns the “default value” for a type. Read more
source§

impl<'de, S, T> Deserialize<'de> for Luma<S, T>
where T: Deserialize<'de>,

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl<S, T> Distribution<Luma<S, T>> for Standard

source§

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Luma<S, T>

Generate a random value of T, using rng as the source of randomness.
source§

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>
where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness. Read more
source§

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>
where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F Read more
source§

impl<S, T> Div<T> for Luma<S, T>
where T: Div<Output = T> + Clone,

§

type Output = Luma<S, T>

The resulting type after applying the / operator.
source§

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

Performs the / operation. Read more
source§

impl<S, T> Div for Luma<S, T>
where T: Div<Output = T>,

§

type Output = Luma<S, T>

The resulting type after applying the / operator.
source§

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

Performs the / operation. Read more
source§

impl<S, T> DivAssign<T> for Luma<S, T>
where T: DivAssign + Clone,

source§

fn div_assign(&mut self, c: T)

Performs the /= operation. Read more
source§

impl<S, T> DivAssign for Luma<S, T>
where T: DivAssign,

source§

fn div_assign(&mut self, other: Self)

Performs the /= operation. Read more
source§

impl<S, T> EuclideanDistance for Luma<S, T>
where T: Real + Sub<T, Output = T> + Add<T, Output = T> + Mul<T, Output = T> + Clone,

§

type Scalar = T

The type for the distance value.
source§

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

Calculate the squared Euclidean distance from self to other. Read more
source§

impl<S, T, C> Extend<Luma<S, T>> for Luma<S, C>
where C: Extend<T>,

source§

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

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

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. Read more
source§

impl<'a, S, T> From<&'a [T; 1]> for &'a Luma<S, T>

source§

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

Converts to this type from the input type.
source§

impl<'a, S> From<&'a Luma<S>> for &'a f32

source§

fn from(color: &'a Luma<S, f32>) -> Self

Converts to this type from the input type.
source§

impl<'a, S, T> From<&'a Luma<S, T>> for &'a [T]

source§

fn from(color: &'a Luma<S, T>) -> Self

Converts to this type from the input type.
source§

impl<'a, S, T> From<&'a Luma<S, T>> for &'a [T; 1]

source§

fn from(color: &'a Luma<S, T>) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a Luma<S, f64>> for &'a f64

source§

fn from(color: &'a Luma<S, f64>) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a Luma<S, u128>> for &'a u128

source§

fn from(color: &'a Luma<S, u128>) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a Luma<S, u16>> for &'a u16

source§

fn from(color: &'a Luma<S, u16>) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a Luma<S, u32>> for &'a u32

source§

fn from(color: &'a Luma<S, u32>) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a Luma<S, u64>> for &'a u64

source§

fn from(color: &'a Luma<S, u64>) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a Luma<S, u8>> for &'a u8

source§

fn from(color: &'a Luma<S, u8>) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a f32> for &'a Luma<S, f32>
where f32: AsRef<Luma<S, f32>>,

source§

fn from(luma: &'a f32) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a f64> for &'a Luma<S, f64>
where f64: AsRef<Luma<S, f64>>,

source§

fn from(luma: &'a f64) -> Self

Converts to this type from the input type.
source§

impl<'a, S, T> From<&'a mut [T; 1]> for &'a mut Luma<S, T>

source§

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

Converts to this type from the input type.
source§

impl<'a, S> From<&'a mut Luma<S>> for &'a mut f32

source§

fn from(color: &'a mut Luma<S, f32>) -> Self

Converts to this type from the input type.
source§

impl<'a, S, T> From<&'a mut Luma<S, T>> for &'a mut [T]

source§

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

Converts to this type from the input type.
source§

impl<'a, S, T> From<&'a mut Luma<S, T>> for &'a mut [T; 1]

source§

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

Converts to this type from the input type.
source§

impl<'a, S> From<&'a mut Luma<S, f64>> for &'a mut f64

source§

fn from(color: &'a mut Luma<S, f64>) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a mut Luma<S, u128>> for &'a mut u128

source§

fn from(color: &'a mut Luma<S, u128>) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a mut Luma<S, u16>> for &'a mut u16

source§

fn from(color: &'a mut Luma<S, u16>) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a mut Luma<S, u32>> for &'a mut u32

source§

fn from(color: &'a mut Luma<S, u32>) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a mut Luma<S, u64>> for &'a mut u64

source§

fn from(color: &'a mut Luma<S, u64>) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a mut Luma<S, u8>> for &'a mut u8

source§

fn from(color: &'a mut Luma<S, u8>) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a mut f32> for &'a mut Luma<S, f32>
where f32: AsMut<Luma<S, f32>>,

source§

fn from(luma: &'a mut f32) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a mut f64> for &'a mut Luma<S, f64>
where f64: AsMut<Luma<S, f64>>,

source§

fn from(luma: &'a mut f64) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a mut u128> for &'a mut Luma<S, u128>
where u128: AsMut<Luma<S, u128>>,

source§

fn from(luma: &'a mut u128) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a mut u16> for &'a mut Luma<S, u16>
where u16: AsMut<Luma<S, u16>>,

source§

fn from(luma: &'a mut u16) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a mut u32> for &'a mut Luma<S, u32>
where u32: AsMut<Luma<S, u32>>,

source§

fn from(luma: &'a mut u32) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a mut u64> for &'a mut Luma<S, u64>
where u64: AsMut<Luma<S, u64>>,

source§

fn from(luma: &'a mut u64) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a mut u8> for &'a mut Luma<S, u8>
where u8: AsMut<Luma<S, u8>>,

source§

fn from(luma: &'a mut u8) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a u128> for &'a Luma<S, u128>
where u128: AsRef<Luma<S, u128>>,

source§

fn from(luma: &'a u128) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a u16> for &'a Luma<S, u16>
where u16: AsRef<Luma<S, u16>>,

source§

fn from(luma: &'a u16) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a u32> for &'a Luma<S, u32>
where u32: AsRef<Luma<S, u32>>,

source§

fn from(luma: &'a u32) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a u64> for &'a Luma<S, u64>
where u64: AsRef<Luma<S, u64>>,

source§

fn from(luma: &'a u64) -> Self

Converts to this type from the input type.
source§

impl<'a, S> From<&'a u8> for &'a Luma<S, u8>
where u8: AsRef<Luma<S, u8>>,

source§

fn from(luma: &'a u8) -> Self

Converts to this type from the input type.
source§

impl<S, T, V, const N: usize> From<[Luma<S, T>; N]> for Luma<S, V>
where [T; N]: Default, V: FromScalarArray<N, Scalar = T>,

source§

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

Converts to this type from the input type.
source§

impl<S, T> From<[T; 1]> for Luma<S, T>

source§

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

Converts to this type from the input type.
source§

impl<S, T> From<(T,)> for Luma<S, T>

source§

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

Converts to this type from the input type.
source§

impl<S, T> From<Box<[T; 1]>> for Box<Luma<S, T>>

source§

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

Converts to this type from the input type.
source§

impl<S> From<Luma<S>> for f32

source§

fn from(color: Luma<S, f32>) -> Self

Converts to this type from the input type.
source§

impl<S, T> From<Luma<S, T>> for [T; 1]

source§

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

Converts to this type from the input type.
source§

impl<S, T> From<Luma<S, T>> for (T,)

source§

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

Converts to this type from the input type.
source§

impl<S, T, P, O> From<Luma<S, T>> for Packed<O, P>
where O: ComponentOrder<Lumaa<S, T>, P>, Lumaa<S, T>: From<Luma<S, T>>,

source§

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

Converts to this type from the input type.
source§

impl<S, T, V, const N: usize> From<Luma<S, V>> for [Luma<S, T>; N]
where Self: Default, V: IntoScalarArray<N, Scalar = T>,

source§

fn from(color: Luma<S, V>) -> Self

Converts to this type from the input type.
source§

impl<S> From<Luma<S, f64>> for f64

source§

fn from(color: Luma<S, f64>) -> Self

Converts to this type from the input type.
source§

impl<S> From<Luma<S, u128>> for u128

source§

fn from(color: Luma<S, u128>) -> Self

Converts to this type from the input type.
source§

impl<S> From<Luma<S, u16>> for u16

source§

fn from(color: Luma<S, u16>) -> Self

Converts to this type from the input type.
source§

impl<S> From<Luma<S, u32>> for u32

source§

fn from(color: Luma<S, u32>) -> Self

Converts to this type from the input type.
source§

impl<S> From<Luma<S, u64>> for u64

source§

fn from(color: Luma<S, u64>) -> Self

Converts to this type from the input type.
source§

impl<S> From<Luma<S, u8>> for u16

source§

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

Converts to this type from the input type.
source§

impl<S> From<Luma<S, u8>> for u8

source§

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

Converts to this type from the input type.
source§

impl<S, O, P> From<Packed<O, P>> for Luma<S, u8>
where O: ComponentOrder<Lumaa<S, u8>, P>,

source§

fn from(packed: Packed<O, P>) -> Self

Converts to this type from the input type.
source§

impl<S, T> From<PreAlpha<Luma<S, T>>> for Luma<S, T>
where Self: Premultiply<Scalar = T>,

source§

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

Converts to this type from the input type.
source§

impl<S, T> From<T> for Luma<S, T>

source§

fn from(luma: T) -> Self

Converts to this type from the input type.
source§

impl<S> From<u16> for Luma<S, u8>

source§

fn from(color: u16) -> Self

Converts to this type from the input type.
source§

impl<S, T, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Luma<S, T>
where _C: IntoColorUnclamped<Self>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<S, T, _S> FromColorUnclamped<Hsl<_S, T>> for Luma<S, T>
where _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = <S as LumaStandard>::WhitePoint>, S: LumaStandard, Xyz<<S as LumaStandard>::WhitePoint, T>: FromColorUnclamped<Hsl<_S, T>> + IntoColorUnclamped<Self>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

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

source§

fn from_color_unclamped( color: Hsluv<<S as LumaStandard>::WhitePoint, T> ) -> Self

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<S, T, _S> FromColorUnclamped<Hsv<_S, T>> for Luma<S, T>
where _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = <S as LumaStandard>::WhitePoint>, S: LumaStandard, Xyz<<S as LumaStandard>::WhitePoint, T>: FromColorUnclamped<Hsv<_S, T>> + IntoColorUnclamped<Self>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<S, T, _S> FromColorUnclamped<Hwb<_S, T>> for Luma<S, T>
where _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = <S as LumaStandard>::WhitePoint>, S: LumaStandard, Xyz<<S as LumaStandard>::WhitePoint, T>: FromColorUnclamped<Hwb<_S, T>> + IntoColorUnclamped<Self>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

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

source§

fn from_color_unclamped(color: Lab<<S as LumaStandard>::WhitePoint, T>) -> Self

Convert from T. The resulting color might be invalid in its color space. Read more
source§

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

source§

fn from_color_unclamped(color: Lch<<S as LumaStandard>::WhitePoint, T>) -> Self

Convert from T. The resulting color might be invalid in its color space. Read more
source§

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

source§

fn from_color_unclamped( color: Lchuv<<S as LumaStandard>::WhitePoint, T> ) -> Self

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<Wp, T, S> FromColorUnclamped<Luma<S, T>> for Xyz<Wp, T>
where Self: Mul<T, Output = Self>, Wp: WhitePoint<T>, S: LumaStandard<WhitePoint = Wp>, S::TransferFn: IntoLinear<T, T>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<T, S> FromColorUnclamped<Luma<S, T>> for Yxy<S::WhitePoint, T>
where S: LumaStandard, S::TransferFn: IntoLinear<T, T>, Self: Default,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<S1, S2, T> FromColorUnclamped<Luma<S2, T>> for Luma<S1, T>
where S1: LumaStandard + 'static, S2: LumaStandard<WhitePoint = S1::WhitePoint> + 'static, S1::TransferFn: FromLinear<T, T>, S2::TransferFn: IntoLinear<T, T>,

source§

fn from_color_unclamped(color: Luma<S2, T>) -> Self

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<S, St, T> FromColorUnclamped<Luma<St, T>> for Rgb<S, T>
where S: RgbStandard + 'static, St: LumaStandard<WhitePoint = <S::Space as RgbSpace>::WhitePoint> + 'static, S::TransferFn: FromLinear<T, T>, St::TransferFn: IntoLinear<T, T>, T: Clone,

source§

fn from_color_unclamped(color: Luma<St, T>) -> Self

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<S, T, _S> FromColorUnclamped<Luma<_S, T>> for Hsl<S, T>
where _S: LumaStandard<WhitePoint = <<S as RgbStandard>::Space as RgbSpace>::WhitePoint>, S: RgbStandard, Rgb<S, T>: FromColorUnclamped<Luma<_S, T>> + IntoColorUnclamped<Self>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<Wp, T, _S> FromColorUnclamped<Luma<_S, T>> for Hsluv<Wp, T>
where _S: LumaStandard<WhitePoint = Wp>, Wp: WhitePoint<T>, Lchuv<Wp, T>: FromColorUnclamped<Luma<_S, T>> + IntoColorUnclamped<Self>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<S, T, _S> FromColorUnclamped<Luma<_S, T>> for Hsv<S, T>
where _S: LumaStandard<WhitePoint = <<S as RgbStandard>::Space as RgbSpace>::WhitePoint>, S: RgbStandard, Rgb<S, T>: FromColorUnclamped<Luma<_S, T>> + IntoColorUnclamped<Self>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<S, T, _S> FromColorUnclamped<Luma<_S, T>> for Hwb<S, T>
where _S: LumaStandard<WhitePoint = <<S as RgbStandard>::Space as RgbSpace>::WhitePoint>, S: RgbStandard, Hsv<S, T>: FromColorUnclamped<Luma<_S, T>> + IntoColorUnclamped<Self>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<Wp, T, _S> FromColorUnclamped<Luma<_S, T>> for Lab<Wp, T>
where _S: LumaStandard<WhitePoint = Wp>, Wp: WhitePoint<T>, Xyz<Wp, T>: FromColorUnclamped<Luma<_S, T>> + IntoColorUnclamped<Self>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<Wp, T, _S> FromColorUnclamped<Luma<_S, T>> for Lch<Wp, T>
where _S: LumaStandard<WhitePoint = Wp>, Wp: WhitePoint<T>, Lab<Wp, T>: FromColorUnclamped<Luma<_S, T>> + IntoColorUnclamped<Self>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<Wp, T, _S> FromColorUnclamped<Luma<_S, T>> for Lchuv<Wp, T>
where _S: LumaStandard<WhitePoint = Wp>, Wp: WhitePoint<T>, Luv<Wp, T>: FromColorUnclamped<Luma<_S, T>> + IntoColorUnclamped<Self>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<Wp, T, _S> FromColorUnclamped<Luma<_S, T>> for Luv<Wp, T>
where _S: LumaStandard<WhitePoint = Wp>, Wp: WhitePoint<T>, Xyz<Wp, T>: FromColorUnclamped<Luma<_S, T>> + IntoColorUnclamped<Self>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<T, _S> FromColorUnclamped<Luma<_S, T>> for Okhsl<T>
where _S: LumaStandard<WhitePoint = D65>, D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Luma<_S, T>> + IntoColorUnclamped<Self>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<T, _S> FromColorUnclamped<Luma<_S, T>> for Okhsv<T>
where _S: LumaStandard<WhitePoint = D65>, D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Luma<_S, T>> + IntoColorUnclamped<Self>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<T, _S> FromColorUnclamped<Luma<_S, T>> for Okhwb<T>
where _S: LumaStandard<WhitePoint = D65>, D65: WhitePoint<T>, Okhsv<T>: FromColorUnclamped<Luma<_S, T>> + IntoColorUnclamped<Self>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<T, _S> FromColorUnclamped<Luma<_S, T>> for Oklab<T>
where _S: LumaStandard<WhitePoint = D65>, D65: WhitePoint<T>, Xyz<D65, T>: FromColorUnclamped<Luma<_S, T>> + IntoColorUnclamped<Self>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<T, _S> FromColorUnclamped<Luma<_S, T>> for Oklch<T>
where _S: LumaStandard<WhitePoint = D65>, D65: WhitePoint<T>, Oklab<T>: FromColorUnclamped<Luma<_S, T>> + IntoColorUnclamped<Self>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

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

source§

fn from_color_unclamped(color: Luv<<S as LumaStandard>::WhitePoint, T>) -> Self

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<S, T> FromColorUnclamped<Okhsl<T>> for Luma<S, T>

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<S, T> FromColorUnclamped<Okhsv<T>> for Luma<S, T>

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<S, T> FromColorUnclamped<Okhwb<T>> for Luma<S, T>

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<S, T> FromColorUnclamped<Oklab<T>> for Luma<S, T>

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<S, T> FromColorUnclamped<Oklch<T>> for Luma<S, T>

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<S, T, _S> FromColorUnclamped<Rgb<_S, T>> for Luma<S, T>
where _S: RgbStandard, _S::Space: RgbSpace<WhitePoint = <S as LumaStandard>::WhitePoint>, S: LumaStandard, Xyz<<S as LumaStandard>::WhitePoint, T>: FromColorUnclamped<Rgb<_S, T>> + IntoColorUnclamped<Self>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<S, T> FromColorUnclamped<Xyz<<S as LumaStandard>::WhitePoint, T>> for Luma<S, T>
where S: LumaStandard, S::TransferFn: FromLinear<T, T>,

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

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

source§

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

Convert from T. The resulting color might be invalid in its color space. Read more
source§

impl<S, T, C> FromIterator<Luma<S, T>> for Luma<S, C>
where Self: Extend<Luma<S, T>>, C: Default,

source§

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

Creates a value from an iterator. Read more
source§

impl<S, T> HasBoolMask for Luma<S, T>
where T: HasBoolMask,

§

type Mask = <T as HasBoolMask>::Mask

The mask type to use for selecting Self values.
source§

impl<'a, 'b, S, T> IntoIterator for &'a Luma<S, &'b [T]>

§

type Item = Luma<S, &'a T>

The type of the elements being iterated over.
§

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

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<'a, 'b, S, T> IntoIterator for &'a Luma<S, &'b mut [T]>

§

type Item = Luma<S, &'a T>

The type of the elements being iterated over.
§

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

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

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

§

type Item = Luma<S, &'a T>

The type of the elements being iterated over.
§

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

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<'a, S, T> IntoIterator for &'a Luma<S, Box<[T]>>

§

type Item = Luma<S, &'a T>

The type of the elements being iterated over.
§

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

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<'a, S, T> IntoIterator for &'a Luma<S, Vec<T>>

§

type Item = Luma<S, &'a T>

The type of the elements being iterated over.
§

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

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<'a, 'b, S, T> IntoIterator for &'a mut Luma<S, &'b mut [T]>

§

type Item = Luma<S, &'a mut T>

The type of the elements being iterated over.
§

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

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

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

§

type Item = Luma<S, &'a mut T>

The type of the elements being iterated over.
§

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

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<'a, S, T> IntoIterator for &'a mut Luma<S, Box<[T]>>
where T: 'a,

§

type Item = Luma<S, &'a mut T>

The type of the elements being iterated over.
§

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

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<'a, S, T> IntoIterator for &'a mut Luma<S, Vec<T>>

§

type Item = Luma<S, &'a mut T>

The type of the elements being iterated over.
§

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

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<'a, S, T> IntoIterator for Luma<S, &'a [T]>

§

type Item = Luma<S, &'a T>

The type of the elements being iterated over.
§

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

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<'a, S, T> IntoIterator for Luma<S, &'a mut [T]>

§

type Item = Luma<S, &'a mut T>

The type of the elements being iterated over.
§

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

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<S, T, const N: usize> IntoIterator for Luma<S, [T; N]>

§

type Item = Luma<S, T>

The type of the elements being iterated over.
§

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

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<S, T> IntoIterator for Luma<S, Vec<T>>

§

type Item = Luma<S, T>

The type of the elements being iterated over.
§

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

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<S, T> IsWithinBounds for Luma<S, T>
where T: PartialCmp + Stimulus, T::Mask: BitAnd<Output = T::Mask>,

source§

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

Check if the color’s components are within the expected range bounds. Read more
source§

impl<S, T> Lighten for Luma<S, T>

§

type Scalar = T

The type of the lighten modifier.
source§

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

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

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

Lighten the color by amount, a value ranging from 0.0 to 1.0. Read more
source§

impl<S, T> LightenAssign for Luma<S, T>

§

type Scalar = T

The type of the lighten modifier.
source§

fn lighten_assign(&mut self, factor: T)

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

fn lighten_fixed_assign(&mut self, amount: T)

Lighten the color by amount, a value ranging from 0.0 to 1.0. Read more
source§

impl<S, T> LowerHex for Luma<S, T>
where T: LowerHex,

source§

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

Formats the value using the given formatter.
source§

impl<S, T> Mix for Luma<S, T>
where T: Real + Zero + One + Arithmetics + Clamp + Clone,

§

type Scalar = T

The type of the mixing factor.
source§

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

Mix the color with an other color, by factor. Read more
source§

impl<S, T> MixAssign for Luma<S, T>
where T: Real + Zero + One + AddAssign + Arithmetics + Clamp + Clone,

§

type Scalar = T

The type of the mixing factor.
source§

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

Mix the color with an other color, by factor. Read more
source§

impl<S, T> Mul<T> for Luma<S, T>
where T: Mul<Output = T> + Clone,

§

type Output = Luma<S, T>

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl<S, T> Mul for Luma<S, T>
where T: Mul<Output = T>,

§

type Output = Luma<S, T>

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl<S, T> MulAssign<T> for Luma<S, T>
where T: MulAssign + Clone,

source§

fn mul_assign(&mut self, c: T)

Performs the *= operation. Read more
source§

impl<S, T> MulAssign for Luma<S, T>
where T: MulAssign,

source§

fn mul_assign(&mut self, other: Self)

Performs the *= operation. Read more
source§

impl<S, T> PartialEq for Luma<S, T>
where T: PartialEq,

source§

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

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

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.
source§

impl<S, T> Premultiply for Luma<S, T>
where T: Real + Stimulus + Zero + IsValidDivisor + Mul<T, Output = T> + Div<T, Output = T> + Clone, T::Mask: LazySelect<T> + Clone,

§

type Scalar = T

The color’s component type.
source§

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

Alpha mask the color. Read more
source§

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

Alpha unmask the color, resulting in a color and transparency pair. Read more
source§

impl<S, T> RelativeContrast for Luma<S, T>

§

type Scalar = T

👎Deprecated since 0.7.2: replaced by palette::color_difference::Wcag21RelativeContrast
The type of the contrast ratio.
source§

fn get_contrast_ratio(self, other: Self) -> T

👎Deprecated since 0.7.2: replaced by palette::color_difference::Wcag21RelativeContrast
Calculate the contrast ratio between two colors.
source§

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

👎Deprecated since 0.7.2: replaced by palette::color_difference::Wcag21RelativeContrast
Verify the contrast between two colors satisfies SC 1.4.3. Contrast is at least 4.5:1 (Level AA).
source§

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

👎Deprecated since 0.7.2: replaced by palette::color_difference::Wcag21RelativeContrast
Verify the contrast between two colors satisfies SC 1.4.3 for large text. Contrast is at least 3:1 (Level AA).
source§

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

👎Deprecated since 0.7.2: replaced by palette::color_difference::Wcag21RelativeContrast
Verify the contrast between two colors satisfies SC 1.4.6. Contrast is at least 7:1 (Level AAA).
source§

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

👎Deprecated since 0.7.2: replaced by palette::color_difference::Wcag21RelativeContrast
Verify the contrast between two colors satisfies SC 1.4.6 for large text. Contrast is at least 4.5:1 (Level AAA).
source§

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

👎Deprecated since 0.7.2: replaced by palette::color_difference::Wcag21RelativeContrast
Verify the contrast between two colors satisfies SC 1.4.11 for graphical objects. Contrast is at least 3:1 (Level AA).
source§

impl<S, T> RelativeEq for Luma<S, T>
where T: RelativeEq,

source§

fn default_max_relative() -> T::Epsilon

The default relative tolerance for testing values that are far-apart. Read more
source§

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

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

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

The inverse of RelativeEq::relative_eq.
source§

impl<S, T> SampleUniform for Luma<S, T>
where T: SampleUniform + Clone,

§

type Sampler = UniformLuma<S, T>

The UniformSampler implementation supporting type X.
source§

impl<S, T> SaturatingAdd<T> for Luma<S, T>
where T: SaturatingAdd<Output = T> + Clone,

§

type Output = Luma<S, T>

The resulting type.
source§

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

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

impl<S, T> SaturatingAdd for Luma<S, T>
where T: SaturatingAdd<Output = T>,

§

type Output = Luma<S, T>

The resulting type.
source§

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

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

impl<S, T> SaturatingSub<T> for Luma<S, T>
where T: SaturatingSub<Output = T> + Clone,

§

type Output = Luma<S, T>

The resulting type.
source§

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

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

impl<S, T> SaturatingSub for Luma<S, T>
where T: SaturatingSub<Output = T>,

§

type Output = Luma<S, T>

The resulting type.
source§

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

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

impl<S, T> Serialize for Luma<S, T>
where T: Serialize,

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl<S, T> Sub<T> for Luma<S, T>
where T: Sub<Output = T> + Clone,

§

type Output = Luma<S, T>

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl<S, T> Sub for Luma<S, T>
where T: Sub<Output = T>,

§

type Output = Luma<S, T>

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl<S, T> SubAssign<T> for Luma<S, T>
where T: SubAssign + Clone,

source§

fn sub_assign(&mut self, c: T)

Performs the -= operation. Read more
source§

impl<S, T> SubAssign for Luma<S, T>
where T: SubAssign,

source§

fn sub_assign(&mut self, other: Self)

Performs the -= operation. Read more
source§

impl<'a, S, T> TryFrom<&'a [T]> for &'a Luma<S, T>

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<'a, S, T> TryFrom<&'a mut [T]> for &'a mut Luma<S, T>

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<S> UintCast for Luma<S, u128>

§

type Uint = u128

An unsigned integer with the same size as Self.
source§

impl<S> UintCast for Luma<S, u16>

§

type Uint = u16

An unsigned integer with the same size as Self.
source§

impl<S> UintCast for Luma<S, u32>

§

type Uint = u32

An unsigned integer with the same size as Self.
source§

impl<S> UintCast for Luma<S, u64>

§

type Uint = u64

An unsigned integer with the same size as Self.
source§

impl<S> UintCast for Luma<S, u8>

§

type Uint = u8

An unsigned integer with the same size as Self.
source§

impl<S, T> UlpsEq for Luma<S, T>
where T: UlpsEq,

source§

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart. Read more
source§

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

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

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

The inverse of UlpsEq::ulps_eq.
source§

impl<S, T> UpperHex for Luma<S, T>
where T: UpperHex,

source§

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

Formats the value using the given formatter.
source§

impl<S, T> Wcag21RelativeContrast for Luma<S, T>
where Self: IntoColor<Luma<Linear<D65>, T>>, S: LumaStandard<WhitePoint = D65>, T: Real + Add<T, Output = T> + Div<T, Output = T> + PartialCmp + MinMax,

§

type Scalar = T

The scalar type used for luminance and contrast.
source§

fn relative_luminance(self) -> Luma<Linear<D65>, Self::Scalar>

Returns the WCAG 2.1 relative luminance of self. Read more
source§

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

Returns the WCAG 2.1 relative luminance contrast between self and other. Read more
source§

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

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

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

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

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

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

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

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

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

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

impl<S, T, _A> WithAlpha<_A> for Luma<S, T>
where _A: Stimulus,

§

type Color = Luma<S, T>

The opaque color type, without any transparency. Read more
§

type WithAlpha = Alpha<Luma<S, T>, _A>

The color type with transparency applied. Read more
source§

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. Read more
source§

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. Read more
source§

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

Splits the color into separate color and transparency values. Read more
source§

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. Read more
source§

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. Read more
source§

impl<S, T> Zeroable for Luma<S, T>
where T: Zeroable,

source§

fn zeroed() -> Self

source§

impl<S, T> Copy for Luma<S, T>
where T: Copy,

source§

impl<S, T> Eq for Luma<S, T>
where T: Eq,

source§

impl<S: 'static, T> Pod for Luma<S, T>
where T: Pod,

source§

impl<S, T> StimulusColor for Luma<S, T>
where T: Stimulus,

Auto Trait Implementations§

§

impl<S, T> Freeze for Luma<S, T>
where T: Freeze,

§

impl<S, T> RefUnwindSafe for Luma<S, T>

§

impl<S, T> Send for Luma<S, T>
where T: Send, S: Send,

§

impl<S, T> Sync for Luma<S, T>
where T: Sync, S: Sync,

§

impl<S, T> Unpin for Luma<S, T>
where T: Unpin, S: Unpin,

§

impl<S, T> UnwindSafe for Luma<S, T>
where T: UnwindSafe, S: UnwindSafe,

Blanket Implementations§

source§

impl<S, D, Swp, Dwp, T> AdaptFrom<S, Swp, Dwp, T> for D
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, S: IntoColorUnclamped<Xyz<Swp, T>>, D: FromColorUnclamped<Xyz<Dwp, T>>,

source§

fn adapt_from_using<M>(color: S, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
source§

fn adapt_from(color: S) -> Self

Convert the source color to the destination color using the bradford method by default.
source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
source§

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
source§

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

source§

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

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

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

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

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

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

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

Return the darkest parts of self and other.
source§

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

Return the lightest parts of self and other.
source§

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

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

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

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

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

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.
source§

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

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.
source§

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

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

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

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

impl<C> BlendWith for C

§

type Color = C

The base color type of Self.
source§

fn blend_with<F>(self, other: C, blend_function: F) -> C
where F: BlendFunction<<C as BlendWith>::Color>,

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

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

§

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
source§

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar> ) -> T

Converts self into C, using the provided parameters.
source§

impl<T> CheckedBitPattern for T
where T: AnyBitPattern,

§

type Bits = T

Self must have the same layout as the specified Bits except for the possible invalid bit patterns being checked during is_valid_bit_pattern.
source§

fn is_valid_bit_pattern(_bits: &T) -> bool

If this function returns true, then it must be valid to reinterpret bits as &Self.
source§

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
source§

impl<C> Compose for C

source§

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

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

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

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

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

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

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

Place self over only the visible parts of other.
source§

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

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

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

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

impl<T> From<!> for T

source§

fn from(t: !) -> T

Converts to this type from the input type.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromAngle<T> for T

source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
source§

impl<T, U> FromColor<T> for U
where U: FromColorUnclamped<T> + Clamp,

source§

fn from_color(t: T) -> U

Convert from T with values clamped to the color defined bounds. Read more
source§

impl<T, U> FromColorMut<U> for T
where T: FromColor<U> + ArrayCast + Clone, U: FromColor<T> + ArrayCast<Array = <T as ArrayCast>::Array> + Clone,

source§

fn from_color_mut(color: &mut U) -> FromColorMutGuard<'_, T, U>

Temporarily convert from another color type in place. Read more
source§

impl<T, U> FromColorUnclampedMut<U> for T
where T: FromColorUnclamped<U> + ArrayCast + Clone, U: FromColorUnclamped<T> + ArrayCast<Array = <T as ArrayCast>::Array> + Clone,

source§

fn from_color_unclamped_mut( color: &mut U ) -> FromColorUnclampedMutGuard<'_, T, U>

Temporarily convert from another color type in place, without clamping. Read more
source§

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> IntoAngle<U> for T
where U: FromAngle<T>,

source§

fn into_angle(self) -> U

Performs a conversion into T.
source§

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

§

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
source§

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar> ) -> T

Converts self into C, using the provided parameters.
source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
source§

impl<T, U> IntoColorMut<T> for U
where T: FromColorMut<U> + ?Sized, U: FromColorMut<T> + ?Sized,

source§

fn into_color_mut(&mut self) -> FromColorMutGuard<'_, T, U>

Temporarily convert to another color type in place. Read more
source§

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
source§

impl<T, U> IntoColorUnclampedMut<T> for U

source§

fn into_color_unclamped_mut(&mut self) -> FromColorUnclampedMutGuard<'_, T, U>

Temporarily convert to another color type in place, without clamping. Read more
source§

impl<T> IntoStimulus<T> for T

source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
source§

impl<Borrowed> SampleBorrow<Borrowed> for Borrowed
where Borrowed: SampleUniform,

source§

fn borrow(&self) -> &Borrowed

Immutably borrows from an owned value. See Borrow::borrow
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryFromColor<T> for U
where U: FromColorUnclamped<T> + IsWithinBounds<Mask = bool>,

source§

fn try_from_color(t: T) -> Result<U, OutOfBounds<U>>

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
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

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
source§

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
source§

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.
source§

impl<T> AnyBitPattern for T
where T: Pod,

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

impl<T> NoUninit for T
where T: Pod,