Struct smol_rgb::LinearColor

pub struct LinearColor {
    pub r: f32,
    pub g: f32,
    pub b: f32,
    pub a: f32,
}

This is a Color in the linear space. This represents “linear sRGB”. You should use this color space when blending colors on the CPU or when sending uniforms to a linear card.

Colors on disc are EncodedColor, but to blend them correctly, you need to move them into the linear color space with to_linear.

You can directly create this struct, but you probably don’t want to. You’d need already linear sRGB to correctly make this struct – that’s possible to have, but generally, textures, color pickers (like photoshop), and outputted surface (like if you use a Color Picker on a game) will all be in the encoded sRGBA space. Exceptions abound though, so it is possible to directly create this color.

Fields

r: f32

The red component of the color.

g: f32

The green component of the color.

b: f32

The blue component of the color.

a: f32

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

Implementations

impl LinearColor

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

You probably don’t want to use this function. This creates a color in the LinearColor space directly. For this function to be valid, the colors given to this function must be in the linear space already.

pub fn to_encoded_space(self) -> EncodedColor

Transforms this color into the Encoded color space. Use this space to serialize colors.

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

Creates an array representation of the color. This is useful for sending the color to a uniform, but is the same memory representation as Self. LinearColor also implements Into, but this function is often more convenient.

pub fn to_bits(self) -> [u8; 16]

Encodes the 4 floats as 16 u8s. This is useful for sending the color to a uniform, but is the same memory representation as Self – ie, the bits have just been reinterpreted as 16 u8s, but they’re still secret floats.

pub fn from_bits(value: [u8; 16]) -> Self

Recasts four u8s into floats. Note: these floats could be subnormal if these u8s were produced incorrectly.

Trait Implementations

impl Clone for LinearColor

fn clone(&self) -> LinearColor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LinearColor

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

Formats the value using the given formatter.

impl Default for LinearColor

fn default() -> LinearColor

Returns the “default value” for a type.

impl Display for LinearColor

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

Formats the value using the given formatter.

impl From<[f32; 4]> for LinearColor

fn from(o: [f32; 4]) -> Self

Converts to this type from the input type.

impl From<(f32, f32, f32, f32)> for LinearColor

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

Converts to this type from the input type.

impl From<EncodedColor> for LinearColor

fn from(o: EncodedColor) -> Self

Converts to this type from the input type.

impl From<LinearColor> for [f32; 4]

fn from(o: LinearColor) -> Self

Converts to this type from the input type.

impl From<LinearColor> for (f32, f32, f32, f32)

fn from(o: LinearColor) -> Self

Converts to this type from the input type.

impl From<LinearColor> for EncodedColor

fn from(o: LinearColor) -> Self

Converts to this type from the input type.

impl PartialEq<LinearColor> for LinearColor

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

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

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

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

impl PartialOrd<LinearColor> for LinearColor

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

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

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

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

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

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

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

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

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 Copy for LinearColor

impl StructuralPartialEq for LinearColor