Struct palette::rgb::Rgb[][src]

#[repr(C)]
pub struct Rgb<S: RgbStandard = Srgb, T: Component = f32> { pub red: T, pub green: T, pub blue: T, pub standard: PhantomData<S>, }

Generic RGB.

RGB is probably the most common color space, when it comes to computer graphics, and it's defined as an additive mixture of red, green and blue light, where gray scale colors are created when these three channels are equal in strength.

Many conversions and operations on this color space requires that it's linear, meaning that gamma correction is required when converting to and from a displayable RGB, such as sRGB. See the pixel module for encoding formats.

Fields

The amount of red light, where 0.0 is no red light and 1.0f (or 255u8) is the highest displayable amount.

The amount of green light, where 0.0 is no green light and 1.0f (or 255u8) is the highest displayable amount.

The amount of blue light, where 0.0 is no blue light and 1.0f (or 255u8) is the highest displayable amount.

The kind of RGB standard. sRGB is the default.

Methods

impl<S: RgbStandard, T: Component> Rgb<S, T>
[src]

Create an RGB color.

Convert into another component type.

Convert from another component type.

Convert to a (red, green, blue) tuple.

Convert from a (red, green, blue) tuple.

impl<S: RgbStandard, T: Component + Float> Rgb<S, T>
[src]

Convert the color to linear RGB.

Convert linear RGB to nonlinear RGB.

Convert the color to a different encoding.

Convert RGB from a different encoding.

Trait Implementations

impl<S, T, _S> From<Rgb<_S, T>> for Hsl<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + Float,
    _S: RgbStandard<Space = S>, 
[src]

Performs the conversion.

impl<S, T, _S> From<Rgb<_S, T>> for Alpha<Hsl<S, T>, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + Float,
    _S: RgbStandard<Space = S>, 
[src]

Performs the conversion.

impl<S, T, _S> From<Rgb<_S, T>> for Hsv<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + Float,
    _S: RgbStandard<Space = S>, 
[src]

Performs the conversion.

impl<S, T, _S> From<Rgb<_S, T>> for Alpha<Hsv<S, T>, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + Float,
    _S: RgbStandard<Space = S>, 
[src]

Performs the conversion.

impl<S, T, _S> From<Rgb<_S, T>> for Hwb<S, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + Float,
    _S: RgbStandard<Space = S>, 
[src]

Performs the conversion.

impl<S, T, _S> From<Rgb<_S, T>> for Alpha<Hwb<S, T>, T> where
    T: Component + Float,
    S: RgbSpace,
    T: Component + Float,
    _S: RgbStandard<Space = S>, 
[src]

Performs the conversion.

impl<Wp, T, _S> From<Rgb<_S, T>> for Lab<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + Float,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 
[src]

Performs the conversion.

impl<Wp, T, _S> From<Rgb<_S, T>> for Alpha<Lab<Wp, T>, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + Float,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 
[src]

Performs the conversion.

impl<Wp, T, _S> From<Rgb<_S, T>> for Lch<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + Float,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 
[src]

Performs the conversion.

impl<Wp, T, _S> From<Rgb<_S, T>> for Alpha<Lch<Wp, T>, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + Float,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 
[src]

Performs the conversion.

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]

Performs the conversion.

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

Performs the conversion.

impl<S: RgbStandard, T: Component> FromColor<<S::Space as RgbSpace>::WhitePoint, T> for Rgb<S, T> where
    T: Component + Float
[src]

Convert from XYZ color space

Convert from HSV color space

Convert from HSL color space

Convert from Luma

Convert from RGB color space

Convert from Yxy color space

Convert from Lab* color space

Convert from LCh° color space

Convert from HWB color space

impl<S: RgbStandard, T: Component, _S> From<Alpha<Rgb<_S, T>, T>> for Rgb<S, T> where
    T: Component + Float,
    _S: RgbStandard<Space = S::Space>, 
[src]

Performs the conversion.

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

Performs the conversion.

impl<S: RgbStandard, T: Component> From<Alpha<Hsl<S::Space, T>, T>> for Rgb<S, T> where
    T: Component + Float
[src]

Performs the conversion.

impl<S: RgbStandard, T: Component> From<Alpha<Hsv<S::Space, T>, T>> for Rgb<S, T> where
    T: Component + Float
[src]

Performs the conversion.

impl<S: RgbStandard, T: Component> From<Hwb<S::Space, T>> for Rgb<S, T> where
    T: Component + Float
[src]

Performs the conversion.

impl<S: RgbStandard, T: Component> From<Alpha<Hwb<S::Space, T>, T>> for Rgb<S, T> where
    T: Component + Float
[src]

Performs the conversion.

impl<S: RgbStandard, T: Component> From<Lab<<S::Space as RgbSpace>::WhitePoint, T>> for Rgb<S, T> where
    T: Component + Float
[src]

Performs the conversion.

impl<S: RgbStandard, T: Component> From<Alpha<Lab<<S::Space as RgbSpace>::WhitePoint, T>, T>> for Rgb<S, T> where
    T: Component + Float
[src]

Performs the conversion.

impl<S: RgbStandard, T: Component> From<Lch<<S::Space as RgbSpace>::WhitePoint, T>> for Rgb<S, T> where
    T: Component + Float
[src]

Performs the conversion.

impl<S: RgbStandard, T: Component> From<Alpha<Lch<<S::Space as RgbSpace>::WhitePoint, T>, T>> for Rgb<S, T> where
    T: Component + Float
[src]

Performs the conversion.

impl<S: RgbStandard, T: Component> From<Alpha<Xyz<<S::Space as RgbSpace>::WhitePoint, T>, T>> for Rgb<S, T> where
    T: Component + Float
[src]

