Struct palette::rgb::Rgb

#[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

red: T

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

green: T

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

blue: T

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

standard: PhantomData<S>

The kind of RGB standard. sRGB is the default.

Implementations

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

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

Create an RGB color.

pub fn into_format<U>(self) -> Rgb<S, U> where
    U: Component + FromComponent<T>, 

Convert into another component type.

pub fn from_format<U>(color: Rgb<S, U>) -> Self where
    T: FromComponent<U>,
    U: Component, 

Convert from another component type.

pub fn into_components(self) -> (T, T, T)

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

pub fn from_components((red, green, blue): (T, T, T)) -> Self

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

pub fn min_red() -> T

Return the red value minimum.

pub fn max_red() -> T

Return the red value maximum.

pub fn min_green() -> T

Return the green value minimum.

pub fn max_green() -> T

Return the green value maximum.

pub fn min_blue() -> T

Return the blue value minimum.

pub fn max_blue() -> T

Return the blue value maximum.

impl<S: RgbStandard> Rgb<S, u8>

Convenience functions to convert between a packed u32 and Rgb.

use palette::Srgb;

let rgb = Srgb::from(0x607F00);
assert_eq!(Srgb::new(96u8, 127, 0), rgb);

let integer = u32::from(rgb);
assert_eq!(0xFF607F00, integer);

pub fn into_u32<C: RgbChannels>(self) -> u32

Convert to a packed u32 with with specifiable component order. Defaults to ARGB ordering (0xAARRGGBB).

See Packed for more details.

pub fn from_u32<C: RgbChannels>(color: u32) -> Self

Convert from a packed u32 with specifiable component order. Defaults to ARGB ordering (0xAARRGGBB).

See Packed for more details.

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

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

Convert the color to linear RGB.

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

Convert linear RGB to nonlinear RGB.

pub fn into_encoding<St: RgbStandard<Space = S::Space>>(self) -> Rgb<St, T>

Convert the color to a different encoding.

pub fn from_encoding<St: RgbStandard<Space = S::Space>>(
    color: Rgb<St, T>
) -> Rgb<S, T>

Convert RGB from a different encoding.

Trait Implementations

impl<S, T> AbsDiffEq<Rgb<S, T>> for Rgb<S, T> where
    T: Component + AbsDiffEq,
    T::Epsilon: Copy,
    S: RgbStandard + PartialEq, 

type Epsilon = T::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

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

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

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

pub fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

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

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

The resulting type after applying the + operator.

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

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, 

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

The resulting type after applying the + operator.

fn add(self, c: T) -> Self::Output

Performs the + operation.

impl<S, T> AddAssign<Rgb<S, T>> for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Component + AddAssign, 

fn add_assign(&mut self, other: Rgb<S, T>)

Performs the += operation.

impl<S, T> AddAssign<T> for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Component + AddAssign, 

fn add_assign(&mut self, c: T)

Performs the += operation.

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

fn as_mut(&mut self) -> &mut P

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, P: ?Sized> AsRef<P> for Rgb<S, T> where
    T: Component,
    S: RgbStandard,
    P: RawPixel<T>, 

fn as_ref(&self) -> &P

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> Blend for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: FloatComponent, 

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> Clamp for Rgb<S, T> where
    S: RgbStandard,
    T: Component, 

fn is_within_bounds(&self) -> bool

Check if the color’s components are within the expected clamped range bounds.

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

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

fn clamp_self(&mut self)

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S, T> ComponentWise for Rgb<S, T> where
    S: RgbStandard,
    T: Component, 

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: Debug + RgbStandard, T: Debug + Component> Debug for Rgb<S, T>

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

Formats the value using the given formatter.

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

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

Returns the “default value” for a type.

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

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

The resulting type after applying the / operator.

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

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, 

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

The resulting type after applying the / operator.

fn div(self, c: T) -> Self::Output

Performs the / operation.

impl<S, T> DivAssign<Rgb<S, T>> for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Component + DivAssign, 

fn div_assign(&mut self, other: Rgb<S, T>)

Performs the /= operation.

