Struct regenboog::RgbaU8

pub struct RgbaU8 {
    pub red: u8,
    pub green: u8,
    pub blue: u8,
    pub alpha: u8,
}

A type which represents a color.

This color is defined by four components:

• red
• green
• blue
• alpha

Fields

red: u8

The red component

green: u8

The green component

blue: u8

The blue component

alpha: u8

The alpha component

Implementations

impl RgbaU8

pub const WHITE: RgbaU8

Pure white

pub const BLACK: RgbaU8

Pure black

pub const RED: RgbaU8

Red

pub const GREEN: RgbaU8

Green

pub const BLUE: RgbaU8

Blue

pub const fn rgb(red: u8, green: u8, blue: u8) -> RgbaU8

Construct a color from its red, green and blue components.

The alpha value is set to 255.

Examples

let swag_color = RgbaU8::rgb(160, 32, 240);
assert_eq!(swag_color.red  , 160);
assert_eq!(swag_color.green, 32 );
assert_eq!(swag_color.blue , 240);
assert_eq!(swag_color.alpha, 255);

pub const fn rgba(red: u8, green: u8, blue: u8, alpha: u8) -> RgbaU8

Construct a color from its red, green, blue and alpha components.

Examples

let swag_color_transparent = RgbaU8::rgba(160, 32, 240, 200);
assert_eq!(swag_color_transparent.red  , 160);
assert_eq!(swag_color_transparent.green, 32 );
assert_eq!(swag_color_transparent.blue , 240);
assert_eq!(swag_color_transparent.alpha, 200);

pub const fn with_red(self, red: u8) -> RgbaU8

Get a new color with the specified red component.

Examples

let yellow = RgbaU8::GREEN.with_red(255);
assert_eq!(yellow, RgbaU8::rgb(255, 255, 0));

pub const fn with_green(self, green: u8) -> RgbaU8

Get a new color with the specified green component.

Examples

let cyan = RgbaU8::BLUE.with_green(255);
assert_eq!(cyan, RgbaU8::rgb(0, 255, 255));

pub const fn with_blue(self, blue: u8) -> RgbaU8

Get a new color with the specified blue component.

Examples

let magenta = RgbaU8::BLUE.with_red(255);
assert_eq!(magenta, RgbaU8::rgb(255, 0, 255));

pub const fn with_alpha(self, alpha: u8) -> RgbaU8

Get a new color with the specified alpha component.

Examples

let transparent_blue = RgbaU8::BLUE.with_alpha(100);
assert_eq!(transparent_blue, RgbaU8::rgba(0, 0, 255, 100));

Trait Implementations

impl Clone for RgbaU8

fn clone(&self) -> RgbaU8

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for RgbaU8

impl Debug for RgbaU8

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

Formats the value using the given formatter.

impl Eq for RgbaU8

impl From<[f32; 3]> for RgbaU8

fn from(data: [f32; 3]) -> RgbaU8

Performs the conversion.

impl From<[f32; 4]> for RgbaU8

fn from(data: [f32; 4]) -> RgbaU8

Performs the conversion.

impl From<[u8; 3]> for RgbaU8

fn from(data: [u8; 3]) -> RgbaU8

Performs the conversion.

impl From<[u8; 4]> for RgbaU8

fn from(data: [u8; 4]) -> RgbaU8

Performs the conversion.

impl From<RgbaU8> for [u8; 3]

fn from(color: RgbaU8) -> [u8; 3]

Performs the conversion.

impl From<RgbaU8> for [u8; 4]

fn from(color: RgbaU8) -> [u8; 4]

Performs the conversion.

impl From<RgbaU8> for [f32; 3]

fn from(color: RgbaU8) -> [f32; 3]

Performs the conversion.

impl From<RgbaU8> for [f32; 4]

fn from(color: RgbaU8) -> [f32; 4]

Performs the conversion.

impl Hash for RgbaU8

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 Ord for RgbaU8

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<RgbaU8> for RgbaU8

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

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

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

This method tests for !=.

impl PartialOrd<RgbaU8> for RgbaU8

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

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

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

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

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

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

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

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

fn ge(&self, other: &RgbaU8) -> bool

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

impl StructuralEq for RgbaU8

impl StructuralPartialEq for RgbaU8