[][src]Struct palette::luma::Luma

#[repr(C)]
pub struct Luma<S = Srgb, T = f32> where
    T: Component,
    S: LumaStandard
{ pub luma: T, pub standard: PhantomData<S>, }

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.

Methods

impl<S, T> Luma<S, T> where
    T: Component,
    S: LumaStandard
[src]

pub fn new(luma: T) -> Luma<S, T>[src]

Create a luminance color.

pub fn into_format<U: Component>(self) -> Luma<S, U>[src]

Convert into another component type.

pub fn from_format<U: Component>(color: Luma<S, U>) -> Self[src]

Convert from another component type.

pub fn into_components(self) -> (T,)[src]

Convert to a (luma,) tuple.

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

Convert from a (luma,) tuple.

impl<S, T> Luma<S, T> where
    T: Component + Float,
    S: LumaStandard
[src]

pub fn into_linear(self) -> Luma<Linear<S::WhitePoint>, T>[src]

Convert the color to linear luminance.

pub fn from_linear(color: Luma<Linear<S::WhitePoint>, T>) -> Luma<S, T>[src]

Convert linear luminance to nonlinear luminance.

pub fn into_encoding<St: LumaStandard<WhitePoint = S::WhitePoint>>(
    self
) -> Luma<St, T>
[src]

Convert the color to a different encoding.

pub fn from_encoding<St: LumaStandard<WhitePoint = S::WhitePoint>>(
    color: Luma<St, T>
) -> Luma<S, T>
[src]

Convert luminance from a different encoding.

Trait Implementations

impl<S, T> Blend for Luma<S, T> where
    T: Component + Float,
    S: LumaStandard<TransferFn = LinearFn>, 
[src]

type Color = Luma<S, T>

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

impl<S, T> FromColor<<S as LumaStandard>::WhitePoint, T> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + _FloatTrait
[src]

impl<S, Wp, T> IntoColor<Wp, T> for Luma<S, T> where
    S: LumaStandard<WhitePoint = Wp>,
    T: Component + Float,
    Wp: WhitePoint
[src]

impl<S, T> Pixel<T> for Luma<S, T> where
    T: Component,
    S: LumaStandard
[src]

impl<S, T> Limited for Luma<S, T> where
    T: Component,
    S: LumaStandard
[src]

impl<S, T> Mix for Luma<S, T> where
    T: Component + Float,
    S: LumaStandard<TransferFn = LinearFn>, 
[src]

type Scalar = T

The type of the mixing factor.

impl<S, T> Shade for Luma<S, T> where
    T: Component + Float,
    S: LumaStandard<TransferFn = LinearFn>, 
[src]

type Scalar = T

The type of the lighten/darken amount.

impl<S, T> ComponentWise for Luma<S, T> where
    T: Component,
    S: LumaStandard
[src]

type Scalar = T

The scalar type for color components.

impl<S, T, P: ?Sized> AsRef<P> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    P: RawPixel<T>, 
[src]

fn as_ref(&self) -> &P[src]

Convert to a raw pixel format.

use palette::SrgbLuma;

let luma = SrgbLuma::new(100);
let raw: &[u8] = luma.as_ref();

assert_eq!(raw[0], 100);

impl<S, T, P: ?Sized> AsMut<P> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    P: RawPixel<T>, 
[src]

fn as_mut(&mut self) -> &mut P[src]

Convert to a raw pixel format.

use palette::SrgbLuma;

let mut luma = SrgbLuma::new(100);
{
    let raw: &mut [u8] = luma.as_mut();
    raw[0] = 5;
}

assert_eq!(luma.luma, 5);

impl<S: LumaStandard, T: Component> Into<(T,)> for Luma<S, T>[src]

impl<S, T, _S> From<Luma<_S, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait,
    _S: LumaStandard<WhitePoint = S::WhitePoint>, 
[src]

impl<S, T, _S> From<Luma<_S, T>> for Alpha<Hsl<S, T>, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait,
    _S: LumaStandard<WhitePoint = S::WhitePoint>, 
[src]

impl<S, T, _S> From<Luma<_S, T>> for Hsv<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait,
    _S: LumaStandard<WhitePoint = S::WhitePoint>, 
[src]

impl<S, T, _S> From<Luma<_S, T>> for Alpha<Hsv<S, T>, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait,
    _S: LumaStandard<WhitePoint = S::WhitePoint>, 
[src]

impl<S, T, _S> From<Luma<_S, T>> for Hwb<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait,
    _S: LumaStandard<WhitePoint = S::WhitePoint>, 
[src]

impl<S, T, _S> From<Luma<_S, T>> for Alpha<Hwb<S, T>, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + _FloatTrait,
    _S: LumaStandard<WhitePoint = S::WhitePoint>, 
[src]

impl<Wp, T, _S> From<Luma<_S, T>> for Lab<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + _FloatTrait,
    _S: LumaStandard<WhitePoint = Wp>, 
[src]

impl<Wp, T, _S> From<Luma<_S, T>> for Alpha<Lab<Wp, T>, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + _FloatTrait,
    _S: LumaStandard<WhitePoint = Wp>, 
