Struct picto::color::Rgb

pub struct Rgb<T = f32> where
    T: Float,  {
    pub red: T,
    pub green: T,
    pub blue: T,
}

Linear 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. This particular RGB type is based on the ITU-R BT.709 primaries, which makes it a linear version of sRGB.

Conversions and operations on this color space assumes 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 types.

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.

Implementations

impl<T> Rgb<T> where
    T: Float, 

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

Linear RGB.

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

Linear RGB from 8 bit values.

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

Linear RGB from a linear pixel value.

pub fn to_pixel<P>(&self) -> P where
    P: RgbPixel<T>, 

Convert to a linear RGB pixel. Rgb is already assumed to be linear, so the components will just be clamped to [0.0, 1.0] before conversion.

use palette::Rgb;

let c = Rgb::new(0.5, 0.3, 0.1);
assert_eq!((c.red, c.green, c.blue), c.to_pixel());
assert_eq!((0.5, 0.3, 0.1), c.to_pixel());

Trait Implementations

impl<T> Add<Rgb<T>> for Rgb<T> where
    T: Float, 

type Output = Rgb<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> Add<T> for Rgb<T> where
    T: Float, 

type Output = Rgb<T>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Epsilon = <T as ApproxEq>::Epsilon

Used for specifying relative comparisons.

pub fn default_epsilon() -> <Rgb<T> as ApproxEq>::Epsilon

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

pub fn default_max_relative() -> <Rgb<T> as ApproxEq>::Epsilon

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

pub fn default_max_ulps() -> u32

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

pub fn relative_eq(
    &self,
    other: &Rgb<T>,
    epsilon: <Rgb<T> as ApproxEq>::Epsilon,
    max_relative: <Rgb<T> as ApproxEq>::Epsilon
) -> bool

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

pub fn ulps_eq(
    &self,
    other: &Rgb<T>,
    epsilon: <Rgb<T> as ApproxEq>::Epsilon,
    max_ulps: u32
) -> bool

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

pub fn relative_ne(
    &self,
    other: &Rgb<T>,
    epsilon: <Rgb<T> as ApproxEq>::Epsilon,
    max_relative: <Rgb<T> as ApproxEq>::Epsilon
) -> bool

The inverse of ApproxEq::relative_eq.

pub fn ulps_ne(
    &self,
    other: &Rgb<T>,
    epsilon: <Rgb<T> as ApproxEq>::Epsilon,
    max_ulps: u32
) -> bool

The inverse of ApproxEq::ulps_eq.

impl<T> Blend for Rgb<T> where
    T: Float, 

type Color = Rgb<T>

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

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

Convert the color to premultiplied alpha.

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

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<T> Clone for Rgb<T> where
    T: Clone + Float, 

pub fn clone(&self) -> Rgb<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> ComponentWise for Rgb<T> where
    T: Float, 

type Scalar = T

The scalar type for color components.

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

Perform a binary operation on this and an other color.

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

Perform a unary operation on this color.

impl<T> Debug for Rgb<T> where
    T: Debug + Float, 

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

Formats the value using the given formatter.

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

pub fn default() -> Rgb<T>

Returns the “default value” for a type.

impl<T> Div<Rgb<T>> for Rgb<T> where
    T: Float, 

type Output = Rgb<T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T> Div<T> for Rgb<T> where
    T: Float, 

type Output = Rgb<T>

The resulting type after applying the / operator.

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

Performs the / operation.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

pub fn from(other: Alpha<Lab<T>, T>) -> Rgb<T>

Performs the conversion.

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

pub fn from(other: Alpha<Lch<T>, T>) -> Rgb<T>

Performs the conversion.

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

pub fn from(other: Alpha<Luma<T>, T>) -> Rgb<T>

Performs the conversion.

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

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

Performs the conversion.

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

pub fn from(other: Alpha<Xyz<T>, T>) -> Rgb<T>

Performs the conversion.

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

pub fn from(other: Alpha<Yxy<T>, T>) -> Rgb<T>

Performs the conversion.

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

pub fn from(color: Color<T>) -> Rgb<T>

Performs the conversion.

impl<T> From<GammaRgb<T>> for Rgb<T> where
    T: Float, 

pub fn from(gamma_rgb: GammaRgb<T>) -> Rgb<T>

Performs the conversion.

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

pub fn from(other: Hsl<T>) -> Rgb<T>

Performs the conversion.

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

pub fn from(other: Hsv<T>) -> Rgb<T>

Performs the conversion.

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

pub fn from(other: Hwb<T>) -> Rgb<T>

Performs the conversion.

impl<T> From<Lab<T>> for Rgb<T> where
    T: Float, 

pub fn from(other: Lab<T>) -> Rgb<T>

Performs the conversion.

impl<T> From<Lch<T>> for Rgb<T> where
    T: Float, 

pub fn from(other: Lch<T>) -> Rgb<T>

Performs the conversion.

impl<T> From<Luma<T>> for Rgb<T> where
    T: Float, 

pub fn from(other: Luma<T>) -> Rgb<T>

Performs the conversion.

impl<T> From<Rgb<T>> for Luma<T> where
    T: Float, 

pub fn from(other: Rgb<T>) -> Luma<T>

Performs the conversion.

impl<T> From<Rgb<T>> for Lab<T> where
    T: Float, 

pub fn from(other: Rgb<T>) -> Lab<T>

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<T> From<Rgb<T>> for Xyz<T> where
    T: Float, 