impl<S, T> DivAssign<T> for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Component + DivAssign, 

fn div_assign(&mut self, c: T)

Performs the /= operation.

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

fn from(components: (T, T, T)) -> Self

Performs the conversion.

impl<S, C> From<Packed<C>> for Rgb<S, u8> where
    S: RgbStandard,
    C: RgbChannels, 

fn from(packed: Packed<C>) -> Self

Performs the conversion.

impl<T, U> From<Rgb<Linear<Srgb>, T>> for Srgb<U> where
    T: FloatComponent,
    U: Component + FromComponent<T>, 

fn from(lin_srgb: LinSrgb<T>) -> Self

Performs the conversion.

impl<T, U> From<Rgb<Linear<Srgb>, T>> for Srgba<U> where
    T: FloatComponent,
    U: Component + FromComponent<T>, 

fn from(lin_srgb: LinSrgb<T>) -> Self

Performs the conversion.

impl<S: RgbStandard> From<Rgb<S, u8>> for u32

fn from(color: Rgb<S, u8>) -> Self

Performs the conversion.

impl<S, C> From<Rgb<S, u8>> for Packed<C> where
    S: RgbStandard,
    C: RgbChannels, 

fn from(color: Rgb<S, u8>) -> Self

Performs the conversion.

impl<T, U> From<Rgb<Srgb, T>> for LinSrgb<U> where
    T: FloatComponent,
    U: Component + FromComponent<T>, 

fn from(srgb: Srgb<T>) -> Self

Performs the conversion.

impl<T, U> From<Rgb<Srgb, T>> for LinSrgba<U> where
    T: FloatComponent,
    U: Component + FromComponent<T>, 

fn from(srgb: Srgb<T>) -> Self

Performs the conversion.

impl<S: RgbStandard> From<u32> for Rgb<S, u8>

fn from(color: u32) -> Self

Performs the conversion.

impl<S: RgbStandard, T: Component, _C, _A> FromColorUnclamped<Alpha<_C, _A>> for Rgb<S, T> where
    T: FloatComponent,
    _C: IntoColorUnclamped<Self>,
    _A: Component, 

