Struct Rgb

#[repr(C)]
pub struct Rgb<T, const LINEAR: bool = false> {
    pub c: [T; 3],
}

Available on crate feature color only.

RGB color with 3 components.

Fields

c: [T; 3]

Color channels in order: [red, green, blue].

• Red/Green/Blue: Gamma-encoded luminosity (0..=255).

Implementations

impl Rgb<u8>

pub const fn new(r: u8, g: u8, b: u8) -> Rgb8

New Rgb<u8>.

pub const fn red(self) -> u8

The red component.

pub const fn r(self) -> u8

pub const fn green(self) -> u8

The green component.

pub const fn g(self) -> u8

pub const fn blue(self) -> u8

The blue component.

pub const fn b(self) -> u8

impl Rgb<u8>

General conversions

pub const fn from_array(c: [u8; 3]) -> Rgb8

Create from an array.

pub const fn as_array(self) -> [u8; 3]

Convert to an array.

pub const fn from_tuple(c: (u8, u8, u8)) -> Rgb8

Create from a tuple.

pub const fn to_tuple(self) -> (u8, u8, u8)

Convert to a tuple.

pub const fn from_rgba8(c: Rgba8) -> Rgb8

Create from Rgba<u8>.

Loses the alpha channel.

pub const fn to_rgba8(self, alpha: u8) -> Rgba8

Convert to Rgba<u8>.

Adds the given alpha channel.

pub const fn from_rgb8_packed(packed: u32) -> Rgb8

Create from a packed u32 in 0xRRGGBB format.

Any bits above 0x00FF_FFFF are ignored.

pub const fn to_rgb8_packed(self) -> u32

Convert to a packed u32 in 0xRRGGBB format.

pub const fn from_rgba8_packed(packed: u32) -> Rgb8

Create from a packed u32 in 0xRRGGBBAA format, discarding alpha.

pub const fn to_rgba8_packed(self, alpha: u8) -> u32

Convert to a packed u32 in 0xRRGGBBAA format, with the given alpha.

pub fn from_rgb16(from: Rgb16) -> Rgb8

Convert to Rgba<u8> by scaling each component proportionally.

pub fn to_rgb16(self) -> Rgb16

Create from Rgb<u16> by scaling each component proportionally.

impl Rgb<u8>

f64 conversions

pub const fn from_rgb_f64(c: RgbF64) -> Rgb8

Available on crate feature _float_f64 only.

Create from Rgb<f64>.

pub const fn to_rgb_f64(self) -> RgbF64

Available on crate feature _float_f64 only.

Convert to Rgb<f64>.

pub const fn from_rgba_f64(c: RgbaF64) -> Rgb8

Available on crate feature _float_f64 only.

Create from Rgba<f64>.

Loses the alpha channel.

pub const fn to_rgba_f64(self, alpha: u8) -> RgbaF64

Available on crate feature _float_f64 only.

Convert to Rgba<f64>.

Adds the given alpha channel.

impl Rgb<u16>

pub const fn new(r: u16, g: u16, b: u16) -> Rgb16

New Rgb<u16>.

pub const fn red(self) -> u16

The red component.

pub const fn r(self) -> u16

pub const fn green(self) -> u16

The green component.

pub const fn g(self) -> u16

pub const fn blue(self) -> u16

The blue component.

pub const fn b(self) -> u16

impl Rgb<u16>

General conversions

pub const fn from_array(c: [u16; 3]) -> Rgb16

Create from an array.

pub const fn as_array(self) -> [u16; 3]

Convert to an array.

pub const fn from_tuple(c: (u16, u16, u16)) -> Rgb16

Create from a tuple.

pub const fn to_tuple(self) -> (u16, u16, u16)

Convert to a tuple.

pub const fn from_rgba16(c: Rgba16) -> Rgb16

Create from Rgba<u16>.

Loses the alpha channel.

pub const fn to_rgba16(self, alpha: u16) -> Rgba16

Convert to Rgba<u16>.

Adds the given alpha channel.

pub const fn from_rgb16_packed(packed: u64) -> Rgb16

Create from a packed u64 in 0xRRRRGGGGBBBB format.

Any bits above 0x0000_FFFF_FFFF_FFFF are ignored.

pub const fn to_rgb16_packed(self) -> u64

Convert to a packed u64 in 0xRRRRGGGGBBBB format.

pub const fn from_rgba16_packed(packed: u64) -> Rgb16

Create from a packed u64 in 0xRRRRGGGGBBBBAAAA format, discarding alpha.

pub const fn to_rgba16_packed(self, alpha: u16) -> u64

Convert to a packed u64 in 0xRRRRGGGGBBBBAAAA format, with the given alpha.

impl Rgb<u16>

f64 conversions

pub const fn from_rgb_f64(c: RgbF64) -> Rgb16

Available on crate feature _float_f64 only.

Create from Rgb<f64>.

pub const fn to_rgb_f64(self) -> RgbF64

Available on crate feature _float_f64 only.

Convert to Rgb<f64>.

pub const fn from_rgba_f64(c: RgbaF64) -> Rgb16

Available on crate feature _float_f64 only.

Create from Rgba<f64>.

Loses the alpha channel.

pub const fn to_rgba_f64(self, alpha: u16) -> RgbaF64

Available on crate feature _float_f64 only.

Convert to Rgba<f64>.

Adds the given alpha channel.

impl Rgb<f64>

pub const fn new(r: f64, g: f64, b: f64) -> RgbF64

New RgbF64.

pub const fn red(self) -> f64

The red component.

pub const fn r(self) -> f64

pub const fn green(self) -> f64

The green component.

pub const fn g(self) -> f64

pub const fn blue(self) -> f64

The blue component.

pub const fn b(self) -> f64

Trait Implementations

impl<T: Clone, const LINEAR: bool> Clone for Rgb<T, LINEAR>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, const LINEAR: bool> Debug for Rgb<T, LINEAR>

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

Formats the value using the given formatter.

impl<T: Default, const LINEAR: bool> Default for Rgb<T, LINEAR>

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

Returns the “default value” for a type.

impl From<Rgb<u16>> for Rgb8

fn from(from: Rgb16) -> Rgb8

Converts to this type from the input type.

impl From<Rgb<u16>> for Rgba16

fn from(from: Rgb16) -> Rgba16

Converts to this type from the input type.

impl From<Rgb<u8>> for Rgba8

fn from(from: Rgb8) -> Rgba8

Converts to this type from the input type.

impl<T: Hash, const LINEAR: bool> Hash for Rgb<T, LINEAR>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord, const LINEAR: bool> Ord for Rgb<T, LINEAR>

fn cmp(&self, other: &Rgb<T, LINEAR>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq, const LINEAR: bool> PartialEq for Rgb<T, LINEAR>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd, const LINEAR: bool> PartialOrd for Rgb<T, LINEAR>

fn partial_cmp(&self, other: &Rgb<T, LINEAR>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Copy, const LINEAR: bool> Copy for Rgb<T, LINEAR>

impl<T: Eq, const LINEAR: bool> Eq for Rgb<T, LINEAR>

impl<T, const LINEAR: bool> StructuralPartialEq for Rgb<T, LINEAR>