Struct palette::rgb::Rgb

pub struct Rgb<S: RgbStandard = Srgb, T: Float = 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

red: T

The amount of red light, where 0.0 is no red light and 1.0 is the highest displayable amount.

green: T

The amount of green light, where 0.0 is no green light and 1.0 is the highest displayable amount.

blue: T

The amount of blue light, where 0.0 is no blue light and 1.0 is the highest displayable amount.

standard: PhantomData<S>

The kind of RGB standard. sRGB is the default.

Methods

impl<S: RgbStandard, T: Float> Rgb<S, T>

fn new(red: T, green: T, blue: T) -> Rgb<S, T>

Create an RGB color.

fn new_u8(red: u8, green: u8, blue: u8) -> Rgb<S, T>

Create an RGB color from 8 bit values.

fn from_pixel<P: RgbPixel<T>>(pixel: &P) -> Rgb<S, T>

Create an RGB color from a pixel.

fn into_pixel<P: RgbPixel<T>>(self) -> P

Convert the color into a pixel representation.

fn into_linear(self) -> Rgb<Linear<S::Space>, T>

Convert the color to linear RGB.

fn from_linear(color: Rgb<Linear<S::Space>, T>) -> Rgb<S, T>

Convert linear RGB to nonlinear RGB.

fn linear_to_pixel<C: Into<Rgb<Linear<S::Space>, T>>, P: RgbPixel<T>>(
    color: C
) -> P

Convert a linear color to an RGB pixel.

fn pixel_to_linear<C: From<Rgb<Linear<S::Space>, T>>, P: RgbPixel<T>>(
    pixel: &P
) -> C

Convert an RGB pixel to a linear color.

Trait Implementations

impl<S: Debug + RgbStandard, T: Debug + Float> Debug for Rgb<S, T>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<S: PartialEq + RgbStandard, T: PartialEq + Float> PartialEq for Rgb<S, T>

fn eq(&self, __arg_0: &Rgb<S, T>) -> bool

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

fn ne(&self, __arg_0: &Rgb<S, T>) -> bool

This method tests for !=.

impl<S: RgbStandard, T: Float> Copy for Rgb<S, T>

impl<S: RgbStandard, T: Float> Clone for Rgb<S, T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S, T> Limited for Rgb<S, T> where
    S: RgbStandard,
    T: Float, 

fn is_valid(&self) -> bool

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

fn clamp(&self) -> Rgb<S, T>

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

fn clamp_self(&mut self)

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

impl<S, T> Mix for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Float, 

type Scalar = T

The type of the mixing factor.

fn mix(&self, other: &Rgb<S, T>, factor: T) -> Rgb<S, T>

Mix the color with an other color, by factor.

impl<S, T> Shade for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Float, 

type Scalar = T

The type of the lighten/darken amount.

fn lighten(&self, amount: T) -> Rgb<S, T>

Lighten the color by amount.

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

Darken the color by amount.

impl<S, T> GetHue for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Float, 

type Hue = RgbHue<T>

The kind of hue unit this color space uses.

fn get_hue(&self) -> Option<RgbHue<T>>

Calculate a hue if possible.

impl<S, T> Blend for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Float, 

type Color = Rgb<S, T>

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

fn into_premultiplied(self) -> PreAlpha<Rgb<S, T>, T>

Convert the color to premultiplied alpha.

fn from_premultiplied(color: PreAlpha<Rgb<S, T>, T>) -> Self

Convert the color from premultiplied alpha.

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

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

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

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

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

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

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

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

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

Place self over only the visible parts of other.

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

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

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

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

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

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

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

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

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

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

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

Return the darkest parts of self and other.

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

Return the lightest parts of self and other.

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

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

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

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

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

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

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

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

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

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

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

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

impl<S, T> ComponentWise for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Float, 

type Scalar = T

The scalar type for color components.

fn component_wise<F: FnMut(T, T) -> T>(
    &self,
    other: &Rgb<S, T>,
    f: F
) -> Rgb<S, T>

Perform a binary operation on this and an other color.

fn component_wise_self<F: FnMut(T) -> T>(&self, f: F) -> Rgb<S, T>

Perform a unary operation on this color.

impl<S, T> Default for Rgb<S, T> where
    T: Float,
    S: RgbStandard, 

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

Returns the "default value" for a type.

impl<S, T> Add<Rgb<S, T>> for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Float, 

type Output = Rgb<S, T>

The resulting type after applying the + operator.

fn add(self, other: Rgb<S, T>) -> Rgb<S, T>

Performs the + operation.

impl<S, T> Add<T> for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Float, 

type Output = Rgb<S, T>

The resulting type after applying the + operator.

