[][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.

fn blend<F>(self, destination: Self, blend_function: F) -> Self where
    F: BlendFunction<Self::Color>, 
[src]

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

fn over(self, other: Self) -> Self[src]

Place self over other. This is the good old common alpha composition equation. Read more

fn inside(self, other: Self) -> Self[src]

Results in the parts of self that overlaps the visible parts of other. Read more

fn outside(self, other: Self) -> Self[src]

Results in the parts of self that lies outside the visible parts of other. Read more

fn atop(self, other: Self) -> Self[src]

Place self over only the visible parts of other.

fn xor(self, other: Self) -> Self[src]

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

fn plus(self, other: Self) -> Self[src]

Add self and other. This uses the alpha component to regulate the effect, so it's not just plain component wise addition. Read more

fn multiply(self, other: Self) -> Self[src]

Multiply self with other. This uses the alpha component to regulate the effect, so it's not just plain component wise multiplication. Read more

fn screen(self, other: Self) -> Self[src]

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

fn overlay(self, other: Self) -> Self[src]

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

fn darken(self, other: Self) -> Self[src]

Return the darkest parts of self and other.

fn lighten(self, other: Self) -> Self[src]

Return the lightest parts of self and other.

fn dodge(self, other: Self) -> Self[src]

Lighten other to reflect self. Results in other if self is black. Read more

fn burn(self, other: Self) -> Self[src]

Darken other to reflect self. Results in other if self is white. Read more

fn hard_light(self, other: Self) -> Self[src]

Multiply self or other if other is dark, or screen them if self is light. This is similar to overlay, but depends on self instead of other. Read more

fn soft_light(self, other: Self) -> Self[src]

Lighten other if self is light, or darken other as if it's burned if self is dark. The effect is increased if the components of self is further from 0.5. Read more

fn difference(self, other: Self) -> Self[src]

Return the absolute difference between self and other. It's basically abs(self - other), but regulated by the alpha component. Read more

fn exclusion(self, other: Self) -> Self[src]

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

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

fn from_lab(inp: Lab<Wp, T>) -> Self[src]

Convert from Lab* color space

fn from_lch(inp: Lch<Wp, T>) -> Self[src]

Convert from LCh° color space

fn from_rgb<S: RgbSpace<WhitePoint = Wp>>(inp: Rgb<Linear<S>, T>) -> Self[src]

Convert from RGB color space

fn from_hsl<S: RgbSpace<WhitePoint = Wp>>(inp: Hsl<S, T>) -> Self[src]

Convert from HSL color space

fn from_hsv<S: RgbSpace<WhitePoint = Wp>>(inp: Hsv<S, T>) -> Self[src]

Convert from HSV color space

fn from_hwb<S: RgbSpace<WhitePoint = Wp>>(inp: Hwb<S, T>) -> Self[src]

Convert from HWB color space

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

fn into_lab(self) -> Lab<Wp, T>[src]

Convert into Lab* color space

fn into_lch(self) -> Lch<Wp, T>[src]

Convert into LCh° color space

fn into_rgb<S: RgbSpace<WhitePoint = Wp>>(self) -> Rgb<Linear<S>, T>[src]

Convert into RGB color space.

fn into_hsl<S: RgbSpace<WhitePoint = Wp>>(self) -> Hsl<S, T>[src]

Convert into HSL color space

fn into_hsv<S: RgbSpace<WhitePoint = Wp>>(self) -> Hsv<S, T>[src]

Convert into HSV color space

fn into_hwb<S: RgbSpace<WhitePoint = Wp>>(self) -> Hwb<S, T>[src]

Convert into HWB color space

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

fn as_raw<P: RawPixel<T> + ?Sized>(&self) -> &P[src]

Cast as a reference to raw color components.

fn as_raw_mut<P: RawPixel<T> + ?Sized>(&mut self) -> &mut P[src]

Cast as a mutable reference to raw color components.

fn into_raw<P: RawPixelSized<T>>(self) -> P[src]

Convert from raw color components.

fn from_raw<P: RawPixel<T> + ?Sized>(pixel: &P) -> &Self[src]

Cast from a reference to raw color components.

fn from_raw_mut<P: RawPixel<T> + ?Sized>(pixel: &mut P) -> &mut Self[src]

Cast from a mutable reference to raw color components.

fn from_raw_slice(slice: &[T]) -> &[Self][src]

Cast a slice of raw color components to a slice of colors. Read more

fn from_raw_slice_mut(slice: &mut [T]) -> &mut [Self][src]

Cast a mutable slice of raw color components to a mutable slice of colors. Read more

fn into_raw_slice(slice: &[Self]) -> &[T][src]

Cast a slice of colors to a slice of raw color components. Read more

fn into_raw_slice_mut(slice: &mut [Self]) -> &mut [T][src]

Cast a mutable slice of colors to a mutable slice of raw color components. Read more

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.

fn darken(&self, amount: Self::Scalar) -> Self[src]

Darken the color by 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> Copy for Luma<S, T> where
    T: Component,
    S: LumaStandard
[src]

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> Default for Luma<S, T> where
    T: Component,
    S: LumaStandard
[src]

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

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

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

impl<S, T, _S> From<Luma<_S, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + Float,
    _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 + Float,
    _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 + Float,
    _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 + Float,
    _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 + Float,
    _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 + Float,
    _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 + Float,
    _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 + Float,
    _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 + Float,
    _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 + Float,
    _S: LumaStandard<WhitePoint = Wp>, 
[src]

impl<S, T, _S> From<Rgb<_S, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + Float,
    _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 + Float,
    _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 + Float,
    _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 + Float,
    _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 + Float,
    _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 + Float,
    _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 + Float,
    _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 + Float,
    _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 + Float,
    _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 + Float
[src]

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

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

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

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

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

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

impl<S, T, _S> From<Alpha<Color<_S, T>, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Component + Float,
    _S: RgbSpace<WhitePoint = S::WhitePoint>, 
[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 + Float,
    _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 + Float,
    _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 + Float,
    _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> From<Luma<Linear<<S as RgbSpace>::WhitePoint>, T>> for Color<S, T> where
    T: Float + Component,
    S: RgbSpace
[src]

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

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: Debug, T: Debug> Debug for Luma<S, T> where
    T: Component,
    S: LumaStandard
[src]

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> 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> 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> 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> 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> ApproxEq for Luma<S, T> where
    T: Component + ApproxEq,
    T::Epsilon: Copy,
    S: LumaStandard
[src]

type Epsilon = <T as ApproxEq>::Epsilon

Used for specifying relative comparisons.

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

The inverse of ApproxEq::relative_eq.

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

The inverse of ApproxEq::ulps_eq.

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

impl<'de, S, T> Deserialize<'de> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: Deserialize<'de>, 
[src]

Auto Trait Implementations

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

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

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

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]

fn adapt_from(color: S) -> Self[src]

Convert the source color to the destination color using the bradford method by default Read more

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]

fn adapt_into(self) -> D[src]

Convert the source color to the destination color using the bradford method by default Read more

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

type Owned = T

The resulting type after obtaining ownership.

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

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

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]

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