Struct three_d::core::Color

pub struct Color {
    pub r: u8,
    pub g: u8,
    pub b: u8,
    pub a: u8,
}

Represents a color composed of a red, green and blue component. In addition, the alpha value determines the how transparent the color is (0 is fully transparent and 255 is fully opaque).

Fields

r: u8

Red component

g: u8

Green component

b: u8

Blue component

a: u8

Alpha component

Implementations

impl Color

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

Creates a new color with the given values.

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

Creates a new color with the given r, g and b values and an alpha value of 255.

pub fn from_rgb_slice(rgba: &[f32; 3]) -> Self

Creates a new color from three float elements where each element are in the range 0.0..=1.0.

pub fn from_rgba_slice(rgba: &[f32; 4]) -> Self

Creates a new color from four float elements where each element are in the range 0.0..=1.0.

pub const RED: Color

Opaque red

pub const GREEN: Color

Opaque green

pub const BLUE: Color

Opaque blue

pub const WHITE: Color

Opaque white

pub const BLACK: Color

Opaque black

pub fn to_vec3(&self) -> Vec3

Convert to Vec3 by mapping the red, green and blue component to the range 0.0..=1.0.

pub fn to_vec4(&self) -> Vec4

Convert to Vec4 by mapping each component to the range 0.0..=1.0.

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

Convert to a slice by mapping the red, green and blue component to the range 0.0..=1.0.

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

Convert to a slice by mapping each component to the range 0.0..=1.0.

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Color

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

Formats the value using the given formatter.

impl Default for Color

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Color

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 Color

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Color> for Color

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

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

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

This method tests for !=.

impl PartialOrd<Color> for Color

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

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

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

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

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

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

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

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

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

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

impl Copy for Color

impl Eq for Color

impl StructuralEq for Color

impl StructuralPartialEq for Color