fn from_color_unclamped(color: Alpha<_C, _A>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Hsl<S, T>> for Rgb<S, T> where
    S: RgbStandard,
    T: FloatComponent, 

fn from_color_unclamped(hsl: Hsl<S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S: RgbStandard, T: Component> FromColorUnclamped<Hsluv<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Rgb<S, T> where
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(
    color: Hsluv<<S::Space as RgbSpace>::WhitePoint, T>
) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Hsv<S, T>> for Rgb<S, T> where
    S: RgbStandard,
    T: FloatComponent, 

fn from_color_unclamped(hsv: Hsv<S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S: RgbStandard, T: Component> FromColorUnclamped<Hwb<S, T>> for Rgb<S, T> where
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(color: Hwb<S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S: RgbStandard, T: Component> FromColorUnclamped<Lab<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Rgb<S, T> where
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(
    color: Lab<<S::Space as RgbSpace>::WhitePoint, T>
) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S: RgbStandard, T: Component> FromColorUnclamped<Lch<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Rgb<S, T> where
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(
    color: Lch<<S::Space as RgbSpace>::WhitePoint, T>
) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S: RgbStandard, T: Component> FromColorUnclamped<Lchuv<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Rgb<S, T> where
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(
    color: Lchuv<<S::Space as RgbSpace>::WhitePoint, T>
) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, St, T> FromColorUnclamped<Luma<St, T>> for Rgb<S, T> where
    S: RgbStandard,
    St: LumaStandard<WhitePoint = <S::Space as RgbSpace>::WhitePoint>,
    T: FloatComponent, 

fn from_color_unclamped(color: Luma<St, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S: RgbStandard, T: Component> FromColorUnclamped<Luv<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Rgb<S, T> where
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(
    color: Luv<<S::Space as RgbSpace>::WhitePoint, T>
) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Rgb<S, T>> for Hsl<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

fn from_color_unclamped(rgb: Rgb<S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Rgb<S, T>> for Hsv<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

fn from_color_unclamped(rgb: Rgb<S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Rgb<S, T>> for Hwb<S, T> where
    T: FloatComponent,
    S: RgbStandard,
    T: FloatComponent,
    T: FloatComponent, 

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

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, S> FromColorUnclamped<Rgb<S, T>> for Xyz<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    S: RgbStandard,
    S::Space: RgbSpace<WhitePoint = Wp>, 

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

Convert from T. The resulting color might be invalid in its color space.

impl<S1, S2, T> FromColorUnclamped<Rgb<S2, T>> for Rgb<S1, T> where
    S1: RgbStandard,
    S2: RgbStandard,
    S2::Space: RgbSpace<WhitePoint = <S1::Space as RgbSpace>::WhitePoint>,
    T: FloatComponent, 

fn from_color_unclamped(rgb: Rgb<S2, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, _S> FromColorUnclamped<Rgb<_S, T>> for Hsluv<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

fn from_color_unclamped(color: Rgb<_S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, _S> FromColorUnclamped<Rgb<_S, T>> for Lab<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

fn from_color_unclamped(color: Rgb<_S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, _S> FromColorUnclamped<Rgb<_S, T>> for Lch<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

fn from_color_unclamped(color: Rgb<_S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, _S> FromColorUnclamped<Rgb<_S, T>> for Lchuv<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

fn from_color_unclamped(color: Rgb<_S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T, _S> FromColorUnclamped<Rgb<_S, T>> for Luma<S, T> where
    T: Component,
    S: LumaStandard,
    T: FloatComponent,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = S::WhitePoint>, 

fn from_color_unclamped(color: Rgb<_S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, _S> FromColorUnclamped<Rgb<_S, T>> for Luv<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

fn from_color_unclamped(color: Rgb<_S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<Wp, T, _S> FromColorUnclamped<Rgb<_S, T>> for Yxy<Wp, T> where
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    Wp: WhitePoint,
    T: FloatComponent,
    _S: RgbStandard,
    _S::Space: RgbSpace<WhitePoint = Wp>, 

fn from_color_unclamped(color: Rgb<_S, T>) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S, T> FromColorUnclamped<Xyz<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Rgb<S, T> where
    S: RgbStandard,
    T: FloatComponent, 

fn from_color_unclamped(
    color: Xyz<<S::Space as RgbSpace>::WhitePoint, T>
) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S: RgbStandard, T: Component> FromColorUnclamped<Yxy<<<S as RgbStandard>::Space as RgbSpace>::WhitePoint, T>> for Rgb<S, T> where
    T: FloatComponent,
    T: FloatComponent, 

fn from_color_unclamped(
    color: Yxy<<S::Space as RgbSpace>::WhitePoint, T>
) -> Self

Convert from T. The resulting color might be invalid in its color space.

impl<S: RgbStandard> FromStr for Rgb<S, u8>

type Err = FromHexError

The associated error which can be returned from parsing.

fn from_str(hex: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

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

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: RgbStandard, T: Component> Into<(T, T, T)> for Rgb<S, T>

fn into(self) -> (T, T, T)

Performs the conversion.

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

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

Formats the value using the given formatter.

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

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> Mul<Rgb<S, T>> for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Component + Mul,
    <T as Mul>::Output: Component, 

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

The resulting type after applying the * operator.

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

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, 

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

The resulting type after applying the * operator.

fn mul(self, c: T) -> Self::Output

Performs the * operation.

impl<S, T> MulAssign<Rgb<S, T>> for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Component + MulAssign, 

fn mul_assign(&mut self, other: Rgb<S, T>)

Performs the *= operation.

impl<S, T> MulAssign<T> for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Component + MulAssign, 

fn mul_assign(&mut self, c: T)

Performs the *= operation.

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

fn eq(&self, other: &Self) -> bool

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

#[must_use]

pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

const CHANNELS: usize

The number of color channels.

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

Cast as a reference to raw color components.

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

Cast as a mutable reference to raw color components.

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

Convert into raw color components.

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

Cast from a reference to raw color components.

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

Cast from a mutable reference to raw color components.

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

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

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

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

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

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

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

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

impl<S, T> RelativeContrast for Rgb<S, T> where
    T: FloatComponent,
    S: RgbStandard, 

type Scalar = T

The type of the contrast ratio.

fn get_contrast_ratio(&self, other: &Self) -> T

Calculate the contrast ratio between two colors.

fn has_min_contrast_text(&self, other: &Self) -> bool

Verify the contrast between two colors satisfies SC 1.4.3. Contrast is at least 4.5:1 (Level AA).

fn has_min_contrast_large_text(&self, other: &Self) -> bool

Verify the contrast between two colors satisfies SC 1.4.3 for large text. Contrast is at least 3:1 (Level AA).

fn has_enhanced_contrast_text(&self, other: &Self) -> bool

Verify the contrast between two colors satisfies SC 1.4.6. Contrast is at least 7:1 (Level AAA).

fn has_enhanced_contrast_large_text(&self, other: &Self) -> bool

Verify the contrast between two colors satisfies SC 1.4.6 for large text. Contrast is at least 4.5:1 (Level AAA).

fn has_min_contrast_graphics(&self, other: &Self) -> bool

Verify the contrast between two colors satisfies SC 1.4.11 for graphical objects. Contrast is at least 3:1 (Level AA).

impl<S, T> RelativeEq<Rgb<S, T>> for Rgb<S, T> where
    T: Component + RelativeEq,
    T::Epsilon: Copy,
    S: RgbStandard + PartialEq, 

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for 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.

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

The inverse of RelativeEq::relative_eq.

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

type Scalar = T

The type of the lighten/darken modifier.

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

Scale the color towards the maximum lightness by factor, a value ranging from 0.0 to 1.0.

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

Lighten the color by amount, a value ranging from 0.0 to 1.0.

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

Scale the color towards the minimum lightness by factor, a value ranging from 0.0 to 1.0.

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

Darken the color by amount, a value ranging from 0.0 to 1.0.

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

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

The resulting type after applying the - operator.

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

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, 

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

The resulting type after applying the - operator.

fn sub(self, c: T) -> Self::Output

Performs the - operation.

impl<S, T> SubAssign<Rgb<S, T>> for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Component + SubAssign, 

fn sub_assign(&mut self, other: Rgb<S, T>)

Performs the -= operation.

impl<S, T> SubAssign<T> for Rgb<S, T> where
    S: RgbStandard<TransferFn = LinearFn>,
    T: Component + SubAssign, 

fn sub_assign(&mut self, c: T)

Performs the -= operation.

impl<S, T> UlpsEq<Rgb<S, T>> for Rgb<S, T> where
    T: Component + UlpsEq,
    T::Epsilon: Copy,
    S: RgbStandard + PartialEq, 

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that 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.

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

The inverse of UlpsEq::ulps_eq.

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

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

Formats the value using the given formatter.

impl<S: RgbStandard, T: Component, _A> WithAlpha<_A> for Rgb<S, T> where
    _A: Component, 

type Color = Self

The opaque color type, without any transparency.

type WithAlpha = Alpha<Self, _A>

The color type with transparency applied.

fn with_alpha(self, alpha: _A) -> Self::WithAlpha

Transforms the color into a transparent color with the provided alpha value. If Self already has a transparency, it is overwritten.

fn without_alpha(self) -> Self::Color

Removes the transparency from the color. If Self::Color has an internal transparency field, that field will be set to A::max_intensity() to make it opaque.

fn split(self) -> (Self::Color, _A)

Splits the color into separate color and transparency values.

fn opaque(self) -> Self::WithAlpha

Transforms the color into a fully opaque color with a transparency field. If Self already has a transparency, it is overwritten.

fn transparent(self) -> Self::WithAlpha

Transforms the color into a fully transparent color. If Self already has a transparency, it is overwritten.

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

impl<S, T> Eq for Rgb<S, T> where
    T: Component + Eq,
    S: RgbStandard,