Struct mutils::Colour

source · [−]

pub struct Colour { /* private fields */ }

Implementations

source

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

source

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

source

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

source

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

source

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

source

pub fn red_f32(&self) -> f32

source

pub fn red_u32(&self) -> u32

source

pub fn red_u8(&self) -> u8

source

pub fn green_f32(&self) -> f32

source

pub fn green_u32(&self) -> u32

source

pub fn green_u8(&self) -> u8

source

pub fn blue_f32(&self) -> f32

source

pub fn blue_u32(&self) -> u32

source

pub fn blue_u8(&self) -> u8

source

pub fn alpha_f32(&self) -> f32

source

pub fn alpha_u32(&self) -> u32

source

pub fn alpha_u8(&self) -> u8

source

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

source

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

source

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

source

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

source

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

source

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

source

pub fn to_rgba_u32(self) -> u32

Trait Implementations

source

impl Add<Colour> for Colour

type Output = Colour

The resulting type after applying the + operator.

source

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

Performs the + operation. Read more

source

impl AddAssign<Colour> for Colour

source

fn add_assign(&mut self, other: Self)

Performs the += operation. Read more

source

impl Clone for Colour

source

fn clone(&self) -> Colour

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Colour

source

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

Formats the value using the given formatter. Read more

source

impl Div<Colour> for Colour

type Output = Colour

The resulting type after applying the / operator.

source

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

Performs the / operation. Read more

source

impl Div<f32> for Colour

type Output = Colour

The resulting type after applying the / operator.

source

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

Performs the / operation. Read more

source

impl DivAssign<Colour> for Colour

source

fn div_assign(&mut self, other: Self)

Performs the /= operation. Read more

source

impl DivAssign<f32> for Colour

source

fn div_assign(&mut self, val: f32)

Performs the /= operation. Read more

source

impl Mul<Colour> for Colour

type Output = Colour

The resulting type after applying the * operator.

source

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

Performs the * operation. Read more

source

impl Mul<f32> for Colour

type Output = Colour

The resulting type after applying the * operator.

source

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

Performs the * operation. Read more

source

impl MulAssign<Colour> for Colour

source

fn mul_assign(&mut self, other: Self)

Performs the *= operation. Read more

source

impl MulAssign<f32> for Colour

source

fn mul_assign(&mut self, val: f32)

Performs the *= operation. Read more

source

impl PartialEq<Colour> for Colour

source

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

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

source

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

This method tests for !=.

source

impl Rem<Colour> for Colour

type Output = Colour

The resulting type after applying the % operator.

source

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

Performs the % operation. Read more

source

impl Sub<Colour> for Colour

type Output = Colour

The resulting type after applying the - operator.

source

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

Performs the - operation. Read more

source

impl SubAssign<Colour> for Colour

source

fn sub_assign(&mut self, other: Self)

Performs the -= operation. Read more

source

impl Copy for Colour

source

impl StructuralPartialEq for Colour

Auto Trait Implementations

impl RefUnwindSafe for Colour

impl Send for Colour

impl Sync for Colour

impl Unpin for Colour

impl UnwindSafe for Colour

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T, Rhs, Output> NumOps<Rhs, Output> for T where
T: Mul<Rhs, Output = Output> + Div<Rhs, Output = Output> + Rem<Rhs, Output = Output> + Add<Rhs, Output = Output> + Sub<Rhs, Output = Output>,

Struct mutils::Colour

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>

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

type Output = Colour

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

impl AddAssign<Colour> for Colour

fn add_assign(&mut self, other: Self)

impl Clone for Colour

fn clone(&self) -> Colour

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

impl Debug for Colour

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

impl Div<Colour> for Colour

type Output = Colour

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

impl Div<f32> for Colour

type Output = Colour

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

impl DivAssign<Colour> for Colour

fn div_assign(&mut self, other: Self)

impl DivAssign<f32> for Colour

fn div_assign(&mut self, val: f32)

impl Mul<Colour> for Colour

type Output = Colour

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

impl Mul<f32> for Colour

type Output = Colour

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

impl MulAssign<Colour> for Colour

fn mul_assign(&mut self, other: Self)

impl MulAssign<f32> for Colour

fn mul_assign(&mut self, val: f32)

impl PartialEq<Colour> for Colour

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<T, Rhs, Output> NumOps<Rhs, Output> for T where
T: Mul<Rhs, Output = Output> + Div<Rhs, Output = Output> + Rem<Rhs, Output = Output> + Add<Rhs, Output = Output> + Sub<Rhs, Output = Output>,