Struct Colour

pub struct Colour { /* private fields */ }

Implementations

impl Colour

pub const WHITE: Colour

pub const LIGHT_GREY: Colour

pub const GREY: Colour

pub const DARK_GREY: Colour

pub const BLACK: Colour

pub const ORANGE_RED: Colour

pub const ORANGE: Colour

pub const DARK_RED: Colour

pub const RED: Colour

pub const LIGHT_RED: Colour

pub const DARK_GREEN: Colour

pub const GREEN: Colour

pub const LIGHT_GREEN: Colour

pub const DARK_BLUE: Colour

pub const BLUE: Colour

pub const LIGHT_BLUE: Colour

pub const MAGENTA: Colour

pub const CYAN: Colour

pub const YELLOW: Colour

pub fn from_hex_str(hex: &str) -> Result<Color, ColourParseError>

Parses a string hex code into a Colour. The hex code is expected to be 3 or 6 characters long, using base 16 encoding.

This supports the following RGB formats …

• 123
• #123
• 0x123
• 112233
• #112233
• 0x112233

And the following RGBA formats …

• 1234
• #1234
• 0x1234
• 11223344
• #11223344
• 0x11223344

pub fn new_from_f32s(red: f32, green: f32, blue: f32, alpha: f32) -> Self

pub const fn new_from_u32s(red: u32, green: u32, blue: u32, alpha: u32) -> Self

pub const fn new_from_u8s(red: u8, green: u8, blue: u8, alpha: u8) -> Self

pub const fn new_from_rgba(rgba: u32) -> Self

pub fn red_f32(&self) -> f32

pub fn red_u32(&self) -> u32

pub fn red_u8(&self) -> u8

pub fn green_f32(&self) -> f32

pub fn green_u32(&self) -> u32

pub fn green_u8(&self) -> u8

pub fn blue_f32(&self) -> f32

pub fn blue_u32(&self) -> u32

pub fn blue_u8(&self) -> u8

pub fn alpha_f32(&self) -> f32

pub fn alpha_u32(&self) -> u32

pub fn alpha_u8(&self) -> u8

pub fn mix(self, other: Self, amount: f32) -> Self

pub fn mix_no_alpha(self, other: Self, amount: f32) -> Self

pub fn replace_alpha_f32(self, alpha: f32) -> Self

pub fn replace_alpha_u32(self, alpha: u32) -> Self

pub fn set_alpha_f32(&mut self, alpha: f32)

pub fn set_alpha_u32(&mut self, alpha: u32)

pub fn to_rgba_u32(self) -> u32

Trait Implementations

impl Add for Colour

type Output = Colour

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl AddAssign for Colour

fn add_assign(&mut self, other: 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 Div<f32> for Colour

type Output = Colour

The resulting type after applying the / operator.

fn div(self, val: f32) -> Self

Performs the / operation.

impl Div for Colour

type Output = Colour

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self

Performs the / operation.

impl DivAssign<f32> for Colour

fn div_assign(&mut self, val: f32)

Performs the /= operation.

impl DivAssign for Colour

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl Mul<f32> for Colour

type Output = Colour

The resulting type after applying the * operator.

fn mul(self, val: f32) -> Self

Performs the * operation.

impl Mul for Colour

type Output = Colour

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self

Performs the * operation.

impl MulAssign<f32> for Colour

fn mul_assign(&mut self, val: f32)

Performs the *= operation.

impl MulAssign for Colour

fn mul_assign(&mut self, other: Self)

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 Rem for Colour

type Output = Colour

The resulting type after applying the % operator.

fn rem(self, other: Self) -> Self

Performs the % operation.

impl Sub for Colour

type Output = Colour

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl SubAssign for Colour

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Copy for Colour

impl StructuralPartialEq for Colour