Struct pixelflut::Color

pub struct Color {
    pub r: u8,
    pub g: u8,
    pub b: u8,
    pub a: Option<u8>,
}

RGB color type with optional alpha channel

Fields

r: u8

g: u8

b: u8

a: Option<u8>

Implementations

impl Color

pub const fn rgb(r: u8, g: u8, b: u8) -> Color

Constructs a new Color without using an alpha channel.

Examples

Basic usage:

use pixelflut::Color;
Color::rgb(255, 255, 255);

pub const fn rgba(r: u8, g: u8, b: u8, a: u8) -> Color

Constructs a new Color using an alpha channel.

Examples

Basic usage:

use pixelflut::Color;
Color::rgba(255, 255, 255, 255);

pub const fn alpha(self) -> u8

Returns the alpha channel of the Color.

If the color does not have an alpha channel, 255 will be returned.

Example

use pixelflut::Color;

let without_alpha = Color::rgb(123, 123, 123);
assert_eq!(without_alpha.alpha(), 255);

let with_alpha = Color::rgba(123, 123, 123, 123);
assert_eq!(with_alpha.alpha(), 123)

pub const fn packed(r: u8, g: u8, b: u8, a: u8) -> Color

Constructs a new Color using the alpha channel only, if a != 255.

Examples

Basic usage:

use pixelflut::Color;
assert_eq!(Color::packed(123, 23, 42, 255), Color::rgb(123, 23, 42));
assert_eq!(Color::packed(123, 23, 42, 64), Color::rgba(123, 23, 42, 64));

pub const fn pack(&self) -> Color

Strips the alpha channel if not existent or value is 255.Color

Examples

Basic usage:

use pixelflut::Color;
assert_eq!(Color::rgba(12, 34, 56, 255).pack(), Color::rgb(12, 34, 56));
assert_eq!(Color::rgb(12, 34, 56).pack(), Color::rgb(12, 34, 56));
assert_eq!(Color::rgba(12, 34, 56, 78).pack(), Color::rgba(12, 34, 56, 78));

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

Returns a 4-Tuple with the components red, green, blue and alpha

If no alpha channel is present, 255 is returned as the alpha channel.

Examples

use pixelflut::Color;
assert_eq!((255, 0, 0, 255), Color::rgb(255, 0, 0).normalized())

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

Returns a copy 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

Formats the value using the given formatter.

impl Default for Color

fn default() -> Color

Returns the “default value” for a type.

impl Display for Color

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

Formats the value using the given formatter.

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

fn from(color: (u8, u8, u8, u8)) -> Color

Returns a RGBA Color

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

fn from(color: (u8, u8, u8)) -> Color

Returns a RGB Color

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

fn from(color: Color) -> (u8, u8, u8)

Performs the conversion.

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

fn from(color: Color) -> (u8, u8, u8, u8)

Performs the conversion.

impl From<Rgb<u8>> for Color

fn from(color: Rgb<u8>) -> Color

Returns a Rgb Color

impl From<Rgba<u8>> for Color

fn from(color: Rgba<u8>) -> Color

Returns a Rgba Color

impl FromStr for Color

fn from_str(s: &str) -> PixelflutResult<Color>

Converts a string to a color

Examples

use pixelflut::Color;
assert_eq!(Color::rgb(0x11, 0x22, 0x33), "112233".parse().unwrap());
assert_eq!(Color::rgba(0x11, 0x22, 0x33, 0xee), "112233ee".parse().unwrap());
assert!("".parse::<Color>().is_err());
assert!("123".parse::<Color>().is_err());
assert!("12345".parse::<Color>().is_err());
assert!(" 1 2 3".parse::<Color>().is_err());
assert!("112g33".parse::<Color>().is_err());

type Err = PixelflutError

The associated error which can be returned from parsing.

impl Hash for Color

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, 

Feeds a slice of this type into the given Hasher.

impl Into<Rgb<u8>> for Color

fn into(self) -> Rgb<u8>

Performs the conversion.

impl Into<Rgba<u8>> for Color

fn into(self) -> Rgba<u8>

Performs the conversion.

impl PartialEq<Color> for Color

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

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

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

This method tests for !=.

impl Copy for Color

impl StructuralPartialEq for Color