Struct Color 

pub struct Color { /* private fields */ }

The Color which is used for a Pixel.

You can create a Color as normal RGB or add an alpha channel to it.

Example

RGB Color

let color: Color = "ff0f00".parse().unwrap();
assert_eq!(color, Color::rgb(0xff, 0x0f, 0x00));
assert!(color.is_rgb())

RGBA Color

let color: Color = "ff0f00aa".parse().unwrap();
assert_eq!(color, Color::rgba(0xff, 0x0f, 0x00, 0xaa));
assert!(color.is_rgba())

Implementations

impl Color

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

Creates a new Color without an alpha channel.

let color = Color::rgb(0xff, 0x0f, 0x00);
assert!(color.is_rgb());
assert!(!color.is_rgba());

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

Creates a new Color with an alpha channel.

let color = Color::rgba(0xff, 0x0f, 0x00, 0xaa);
assert!(color.is_rgba());
assert!(!color.is_rgb());

pub fn rgb_values(&self) -> (u8, u8, u8)

Returns the rgb values of this Color.

assert_eq!((0xff, 0x0f, 0x00), Color::rgb(0xff, 0x0f, 0x00).rgb_values());

pub fn rgba_values(&self) -> (u8, u8, u8, Option<u8>)

Returns the rgb and the alpha value of this Color.

assert_eq!((0xff, 0x0f, 0x00, None), Color::rgb(0xff, 0x0f, 0x00).rgba_values());
assert_eq!((0xff, 0x0f, 0x00, Some(0xaa)), Color::rgba(0xff, 0x0f, 0x00, 0xaa).rgba_values());

pub fn is_rgb(&self) -> bool

Returns true if this Color doesn’t have an alpha channel.

let color = Color::rgb(0xff, 0x0f, 0x00);
assert!(color.is_rgb());
let color = Color::rgba(0xff, 0x0f, 0x00, 0xaa);
assert!(!color.is_rgb())

pub fn is_rgba(&self) -> bool

Returns true if this Color does have an alpha channel.

let color = Color::rgb(0xff, 0x0f, 0x00);
assert!(!color.is_rgba());
let color = Color::rgba(0xff, 0x0f, 0x00, 0xaa);
assert!(color.is_rgba())

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

Formats the value using the given formatter.

impl Display for Color

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

Formats the value using the given formatter.

impl FromStr for Color

type Err = ParseColorError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

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