Skip to main content

Color

Struct Color 

Source
pub struct Color {
    pub space: ColorSpace,
    pub red: f32,
    pub green: f32,
    pub blue: f32,
    pub alpha: f32,
}

Fields§

§space: ColorSpace§red: f32§green: f32§blue: f32§alpha: f32

Implementations§

Source§

impl Color

Source

pub const TRANSPARENT: Self

Source

pub const BLACK: Self

Source

pub const WHITE: Self

Source

pub const fn new( space: ColorSpace, red: f32, green: f32, blue: f32, alpha: f32, ) -> Self

Source

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

Source

pub const fn srgba(red: f32, green: f32, blue: f32, alpha: f32) -> Self

Source

pub const fn linear_rgba(red: f32, green: f32, blue: f32, alpha: f32) -> Self

Source

pub const fn display_p3(red: f32, green: f32, blue: f32, alpha: f32) -> Self

Source

pub const fn linear_display_p3( red: f32, green: f32, blue: f32, alpha: f32, ) -> Self

Source

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

Source

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

Source

pub fn clamped(self) -> Self

Source

pub fn over(self, backdrop: Color) -> Self

Source-over composite this (possibly translucent) color onto an opaque backdrop, blending in the encoded (gamma) space — the same arithmetic CSS uses for rgba() overlays. The renderer blends in linear space, which reads translucent washes noticeably heavier than their CSS-authored intent, so design tokens specified as CSS rgba values should be flattened with this before painting.

Both colors must be in the same encoded space; the backdrop’s alpha is treated as 1. The result is opaque.

Source

pub fn to_linear_srgb(self) -> Self

Source

pub fn to_space(self, space: ColorSpace) -> Self

Convert this color to space, keeping alpha. Channels are not clamped, so colors outside the target gamut keep their out-of-range values.

Source

pub fn mix_oklab(self, to: Color, amount: f32) -> Self

Blend toward to by amount (0 to 1) in premultiplied OKLab, the perceptual mixing CSS color-mix() uses by default.

Blending the premultiplied values keeps a fade from a transparent color free of a dark fringe: the color holds steady while only its opacity changes. The endpoints are returned exactly, and blends between colors in different spaces come out in to’s space.

Source

pub fn oklch(lightness: f32, chroma: f32, hue: f32) -> Self

Build an encoded sRGB color from OKLCH coordinates, reducing chroma until the color fits the sRGB gamut. See Oklch::to_srgb.

Source

pub fn to_oklch(self) -> Oklch

Convert this color to OKLCH. Channels outside the displayable range are converted as-is, so wide-gamut and extended-range colors keep their chroma.

Source

pub fn relative_luminance(self) -> f32

WCAG 2 relative luminance of the opaque color, clamped to the SDR range.

Source

pub fn contrast_ratio(self, other: Color) -> f32

WCAG 2 contrast ratio between two opaque colors, from 1.0 to 21.0.

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

§

impl Freeze for Color

§

impl Move 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.