Struct Color

#[repr(align(4))]
pub struct Color { /* private fields */ }

Struct representing a color value.

This color uses 4 channels, for red, green, blue and alpha. Each channel may be a value from 0 to 255.

Internally, this struct stores the color channels as a single u32 (DWORD) value, which is aligned to 4 bytes in memory. This allows atomic use when directly writing the value in most cases (but not all!).

Implementations

impl Color

pub fn new(value: u32) -> Self

Construct a new color, from a raw color value.

This color value defines the value of all 4 color channels.

pub fn from_rgb(r: u8, g: u8, b: u8) -> Self

Construct a new color, from RGB values.

The alpha channel will be set to 0xFF.

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

Construct a new color, from RGBA values.

pub fn red(&self) -> u32

Get the red value, in the range [0, 255).

pub fn green(&self) -> u32

Get green green value, in the range [0, 255).

pub fn blue(&self) -> u32

Get the blue value, in the range [0, 255).

pub fn alpha(&self) -> u32

Get the alpha value, in the range [0, 255).

pub fn from_hex(value: &str) -> Result<Self, ParseIntError>

Construct a new color, from the given hexadecimal string.

If parsing the hexadecimal string failed, an error is returned.

pub fn from_hex_raw(value: &[u8]) -> Result<Self, ParseColorError>

Construct a new color, from the given slice. The slice should represent hexadecimal characters as ASCII characters, meaning that they should be between b’0’ and b’9’, between b’a’ and b’f’, or between b’A’ and b’F’

pub fn hex(&self) -> String

Get the hexadecimal value of the color.

pub fn black() -> Self

A black color, with the default alpha.

pub fn to_raw(&self) -> u32

Get the raw color value, as single u32.

pub fn blend(&mut self, other: Color)

Blend this color with another

Self should be the current value, and other should be the incoming value

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Color

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

Nicely format the color in a human readable RGB(A) format.

impl PartialEq for Color

fn eq(&self, other: &Color) -> 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 Copy for Color

impl StructuralPartialEq for Color