Struct TheColor 

pub struct TheColor {
    pub r: f32,
    pub g: f32,
    pub b: f32,
    pub a: f32,
    pub name: String,
}

Holds a normalized color value and offers several import and export methods.

Fields

r: f32

g: f32

b: f32

a: f32

name: String

Implementations

impl TheColor

pub fn new(r: f32, g: f32, b: f32, a: f32) -> TheColor

Creates a color from u8 values.

pub fn from_hsl(h: f32, s: f32, l: f32) -> TheColor

Creates a color from hsl.

pub fn from_u8(r: u8, g: u8, b: u8, a: u8) -> TheColor

Creates a color from u8 values.

pub fn from_u8_array(color: [u8; 4]) -> TheColor

Creates a color from 4 u8 values.

pub fn from_u8_array_3(color: [u8; 3]) -> TheColor

Creates a color from 3 u8 values.

pub fn from_vec3(color: Vec3<f32>) -> TheColor

Creates a color from an vec3.

pub fn from_vec4f(color: Vec4<f32>) -> TheColor

Creates a color from an vec4.

pub fn from_hex(hex_color: &str) -> TheColor

Creates a color from a hex value.

pub fn to_hex(&self) -> String

Converts the color to a hexadecimal string.

pub fn white() -> TheColor

Creates a white color.

pub fn gray() -> TheColor

Creates a gray.

pub fn black() -> TheColor

Creates a black color.

pub fn transparent() -> TheColor

Creates a transparent color.

pub fn to_array(&self) -> [f32; 4]

Creates an [f32;4] array

pub fn to_array_3(&self) -> [f32; 3]

Creates an [f32;3] array

pub fn to_u8_array_3(&self) -> [u8; 3]

Creates an [u8;3] array

pub fn to_u8_array(&self) -> [u8; 4]

Creates an [u8;4] array

pub fn to_vec3(&self) -> Vec3<f32>

Convert the color to Vec3f.

pub fn to_vec4(&self) -> Vec4<f32>

Convert the color to Vec4f.

pub fn as_srgba(&self) -> TheColor

pub fn as_hsl(&self) -> Vec3<f32>

Convert the color to HSL

pub fn lighten_darken(&self, amount: f32) -> TheColor

Lights or darken the color by the given amount.

pub fn mix(&self, other: &TheColor, v: f32) -> TheColor

Returns a new color as a mix between self and other.

Trait Implementations

impl Clone for TheColor

fn clone(&self) -> TheColor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TheColor

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

Formats the value using the given formatter.

impl Default for TheColor

fn default() -> TheColor

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TheColor

fn deserialize<__D>( __deserializer: __D, ) -> Result<TheColor, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for TheColor

fn from(color: &str) -> TheColor

Converts to this type from the input type.

impl From<[f32; 3]> for TheColor

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

Converts to this type from the input type.

impl From<[u8; 3]> for TheColor

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

Converts to this type from the input type.

impl From<[u8; 4]> for TheColor

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

Converts to this type from the input type.

impl From<(f32, f32, f32)> for TheColor

fn from(color: (f32, f32, f32)) -> TheColor

Converts to this type from the input type.

impl From<Vec3<f32>> for TheColor

fn from(color: Vec3<f32>) -> TheColor

Converts to this type from the input type.

impl From<Vec4<f32>> for TheColor

fn from(color: Vec4<f32>) -> TheColor

Converts to this type from the input type.

impl Index<usize> for TheColor

type Output = f32

The returned type after indexing.

fn index(&self, index: usize) -> &<TheColor as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for TheColor

fn index_mut(&mut self, index: usize) -> &mut <TheColor as Index<usize>>::Output

Performs the mutable indexing (container[index]) operation.

impl PartialEq for TheColor

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.