Struct Colour

pub struct Colour {
    pub r: u8,
    pub g: u8,
    pub b: u8,
}

A struct to store colour values. Can be created from RGB, HSV or greyscale values, but is ultimately stored as RGB.

Fields

r: u8

The red channel of the colour

g: u8

The green channel of the colour

b: u8

The blue channel of the colour

Implementations

impl Colour

pub const BLACK: Self

A white Colour of RGB (0,0,0)

pub const WHITE: Self

A white Colour of RGB (255,255,255)

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

Create a Colour from an RGB value

pub fn hsv(hue: u8, sat: u8, val: u8) -> Self

Create a Colour from an HSV value

pub const fn greyscale(v: u8) -> Self

Create a Colour from a single brightness value, resulting in a shade of grey

Trait Implementations

impl Add for Colour

type Output = Colour

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for Colour

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Colour

fn clone(&self) -> Colour

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Colour

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

Formats the value using the given formatter.

impl FromStr for Colour

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

Colours should be passed in the format <r>,<g>,<b>, for example 255,0,0 for red

type Err = String

The associated error which can be returned from parsing.

impl Mul<f64> for Colour

type Output = Colour

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self::Output

Performs the * operation.

impl MulAssign<f64> for Colour

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

impl PartialEq for Colour

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

impl Eq for Colour

impl StructuralPartialEq for Colour