Struct smol_rgb::EncodedRgb

#[repr(C)]pub struct EncodedRgb {
    pub r: u8,
    pub g: u8,
    pub b: u8,
    pub a: u8,
}

A color used in linear applications. On a technical level, this color is in sRGB; however, this name is not very clear.

In code, we will say that this Color is encoded. This is generally the same colorspace that texels in a texture are in. This color space is not valid to perform mixing operations between colors in, so we must convert this color space into a different color, LinearRgb, with to_linear before we do such operations.

Fields

r: u8

The red component of the color.

g: u8

The green component of the color.

b: u8

The blue component of the color.

a: u8

The alpha component of the color, normally the opacity in blending operations.

Implementations

impl EncodedRgb

pub const WHITE: EncodedRgb

A basic white (255, 255, 255, 255) with full opacity.

pub const BLACK: EncodedRgb

A basic black (0, 0, 0, 255) with full opacity.

pub const CLEAR: EncodedRgb

A black (0, 0, 0, 0) with zero opacity.

pub const FUCHSIA: EncodedRgb

God’s color (255, 0, 255, 255). The color of choice for graphics testing.

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

Creates a new encoded 32bit color.

pub fn to_linear(self) -> LinearRgb

Transforms this color into the Linear color space.

pub fn to_encoded_f32s(self) -> [f32; 4]

Converts this color to an [f32; 4] array. This is still in encoded space but they are converted to an f32. This is mostly for compatability with other libraries which sometimes need to f32s even while in encoded sRGB.

We use this dedicated function, rather than a From or Into because this is an unusual use of f32s, and in general, this module acts as if f32 == Linear and u8 == Encoded, though this is not technically true.

pub fn from_encoded_f32s(input: [f32; 4]) -> Self

Converts this color to an [f32; 4] array. This is still in encoded space but they are converted to an f32. This is mostly for compatability with other libraries which sometimes need to f32s even while in encoded sRGB.

We use this dedicated function, rather than a From or Into because this is an unusual use of f32s, and in general, this module acts as if f32 == Linear and u8 == Encoded, though this is not technically true.

pub const fn from_rgba_u32(input: u32) -> Self

Converts a packed u32 to an encoded rgba struct.

Note, your colors must be in order of red, green, blue, alpha. For bgra support, use from_bgra_u32.

This function might also has issues on non-little endian platforms, but look, you’re not on one of those.

pub const fn to_rgba_u32(self) -> u32

Converts the encoded rgba struct to a packed u32 in rgba encoding.

This will output your colors in order of red, green, blue, alpha. For bgra support, use to_bgra_u32.

This function might also have issues on non-little endian platforms, but look, you’re not on one of those.

pub const fn from_bgra_u32(input: u32) -> Self

Converts a packed u32 to an encoded rgba struct. On little endian platforms, this is a no-op.

Note, your colors must be in order of blue, green, red, alpha.

This function might also has issues on non-little endian platforms, but look, you’re not on one of those probably.

pub const fn to_bgra_u32(self) -> u32

Converts the encoded rgba struct to a packed u32 in bgra encoding.

This will output your colors in order of red, green, blue, alpha. For bgra support, use to_bgra_u32.

This function might also have issues on non-little endian platforms, but look, you’re not on one of those.

Trait Implementations

impl Clone for EncodedRgb

fn clone(&self) -> EncodedRgb

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for EncodedRgb

impl Debug for EncodedRgb

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

Formats the value using the given formatter.

impl Default for EncodedRgb

fn default() -> EncodedRgb

Returns the “default value” for a type.

impl Display for EncodedRgb

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

Formats the value using the given formatter.

impl Eq for EncodedRgb

impl From<(u8, u8, u8, u8)> for EncodedRgb

fn from(o: (u8, u8, u8, u8)) -> Self

Performs the conversion.

impl From<EncodedRgb> for LinearRgb

fn from(o: EncodedRgb) -> Self

Performs the conversion.

impl From<LinearRgb> for EncodedRgb

fn from(o: LinearRgb) -> Self

Performs the conversion.

impl Hash for EncodedRgb

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Into<(u8, u8, u8, u8)> for EncodedRgb

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

Performs the conversion.

impl LowerHex for EncodedRgb

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

Formats the value using the given formatter.

impl Ord for EncodedRgb

fn cmp(&self, other: &EncodedRgb) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<EncodedRgb> for EncodedRgb

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

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

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

This method tests for !=.

impl PartialOrd<EncodedRgb> for EncodedRgb

fn partial_cmp(&self, other: &EncodedRgb) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for EncodedRgb

impl StructuralPartialEq for EncodedRgb

impl UpperHex for EncodedRgb

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

Formats the value using the given formatter.