Skip to main content

Color

Struct Color 

Source
pub struct Color { /* private fields */ }
Expand description

Linear RGBA color with channels in the 0.0..=1.0 range.

Constructors do not clamp so intermediate animation values can overshoot. Use Color::clamp before sending untrusted colors to a renderer.

Implementations§

Source§

impl Color

Source

pub const TRANSPARENT: Self

Fully transparent black.

Source

pub const WHITE: Self

Opaque white.

Source

pub const BLACK: Self

Opaque black.

Source

pub const fn rgb(r: f32, g: f32, b: f32) -> Self

Builds an opaque color from floating-point RGB channels.

Source

pub const fn rgba(r: f32, g: f32, b: f32, a: f32) -> Self

Builds a color from floating-point RGBA channels.

Source

pub const fn red(self) -> f32

Returns the red linear-light channel.

Source

pub const fn green(self) -> f32

Returns the green linear-light channel.

Source

pub const fn blue(self) -> f32

Returns the blue linear-light channel.

Source

pub const fn alpha(self) -> f32

Returns alpha coverage, where 0.0 is transparent and 1.0 is opaque.

Source

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

Builds an opaque linear color from 0..=255 sRGB channels.

Source

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

Builds a linear color from 0..=255 sRGB and alpha channels.

RGB channels are converted from sRGB to linear light. Alpha is linear coverage and is only normalized to 0.0..=1.0.

Source

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

Returns the same RGB color with a replaced alpha channel.

Source

pub fn scale_alpha(self, factor: f32) -> Self

Multiplies only the alpha channel by factor.

Source

pub fn is_finite(self) -> bool

Returns true when every channel is finite.

Source

pub fn is_normalized(self) -> bool

Returns true when every channel is finite and lies in 0.0..=1.0.

Source

pub fn clamp(self) -> Self

Sanitizes every channel to 0.0..=1.0.

NaN channels become 0.0. Infinite values clamp to the nearest bound.

Source

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

Returns clamped channels in RGBA order for GPU vertex data.

Source

pub fn to_wgpu(self) -> Color

Converts to the wgpu clear color type.

Trait Implementations§

Source§

impl Clone for Color

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Color

Source§

impl Debug for Color

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<Color> for Fill

Source§

fn from(color: Color) -> Self

Converts to this type from the input type.
Source§

impl Interpolate for Color

Source§

fn interpolate(self, end: Self, amount: f32) -> Self

Interpolates between self and end.
Source§

fn is_valid_interpolation_value(self) -> bool

Returns whether this value may be stored by a Tween. Read more
Source§

impl PartialEq for Color

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Color

Auto Trait Implementations§

§

impl Freeze for Color

§

impl RefUnwindSafe for Color

§

impl Send for Color

§

impl Sync for Color

§

impl Unpin for Color

§

impl UnsafeUnpin 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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

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<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,