fn add(self, c: T) -> Rgb<S, T>

Performs the + operation.

impl<S, T> Sub<Rgb<S, T>> for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Float, 

type Output = Rgb<S, T>

The resulting type after applying the - operator.

fn sub(self, other: Rgb<S, T>) -> Rgb<S, T>

Performs the - operation.

impl<S, T> Sub<T> for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Float, 

type Output = Rgb<S, T>

The resulting type after applying the - operator.

fn sub(self, c: T) -> Rgb<S, T>

Performs the - operation.

impl<S, T> Mul<Rgb<S, T>> for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Float, 

type Output = Rgb<S, T>

The resulting type after applying the * operator.

fn mul(self, other: Rgb<S, T>) -> Rgb<S, T>

Performs the * operation.

impl<S, T> Mul<T> for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Float, 

type Output = Rgb<S, T>

The resulting type after applying the * operator.

fn mul(self, c: T) -> Rgb<S, T>

Performs the * operation.

impl<S, T> Div<Rgb<S, T>> for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Float, 

type Output = Rgb<S, T>

The resulting type after applying the / operator.

fn div(self, other: Rgb<S, T>) -> Rgb<S, T>

Performs the / operation.

impl<S, T> Div<T> for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Float, 

type Output = Rgb<S, T>

The resulting type after applying the / operator.

fn div(self, c: T) -> Rgb<S, T>

Performs the / operation.

impl<S, Wp, T> FromColor<Wp, T> for Rgb<S, T> where
    S: RgbStandard,
    T: Float,
    Wp: WhitePoint,
    S::Space: RgbSpace<WhitePoint = Wp>, 

fn from_xyz(xyz: Xyz<Wp, T>) -> Self

Convert from XYZ color space

fn from_rgb<Sp: RgbSpace<WhitePoint = Wp>>(rgb: Rgb<Linear<Sp>, T>) -> Self

Convert from RGB color space

fn from_hsl<Sp: RgbSpace<WhitePoint = Wp>>(hsl: Hsl<Sp, T>) -> Self

Convert from HSL color space

fn from_hsv<Sp: RgbSpace<WhitePoint = Wp>>(hsv: Hsv<Sp, T>) -> Self

Convert from HSV color space

fn from_luma(luma: Luma<Wp, T>) -> Self

Convert from Luma

fn from_yxy(inp: Yxy<Wp, T>) -> Self

Convert from Yxy color space

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

Convert from L*a*b* color space

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

Convert from L*C*h° color space

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

Convert from HWB color space

impl<S, T, Wp> IntoColor<Wp, T> for Rgb<S, T> where
    S: RgbStandard,
    T: Float,
    Wp: WhitePoint,
    S::Space: RgbSpace<WhitePoint = Wp>, 

fn into_xyz(self) -> Xyz<Wp, T>

Convert into XYZ space

fn into_yxy(self) -> Yxy<Wp, T>

Convert into Yxy color space

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

Convert into L*a*b* color space

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

Convert into L*C*h° color space

fn into_rgb<Sp: RgbSpace<WhitePoint = Wp>>(self) -> Rgb<Linear<Sp>, T>

Convert into RGB color space.

fn into_hsl<Sp: RgbSpace<WhitePoint = Wp>>(self) -> Hsl<Sp, T>

Convert into HSL color space

fn into_hsv<Sp: RgbSpace<WhitePoint = Wp>>(self) -> Hsv<Sp, T>

Convert into HSV color space

fn into_hwb<Sp: RgbSpace<WhitePoint = Wp>>(self) -> Hwb<Sp, T>

Convert into HWB color space

fn into_luma(self) -> Luma<Wp, T>

Convert into Luma

impl<S, T> ApproxEq for Rgb<S, T> where
    T: Float + ApproxEq,
    T::Epsilon: Copy + Float,
    S: RgbStandard, 

type Epsilon = <T as ApproxEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

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

fn default_max_relative() -> Self::Epsilon

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

fn default_max_ulps() -> u32

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

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

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

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

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

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

The inverse of ApproxEq::relative_eq.

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

The inverse of ApproxEq::ulps_eq.

impl<S, T> From<Alpha<Rgb<S, T>, T>> for Rgb<S, T> where
    T: Float,
    S: RgbStandard, 

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

Performs the conversion.

impl<S, T> From<Color<S, T>> for Rgb<Linear<S>, T> where
    T: Float,
    S: RgbSpace, 

fn from(color: Color<S, T>) -> Rgb<Linear<S>, T>

Performs the conversion.

impl<S, T> From<Alpha<Color<S, T>, T>> for Rgb<Linear<S>, T> where
    T: Float,
    S: RgbSpace, 

