Skip to main content

Color

Struct Color 

Source
pub struct Color {
    pub red: u8,
    pub green: u8,
    pub blue: u8,
    pub alpha: u8,
}
Expand description

A colour with 8 bits per channel.

The chart pipeline packs colours into a single u32 (0xRRGGBBAA) before they reach the GPU, so the type keeps the four channels as separate bytes and does the packing once, at upload time.

Fields§

§red: u8

The red channel.

§green: u8

The green channel.

§blue: u8

The blue channel.

§alpha: u8

The alpha channel, where 255 is fully opaque.

Implementations§

Source§

impl Color

Inherent implementation of Color.

Source

pub fn rgb(red: u8, green: u8, blue: u8) -> Self

Returns an opaque colour from its red, green, and blue channels.

§Arguments
  • u8 - A u8 parameter.
Source

pub fn rgba(red: u8, green: u8, blue: u8, alpha: u8) -> Self

Returns a colour from its red, green, blue, and alpha channels.

§Arguments
  • u8 - A u8 parameter.
Source

pub fn from_u32(packed: u32) -> Self

Returns a colour from a packed 0xRRGGBBAA value.

§Arguments
  • u32 - A 32-bit unsigned integer (u32).
Source

pub fn to_u32(self) -> u32

Returns the colour packed as 0xRRGGBBAA.

§Returns
  • u32 - A 32-bit unsigned integer.
Source

pub fn to_css(self) -> String

Returns the colour as a CSS rgba() string.

§Returns
  • String - A String value.
Source

pub fn lerp(self, other: Self, amount: f64) -> Self

Returns the colour that lies between two colours.

The channels are mixed one by one, which is what the ramp of a visual map does: the middle of the ramp is the middle of its two ends.

§Arguments
  • f64 - The opposite endpoint of the interpolation.
  • Self - The opposite endpoint of the interpolation.
Source

pub fn parse(input: &str) -> Option<Self>

Parses a CSS colour string.

The accepted forms are the ones ECharts accepts: #rgb, #rgba, #rrggbb, #rrggbbaa, rgb(), rgba(), hsl(), hsla(), transparent, and the CSS named colours. Returns None when the string is not a colour.

§Arguments
  • &str - Shared reference to a str.
§Returns
  • Option<Self> - Some(...) on success, None otherwise.
Source

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

Returns the colour with its alpha replaced.

§Arguments
  • u8 - A u8 parameter.
Source

pub fn mix(self, other: Self, ratio: f64) -> Self

Returns the colour mixed with another one.

ratio is the weight of other: 0.0 returns this colour unchanged, 1.0 returns other.

§Arguments
  • f64 - A 64-bit float (f64).
  • Self - A Self parameter.
Source

pub fn lighten(self, ratio: f64) -> Self

Returns the colour brightened towards white.

§Arguments
  • f64 - A 64-bit float (f64).
Source

pub fn darken(self, ratio: f64) -> Self

Returns the colour darkened towards black.

§Arguments
  • f64 - A 64-bit float (f64).
Source§

impl Color

Source

pub fn get_red(&self) -> u8

Source

pub fn get_mut_red(&mut self) -> &mut u8

Source

pub fn set_red(&mut self, val: u8) -> &mut Self

Source

pub fn get_green(&self) -> u8

Source

pub fn get_mut_green(&mut self) -> &mut u8

Source

pub fn set_green(&mut self, val: u8) -> &mut Self

Source

pub fn get_blue(&self) -> u8

Source

pub fn get_mut_blue(&mut self) -> &mut u8

Source

pub fn set_blue(&mut self, val: u8) -> &mut Self

Source

pub fn get_alpha(&self) -> u8

Source

pub fn get_mut_alpha(&mut self) -> &mut u8

Source

pub fn set_alpha(&mut self, val: u8) -> &mut Self

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

Source§

fn default() -> Self

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

impl Eq for Color

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, Self: Sized,

Feeds a slice of this type into the given Hasher. 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<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> 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> 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<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