[src]

impl<Wp, T, _S> From<Luma<_S, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + _FloatTrait,
    _S: LumaStandard<WhitePoint = Wp>, 
[src]

impl<Wp, T, _S> From<Luma<_S, T>> for Alpha<Lch<Wp, T>, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + _FloatTrait,
    _S: LumaStandard<WhitePoint = Wp>, 
[src]

impl<S, T, _S> From<Rgb<_S, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + _FloatTrait,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = S::WhitePoint>, 
[src]

impl<S, T, _S> From<Alpha<Rgb<_S, T>, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + _FloatTrait,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = S::WhitePoint>, 
[src]

impl<S, T, _S> From<Alpha<Luma<_S, T>, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + _FloatTrait,
    _S: LumaStandard<WhitePoint = S::WhitePoint>, 
[src]

impl<S, T, _S> From<Hsl<_S, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + _FloatTrait,
    _S: RgbSpace<WhitePoint = S::WhitePoint>, 
[src]

impl<S, T, _S> From<Alpha<Hsl<_S, T>, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + _FloatTrait,
    _S: RgbSpace<WhitePoint = S::WhitePoint>, 
[src]

impl<S, T, _S> From<Hsv<_S, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + _FloatTrait,
    _S: RgbSpace<WhitePoint = S::WhitePoint>, 
[src]

impl<S, T, _S> From<Alpha<Hsv<_S, T>, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + _FloatTrait,
    _S: RgbSpace<WhitePoint = S::WhitePoint>, 
[src]

impl<S, T, _S> From<Hwb<_S, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + _FloatTrait,
    _S: RgbSpace<WhitePoint = S::WhitePoint>, 
[src]

impl<S, T, _S> From<Alpha<Hwb<_S, T>, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + _FloatTrait,
    _S: RgbSpace<WhitePoint = S::WhitePoint>, 
[src]

impl<S, T> From<Lab<<S as LumaStandard>::WhitePoint, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + _FloatTrait
[src]

impl<S, T> From<Alpha<Lab<<S as LumaStandard>::WhitePoint, T>, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + _FloatTrait
[src]

impl<S, T> From<Lch<<S as LumaStandard>::WhitePoint, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + _FloatTrait
[src]

impl<S, T> From<Alpha<Lch<<S as LumaStandard>::WhitePoint, T>, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + _FloatTrait
[src]

impl<S, T> From<Alpha<Xyz<<S as LumaStandard>::WhitePoint, T>, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + _FloatTrait
[src]

impl<S, T> From<Alpha<Yxy<<S as LumaStandard>::WhitePoint, T>, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + _FloatTrait
[src]

impl<S, T> From<Xyz<<S as LumaStandard>::WhitePoint, T>> for Luma<S, T> where
    S: LumaStandard,
    T: Component + Float
[src]

impl<S, T> From<Yxy<<S as LumaStandard>::WhitePoint, T>> for Luma<S, T> where
    S: LumaStandard,
    T: Component + Float
[src]

impl<S: LumaStandard, T: Component> From<(T,)> for Luma<S, T>[src]

impl<S: RgbStandard, T: Component, _S> From<Luma<_S, T>> for Alpha<Rgb<S, T>, T> where
    T: Component + _FloatTrait,
    _S: LumaStandard<WhitePoint = <S::Space as RgbSpace>::WhitePoint>, 
[src]

impl<S, T, St, Wp> From<Luma<St, T>> for Rgb<S, T> where
    S: RgbStandard,
    T: Component + Float,
    Wp: WhitePoint,
    S::Space: RgbSpace<WhitePoint = Wp>,
    St: LumaStandard<WhitePoint = Wp>, 
[src]

impl<Wp, T, _S> From<Luma<_S, T>> for Alpha<Xyz<Wp, T>, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + _FloatTrait,
    _S: LumaStandard<WhitePoint = Wp>, 
[src]

impl<Wp, T, S> From<Luma<S, T>> for Xyz<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    S: LumaStandard<WhitePoint = Wp>, 
[src]

impl<Wp, T, _S> From<Luma<_S, T>> for Alpha<Yxy<Wp, T>, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + _FloatTrait,
    _S: LumaStandard<WhitePoint = Wp>, 
[src]

impl<S, T> From<Luma<S, T>> for Yxy<S::WhitePoint, T> where
    T: Component + Float,
    S: LumaStandard
[src]

impl<S, T> Clone for Luma<S, T> where
    T: Component,
    S: LumaStandard
[src]

impl<S, T> Copy for Luma<S, T> where
    T: Component,
    S: LumaStandard
[src]

impl<S, T> Default for Luma<S, T> where
    T: Component,
    S: LumaStandard
[src]

impl<S: PartialEq, T: PartialEq> PartialEq<Luma<S, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard
[src]

impl<S: Debug, T: Debug> Debug for Luma<S, T> where
    T: Component,
    S: LumaStandard
[src]

impl<S, T> Div<Luma<S, T>> for Luma<S, T> where
    T: Component + Div,
    S: LumaStandard<TransferFn = LinearFn>,
    <T as Div>::Output: Component