Performs the conversion.

impl<S: RgbStandard, T: Component> From<Yxy<<S::Space as RgbSpace>::WhitePoint, T>> for Rgb<S, T> where
    T: Component + Float
[src]

Performs the conversion.

impl<S: RgbStandard, T: Component> From<Alpha<Yxy<<S::Space as RgbSpace>::WhitePoint, T>, T>> for Rgb<S, T> where
    T: Component + Float
[src]

Performs the conversion.

impl<S: RgbStandard, T: Component> From<Color<S::Space, T>> for Rgb<S, T> where
    T: Component + Float
[src]

Performs the conversion.

impl<S: RgbStandard, T: Component> From<Alpha<Color<S::Space, T>, T>> for Rgb<S, T> where
    T: Component + Float
[src]

Performs the conversion.

impl<S: RgbStandard, T: Component> Pixel<T> for Rgb<S, T>
[src]

CHANNELS: usize = 3usize

The number of color channels.

Cast as a reference to raw color components.

Cast as a mutable reference to raw color components.

Convert from raw color components.

Cast from a reference to raw color components.

Cast from a mutable reference to raw color components.

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

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

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

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

impl<S: Debug + RgbStandard, T: Debug + Component> Debug for Rgb<S, T>
[src]

Formats the value using the given formatter. Read more

impl<S: PartialEq + RgbStandard, T: PartialEq + Component> PartialEq for Rgb<S, T>
[src]

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

impl<S: RgbStandard, T: Component> Copy for Rgb<S, T>
[src]

impl<S: RgbStandard, T: Component> Clone for Rgb<S, T>
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl<S, T> Limited for Rgb<S, T> where
    S: RgbStandard,
    T: Component
[src]

Check if the color's components are within the expected ranges.

Return a new color where the components has been clamped to the nearest valid values. Read more

Clamp the color's components to the nearest valid values.

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

The type of the mixing factor.

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

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

The type of the lighten/darken amount.

Lighten the color by amount.

Darken the color by amount.

impl<S, T> GetHue for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Component + Float
[src]

The kind of hue unit this color space uses. Read more

Calculate a hue if possible. Read more

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

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

Convert the color to premultiplied alpha.

Convert the color from premultiplied alpha.

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

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

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

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

Place self over only the visible parts of other.

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

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

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

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

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

Return the darkest parts of self and other.

Return the lightest parts of self and other.

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

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

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

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

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

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> ComponentWise for Rgb<S, T> where
    S: RgbStandard,
    T: Component
[src]

The scalar type for color components.

Perform a binary operation on this and an other color.

Perform a unary operation on this color.

impl<S, T> Default for Rgb<S, T> where
    T: Component,
    S: RgbStandard
[src]

Returns the "default value" for a type. Read more

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

The resulting type after applying the + operator.

Performs the + operation.

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

The resulting type after applying the + operator.

Performs the + operation.

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

The resulting type after applying the - operator.

Performs the - operation.

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

The resulting type after applying the - operator.

Performs the - operation.

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

The resulting type after applying the * operator.

Performs the * operation.

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

The resulting type after applying the * operator.

Performs the * operation.

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

The resulting type after applying the / operator.

Performs the / operation.

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

The resulting type after applying the / operator.

Performs the / operation.

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

Performs the conversion.

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

Performs the conversion.

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

Performs the conversion.

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]

Performs the conversion.

impl<S: RgbStandard, T: Component> From<(T, T, T)> for Rgb<S, T>
[src]

Performs the conversion.

impl<S: RgbStandard, T: Component> Into<(T, T, T)> for Rgb<S, T>
[src]

Performs the conversion.

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

Convert into XYZ space

Convert into Yxy color space

Convert into Lab* color space

Convert into LCh° color space

Convert into RGB color space.

Convert into HSL color space

Convert into HSV color space

Convert into HWB color space

Convert into Luma

impl<S, T> ApproxEq for Rgb<S, T> where
    T: Component + ApproxEq,
    T::Epsilon: Copy,
    S: RgbStandard
[src]

Used for specifying relative comparisons.

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

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

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

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

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

The inverse of ApproxEq::relative_eq.

The inverse of ApproxEq::ulps_eq.

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

Convert to a raw pixel format.

use palette::Srgb;

let mut rgb = Srgb::new(38, 42, 19);
let raw: &[u8] = rgb.as_ref();

assert_eq!(raw[1], 42);

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

Convert to a raw pixel format.

use palette::Srgb;

let mut rgb = Srgb::new(38, 42, 19);
{
    let raw: &mut [u8] = rgb.as_mut();
    raw[1] = 5;
}

assert_eq!(rgb.green, 5);

impl<S, T> LowerHex for Rgb<S, T> where
    T: Component + LowerHex,
    S: RgbStandard
[src]

Formats the value using the given formatter.

impl<S, T> UpperHex for Rgb<S, T> where
    T: Component + UpperHex,
    S: RgbStandard
[src]

Formats the value using the given formatter.

impl<Wp, T, _S> From<Rgb<_S, T>> for Alpha<Xyz<Wp, T>, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + Float,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 
[src]

Performs the conversion.

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

Performs the conversion.

impl<Wp, T, _S> From<Rgb<_S, T>> for Yxy<Wp, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + Float,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 
[src]

Performs the conversion.

impl<Wp, T, _S> From<Rgb<_S, T>> for Alpha<Yxy<Wp, T>, T> where
    T: Component + Float,
    Wp: WhitePoint,
    T: Component + Float,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 
[src]

Performs the conversion.

impl<S, T> From<Rgb<Linear<S>, T>> for Color<S, T> where
    T: Float + Component,
    S: RgbSpace
[src]

Performs the conversion.

Auto Trait Implementations

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

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