Struct three_d::core::Color

source · [−]

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

Expand description

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

source

impl Color

source

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

Creates a new color with the given values.

source

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.

source

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.

source

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.

source

pub const RED: Color = Color::new_opaque(255, 0, 0)

Opaque red

source

pub const GREEN: Color = Color::new_opaque(0, 255, 0)

Opaque green

source

pub const BLUE: Color = Color::new_opaque(0, 0, 255)

Opaque blue

source

pub const WHITE: Color = Color::new_opaque(255, 255, 255)

Opaque white

source

pub const BLACK: Color = Color::new_opaque(0, 0, 0)

Opaque black

source

pub fn to_vec3(&self) -> Vec3

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

source

pub fn to_vec4(&self) -> Vec4

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

source

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.

source

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

source

impl Clone for Color

source

fn clone(&self) -> Color

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 Color

source

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

Formats the value using the given formatter. Read more

source

impl Default for Color

source

fn default() -> Self

Returns the “default value” for a type. Read more

source

impl Hash for Color

source

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

source

impl Ord for Color

source

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

source

impl PartialEq<Color> for Color

source

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

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

source

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

This method tests for !=.

source

impl PartialOrd<Color> for Color

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

impl UniformDataType for Color

Auto Trait Implementations

impl RefUnwindSafe for Color

impl Send for Color

impl Sync for Color

impl Unpin for Color

impl UnwindSafe for Color

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

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

source

Struct three_d::core::Color

Fields

Implementations

impl Color

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

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

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

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

pub const RED: Color = Color::new_opaque(255, 0, 0)

pub const GREEN: Color = Color::new_opaque(0, 255, 0)

pub const BLUE: Color = Color::new_opaque(0, 0, 255)

pub const WHITE: Color = Color::new_opaque(255, 255, 255)

pub const BLACK: Color = Color::new_opaque(0, 0, 0)

pub fn to_vec3(&self) -> Vec3

pub fn to_vec4(&self) -> Vec4

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

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

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

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

impl Debug for Color

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

impl Default for Color

fn default() -> Self

impl Hash for Color

fn hash<__H: Hasher>(&self, state: &mut __H)

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,

impl Ord for Color

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

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

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

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

impl PartialEq<Color> for Color

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

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

impl PartialOrd<Color> for Color

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

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

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

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

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

impl BufferDataType for Color

impl Copy for Color

impl Eq for Color

impl StructuralEq for Color

impl StructuralPartialEq for Color

impl TextureDataType for Color

impl UniformDataType for Color

Auto Trait Implementations

impl RefUnwindSafe for Color

impl Send for Color

impl Sync for Color

impl Unpin for Color

impl UnwindSafe for Color

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CallHasher for T where T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where H: Hash + ?Sized, B: BuildHasher,

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

fn hash<H: Hasher>(&self, state: &mut H)

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

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> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?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>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<T> AnyMapTrait for T where
T: 'static + Any + Clone + Send + Sync,