fn from(color: Alpha<Color<S, T>, T>) -> Rgb<Linear<S>, T>

Performs the conversion.

impl<S, T> From<Xyz<S::WhitePoint, T>> for Rgb<Linear<S>, T> where
    T: Float,
    S: RgbSpace, 

fn from(other: Xyz<S::WhitePoint, T>) -> Rgb<Linear<S>, T>

Performs the conversion.

impl<S, T> From<Alpha<Xyz<S::WhitePoint, T>, T>> for Rgb<Linear<S>, T> where
    T: Float,
    S: RgbSpace, 

fn from(other: Alpha<Xyz<S::WhitePoint, T>, T>) -> Rgb<Linear<S>, T>

Performs the conversion.

impl<S, T> From<Yxy<S::WhitePoint, T>> for Rgb<Linear<S>, T> where
    T: Float,
    S: RgbSpace, 

fn from(other: Yxy<S::WhitePoint, T>) -> Rgb<Linear<S>, T>

Performs the conversion.

impl<S, T> From<Alpha<Yxy<S::WhitePoint, T>, T>> for Rgb<Linear<S>, T> where
    T: Float,
    S: RgbSpace, 

fn from(other: Alpha<Yxy<S::WhitePoint, T>, T>) -> Rgb<Linear<S>, T>

Performs the conversion.

impl<S, T> From<Lab<S::WhitePoint, T>> for Rgb<Linear<S>, T> where
    T: Float,
    S: RgbSpace, 

fn from(other: Lab<S::WhitePoint, T>) -> Rgb<Linear<S>, T>

Performs the conversion.

impl<S, T> From<Alpha<Lab<S::WhitePoint, T>, T>> for Rgb<Linear<S>, T> where
    T: Float,
    S: RgbSpace, 

fn from(other: Alpha<Lab<S::WhitePoint, T>, T>) -> Rgb<Linear<S>, T>

Performs the conversion.

impl<S, T> From<Lch<S::WhitePoint, T>> for Rgb<Linear<S>, T> where
    T: Float,
    S: RgbSpace, 

fn from(other: Lch<S::WhitePoint, T>) -> Rgb<Linear<S>, T>

Performs the conversion.

impl<S, T> From<Alpha<Lch<S::WhitePoint, T>, T>> for Rgb<Linear<S>, T> where
    T: Float,
    S: RgbSpace, 

fn from(other: Alpha<Lch<S::WhitePoint, T>, T>) -> Rgb<Linear<S>, T>

Performs the conversion.

impl<S, T> From<Hsl<S, T>> for Rgb<Linear<S>, T> where
    T: Float,
    S: RgbSpace, 

fn from(other: Hsl<S, T>) -> Rgb<Linear<S>, T>

Performs the conversion.

impl<S, T> From<Alpha<Hsl<S, T>, T>> for Rgb<Linear<S>, T> where
    T: Float,
    S: RgbSpace, 

fn from(other: Alpha<Hsl<S, T>, T>) -> Rgb<Linear<S>, T>

Performs the conversion.

impl<S, T> From<Hsv<S, T>> for Rgb<Linear<S>, T> where
    T: Float,
    S: RgbSpace, 

fn from(other: Hsv<S, T>) -> Rgb<Linear<S>, T>

Performs the conversion.

impl<S, T> From<Alpha<Hsv<S, T>, T>> for Rgb<Linear<S>, T> where
    T: Float,
    S: RgbSpace, 

fn from(other: Alpha<Hsv<S, T>, T>) -> Rgb<Linear<S>, T>

Performs the conversion.

impl<S, T> From<Hwb<S, T>> for Rgb<Linear<S>, T> where
    T: Float,
    S: RgbSpace, 

fn from(other: Hwb<S, T>) -> Rgb<Linear<S>, T>

Performs the conversion.

impl<S, T> From<Alpha<Hwb<S, T>, T>> for Rgb<Linear<S>, T> where
    T: Float,
    S: RgbSpace, 

fn from(other: Alpha<Hwb<S, T>, T>) -> Rgb<Linear<S>, T>

Performs the conversion.

impl<S, T> From<Luma<S::WhitePoint, T>> for Rgb<Linear<S>, T> where
    T: Float,
    S: RgbSpace, 

fn from(other: Luma<S::WhitePoint, T>) -> Rgb<Linear<S>, T>

Performs the conversion.

impl<S, T> From<Alpha<Luma<S::WhitePoint, T>, T>> for Rgb<Linear<S>, T> where
    T: Float,
    S: RgbSpace, 

fn from(other: Alpha<Luma<S::WhitePoint, T>, T>) -> Rgb<Linear<S>, T>

Performs the conversion.