pub fn from(other: Rgb<T>) -> Xyz<T>

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<T> From<Rgb<T>> for Lch<T> where
    T: Float, 

pub fn from(other: Rgb<T>) -> Lch<T>

Performs the conversion.

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

pub fn from(other: Rgb<T>) -> Hwb<T>

Performs the conversion.

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

pub fn from(other: Rgb<T>) -> Hsl<T>

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<T> From<Rgb<T>> for Yxy<T> where
    T: Float, 

pub fn from(other: Rgb<T>) -> Yxy<T>

Performs the conversion.

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

pub fn from(other: Rgb<T>) -> Hsv<T>

Performs the conversion.

impl<T> From<Rgb<T>> for Srgb<T> where
    T: Float, 

pub fn from(rgb: Rgb<T>) -> Srgb<T>

Performs the conversion.

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

pub fn from(color: Rgb<T>) -> Color<T>

Performs the conversion.

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

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

Performs the conversion.

impl<T> From<Srgb<T>> for Rgb<T> where
    T: Float, 

pub fn from(srgb: Srgb<T>) -> Rgb<T>

Performs the conversion.

impl<T> From<Xyz<T>> for Rgb<T> where
    T: Float, 

pub fn from(other: Xyz<T>) -> Rgb<T>

Performs the conversion.

impl<T> From<Yxy<T>> for Rgb<T> where
    T: Float, 

pub fn from(other: Yxy<T>) -> Rgb<T>

Performs the conversion.

impl<T> FromColor<T> for Rgb<T> where
    T: Float, 

pub fn from_xyz(xyz: Xyz<T>) -> Rgb<T>

Convert from XYZ color space

pub fn from_rgb(rgb: Rgb<T>) -> Rgb<T>

Convert from RGB color space

pub fn from_hsl(hsl: Hsl<T>) -> Rgb<T>

Convert from HSL color space

pub fn from_hsv(hsv: Hsv<T>) -> Rgb<T>

Convert from HSV color space

pub fn from_luma(luma: Luma<T>) -> Rgb<T>

Convert from Luma

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

Convert from Yxy color space

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

Convert from Lab* color space

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

Convert from LCh° color space

fn from_hwb(inp: Hwb<T>) -> Self

Convert from HWB color space

impl<T> GetHue for Rgb<T> where
    T: Float, 

type Hue = RgbHue<T>

The kind of hue unit this color space uses.

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

Calculate a hue if possible.

impl<T> IntoColor<T> for Rgb<T> where
    T: Float, 

pub fn into_xyz(self) -> Xyz<T>

Convert into XYZ space

pub fn into_yxy(self) -> Yxy<T>

Convert into Yxy color space

pub fn into_lab(self) -> Lab<T>

Convert into Lab* color space

pub fn into_lch(self) -> Lch<T>

Convert into LCh° color space

pub fn into_rgb(self) -> Rgb<T>

Convert into RGB color space.

pub fn into_hsl(self) -> Hsl<T>

Convert into HSL color space

pub fn into_hsv(self) -> Hsv<T>

Convert into HSV color space

pub fn into_luma(self) -> Luma<T>

Convert into Luma

fn into_hwb(self) -> Hwb<T>

Convert into HWB color space

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

pub fn is_valid(&self) -> bool

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

pub fn clamp(&self) -> Rgb<T>

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

pub fn clamp_self(&mut self)

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

impl<T> Mix for Rgb<T> where
    T: Float, 

type Scalar = T

The type of the mixing factor.

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

Mix the color with an other color, by factor.

impl<T> Mul<Rgb<T>> for Rgb<T> where
    T: Float, 

type Output = Rgb<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> Mul<T> for Rgb<T> where
    T: Float, 

type Output = Rgb<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> PartialEq<Rgb<T>> for Rgb<T> where
    T: PartialEq<T> + Float, 

pub fn eq(&self, other: &Rgb<T>) -> bool

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

pub fn ne(&self, other: &Rgb<T>) -> bool

This method tests for !=.

impl<C: Channel, T: Float + 'static> Pixel<C> for Rgb<T>

fn channels() -> usize

The number of channels in the Pixel.

impl<T: Float + 'static> Read<f32> for Rgb<T>

fn read(data: &[f32]) -> Self

Read a Pixel from the slice.

impl<T: Float + 'static> Read<f64> for Rgb<T>

fn read(data: &[f64]) -> Self

Read a Pixel from the slice.

impl<T: Float + 'static> Read<u16> for Rgb<T>

fn read(data: &[u16]) -> Self

Read a Pixel from the slice.

impl<T: Float + 'static> Read<u32> for Rgb<T>

fn read(data: &[u32]) -> Self

Read a Pixel from the slice.

impl<T: Float + 'static> Read<u8> for Rgb<T>

fn read(data: &[u8]) -> Self

Read a Pixel from the slice.

impl<T> Shade for Rgb<T> where
    T: Float, 

type Scalar = T

The type of the lighten/darken amount.

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

Lighten the color by amount.

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

Darken the color by amount.

impl<T> Sub<Rgb<T>> for Rgb<T> where
    T: Float, 

type Output = Rgb<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Sub<T> for Rgb<T> where
    T: Float, 

type Output = Rgb<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<C: Channel, T: Float + 'static> Write<C> for Rgb<T>

fn write(&self, data: &mut [C])

Write the Pixel to the slice.

impl<T> Copy for Rgb<T> where
    T: Copy + Float, 

impl<T> StructuralPartialEq for Rgb<T> where
    T: Float,