Skip to main content

Color

Struct Color 

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

A struct representing a color with red, green, blue, and alpha components. Each component is stored as a float.

Implementations§

Source§

impl Color

Source

pub const TRANSPARENT: Color

Color constant for transparency, with the alpha value set to zero.

Source

pub const BLACK: Color

Constant for the color black.

Source

pub const WHITE: Color

Constant for the color white.

Source

pub const RED: Color

Constant for the color red.

Source

pub const GREEN: Color

Constant for the color green.

Source

pub const BLUE: Color

Constant for the color blue.

Source

pub const YELLOW: Color

Constant for the color yellow.

Source

pub const CYAN: Color

Constant for the color cyan.

Source

pub const MAGENTA: Color

Constant for the color magenta.

Source

pub const GRAY: Color

Constant for the color gray.

Source

pub const LIGHT_GRAY: Color

Constant for the color light gray.

Source

pub const DARK_GRAY: Color

Constant for the color dark gray.

Source

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

Creates a color with the specified components, including an alpha component. Each component should be in the range 0.0 to 1.0.

Source

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

Creates a color with the specified components. The alpha component will be set to 1.0 (full opacity). Each component should be in the range 0.0 to 1.0.

Source

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

Creates a color with the specified components, including an alpha component. Each component should be in the range 0 to 255.

Source

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

Creates a color with the specified components. The alpha component will be set to 255 (full opacity). Each component should be in the range 0 to 255.

Source

pub fn from_hex_argb(argb: u32) -> Self

Creates a color from the specified integer value, including an alpha component.

For example, the input value 0xAABBCCDD will result in a color with:

  • Alpha = 0xAA
  • Red = 0xBB
  • Green = 0xCC
  • Blue = 0xDD

Note: If you don’t specify the alpha component, the color will be transparent.

Source

pub fn from_hex_rgb(rgb: u32) -> Self

Creates a color from the specified integer value, with the alpha component set to 255 (full opacity).

For example, the input value 0xAABBCC will result in a color with:

  • Alpha = 0xFF
  • Red = 0xAA
  • Green = 0xBB
  • Blue = 0xCC

Note: if an alpha component is specified in the high bits of the integer, it will be ignored. See Color::from_hex_argb if you wish to specify the alpha component.

Source

pub const fn from_gray(brightness: f32) -> Self

Creates a shade of gray from the specified float value, between 0.0 and 1.0. All three RGB components will be set to this value.

Source

pub const fn r(&self) -> f32

Returns the red component of the color, as a value in the range 0.0 to 1.0.

Source

pub const fn g(&self) -> f32

Returns the green component of the color, as a value in the range 0.0 to 1.0.

Source

pub const fn b(&self) -> f32

Returns the blue component of the color, as a value in the range 0.0 to 1.0.

Source

pub const fn a(&self) -> f32

Returns the alpha component of the color, as a value in the range 0.0 to 1.0. The value 0.0 is fully transparent, and the value 1.0 is fully opaque.

Source

pub fn subjective_brightness(&self) -> f32

Returns the brightness of the color as perceived by a human, as a value in the range 0.0 to 1.0.

This is calculated using the following formula:

red * 0.299 + green * 0.587 + blue * 0.114

Trait Implementations§

Source§

impl Clone for Color

Source§

fn clone(&self) -> Color

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 PartialEq for Color

Source§

fn eq(&self, other: &Color) -> 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 for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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 = Infallible

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

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

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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
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