Struct nannou_core::prelude::rgb::Rgb[][src]

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

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

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.

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

Used for specifying relative comparisons.

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

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

The inverse of ApproxEq::abs_diff_eq.

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

Performs the += operation. Read more

Performs the += operation. Read more

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);

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);

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

The scalar type for color components.

Perform a binary operation on this and an other color.

Perform a unary operation on this color.

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Deserialize this value from the given Serde deserializer. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

Performs the /= operation. Read more

Performs the /= operation. Read more

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

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 L*a*b* color space

Convert from L*C*h° color space

Convert from HWB color space

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

Calculate a hue if possible. Read more

Performs the conversion.

Convert into XYZ space

Convert into Yxy color space

Convert into L*a*b* color space

Convert into L*C*h° 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

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.

Formats the value using the given formatter.

The type of the mixing factor.

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

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

Performs the *= operation. Read more

Performs the *= operation. Read more

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

This method tests for !=.

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

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

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

The inverse of ApproxEq::relative_eq.

Serialize this value into the given Serde serializer. Read more

The type of the lighten/darken amount.

Lighten the color by amount.

Darken the color by amount.

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

Performs the -= operation. Read more

Performs the -= operation. Read more

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

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

The inverse of ApproxEq::ulps_eq.

Formats the value using the given formatter.

Auto Trait Implementations

Blanket Implementations

Convert the source color to the destination color using the specified method Read more

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

Convert the source color to the destination color using the specified method Read more

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

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Convert from T with values clamped to the color defined bounds Read more

Convert from T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more

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

Convert into T with values clamped to the color defined bounds Read more

Convert into T. The resulting color might be invalid in its color space Read more

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more

Performs the conversion.

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.