[src]

type Output = Luma<S, <T as Div>::Output>

The resulting type after applying the / operator.

impl<S, T> Div<T> for Luma<S, T> where
    T: Component + Div,
    S: LumaStandard<TransferFn = LinearFn>,
    <T as Div>::Output: Component
[src]

type Output = Luma<S, <T as Div>::Output>

The resulting type after applying the / operator.

impl<S, T> Sub<Luma<S, T>> for Luma<S, T> where
    T: Component + Sub,
    S: LumaStandard<TransferFn = LinearFn>,
    <T as Sub>::Output: Component
[src]

type Output = Luma<S, <T as Sub>::Output>

The resulting type after applying the - operator.

impl<S, T> Sub<T> for Luma<S, T> where
    T: Component + Sub,
    S: LumaStandard<TransferFn = LinearFn>,
    <T as Sub>::Output: Component
[src]

type Output = Luma<S, <T as Sub>::Output>

The resulting type after applying the - operator.

impl<S, T> Add<Luma<S, T>> for Luma<S, T> where
    T: Component + Add,
    S: LumaStandard<TransferFn = LinearFn>,
    <T as Add>::Output: Component
[src]

type Output = Luma<S, <T as Add>::Output>

The resulting type after applying the + operator.

impl<S, T> Add<T> for Luma<S, T> where
    T: Component + Add,
    S: LumaStandard<TransferFn = LinearFn>,
    <T as Add>::Output: Component
[src]

type Output = Luma<S, <T as Add>::Output>

The resulting type after applying the + operator.

impl<S, T> Mul<Luma<S, T>> for Luma<S, T> where
    T: Component + Mul,
    S: LumaStandard<TransferFn = LinearFn>,
    <T as Mul>::Output: Component
[src]

type Output = Luma<S, <T as Mul>::Output>

The resulting type after applying the * operator.

impl<S, T> Mul<T> for Luma<S, T> where
    T: Component + Mul,
    S: LumaStandard<TransferFn = LinearFn>,
    <T as Mul>::Output: Component
[src]

type Output = Luma<S, <T as Mul>::Output>

The resulting type after applying the * operator.

impl<S, T> AddAssign<Luma<S, T>> for Luma<S, T> where
    T: Component + AddAssign,
    S: LumaStandard<TransferFn = LinearFn>, 
[src]

impl<S, T> AddAssign<T> for Luma<S, T> where
    T: Component + AddAssign,
    S: LumaStandard<TransferFn = LinearFn>, 
[src]

impl<S, T> SubAssign<Luma<S, T>> for Luma<S, T> where
    T: Component + SubAssign,
    S: LumaStandard<TransferFn = LinearFn>, 
[src]

impl<S, T> SubAssign<T> for Luma<S, T> where
    T: Component + SubAssign,
    S: LumaStandard<TransferFn = LinearFn>, 
[src]

impl<S, T> MulAssign<Luma<S, T>> for Luma<S, T> where
    T: Component + MulAssign,
    S: LumaStandard<TransferFn = LinearFn>, 
[src]

impl<S, T> MulAssign<T> for Luma<S, T> where
    T: Component + MulAssign,
    S: LumaStandard<TransferFn = LinearFn>, 
[src]

impl<S, T> DivAssign<Luma<S, T>> for Luma<S, T> where
    T: Component + DivAssign,
    S: LumaStandard<TransferFn = LinearFn>, 
[src]

impl<S, T> DivAssign<T> for Luma<S, T> where
    T: Component + DivAssign,
    S: LumaStandard<TransferFn = LinearFn>, 
[src]

impl<S, T> StructuralPartialEq for Luma<S, T> where
    T: Component,
    S: LumaStandard
[src]

impl<S, T> LowerHex for Luma<S, T> where
    T: Component + LowerHex,
    S: LumaStandard
[src]

impl<S, T> UpperHex for Luma<S, T> where
    T: Component + UpperHex,
    S: LumaStandard
[src]

impl<S, T> AbsDiffEq<Luma<S, T>> for Luma<S, T> where
    T: Component + AbsDiffEq,
    T::Epsilon: Copy,
    S: LumaStandard + PartialEq
[src]

type Epsilon = T::Epsilon

Used for specifying relative comparisons.

impl<S, T> RelativeEq<Luma<S, T>> for Luma<S, T> where
    T: Component + RelativeEq,
    T::Epsilon: Copy,
    S: LumaStandard + PartialEq
[src]

impl<S, T> UlpsEq<Luma<S, T>> for Luma<S, T> where
    T: Component + UlpsEq,
    T::Epsilon: Copy,
    S: LumaStandard + PartialEq
[src]

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

impl<S, D, Swp, Dwp, T> AdaptFrom<S, Swp, Dwp, T> for D where
    D: FromColor<Dwp, T>,
    Dwp: WhitePoint,
    S: IntoColor<Swp, T>,
    Swp: WhitePoint,
    T: Component + Float
[src]

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
    D: AdaptFrom<S, Swp, Dwp, T>,
    Dwp: WhitePoint,
    Swp: WhitePoint,
    T: Component + Float
[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> From<T> for T[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]