Struct Color

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

A color in the sRGB color space.

String Representation

A color can be represented in either of the following valid formats: #rrggbb, #rrggbbaa, #rgb, and #rgba. Where rgba represent hexadecimal digits. Both uppercase and lowercase letters are supported.

If a (transparency) is not specified, 1.0 (completely opaque) would be used by default.

If you have a static color string, using the color! macro should be preferred since it leverages hexadecimal literal notation and arithmetic directly.

Fields

r: f32

Red component, 0.0 - 1.0

g: f32

Green component, 0.0 - 1.0

b: f32

Blue component, 0.0 - 1.0

a: f32

Transparency, 0.0 - 1.0

Implementations

impl Color

pub const BLACK: Color

The black color.

pub const WHITE: Color

The white color.

pub const TRANSPARENT: Color

A color with no opacity.

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

Creates a Color from its RGB components.

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

Creates a Color from its RGBA components.

pub const fn from_rgb8(r: u8, g: u8, b: u8) -> Color

Creates a Color from its RGB8 components.

pub const fn from_rgba8(r: u8, g: u8, b: u8, a: f32) -> Color

Creates a Color from its RGB8 components and an alpha value.

pub fn from_linear_rgba(r: f32, g: f32, b: f32, a: f32) -> Color

Creates a Color from its linear RGBA components.

pub fn into_rgba8(self) -> [u8; 4]

Converts the Color into its RGBA8 equivalent.

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

Converts the Color into its linear values.

pub fn invert(&mut self)

Inverts the Color in-place.

pub fn inverse(self) -> Color

Returns the inverted Color.

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

Scales the alpha channel of the Color by the given factor.

pub fn relative_luminance(self) -> f32

Returns the relative luminance of the Color. https://www.w3.org/TR/WCAG21/#dfn-relative-luminance

pub fn relative_contrast(self, b: Color) -> f32

Returns the relative contrast ratio of the Color against another one.

pub fn is_readable_on(self, background: Color) -> bool

Returns true if the current Color is readable on top of the given background Color.

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ColorExt for Color

fn blend_alpha(self, background: Self, alpha: f32) -> Self

Combines color with background to create appearance of transparency.

impl Debug for Color

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

Formats the value using the given formatter.

impl Default for Color

fn default() -> Color

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Color

fn deserialize<__D>( __deserializer: __D, ) -> Result<Color, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Color

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

Formats the value using the given formatter.

impl From<[f32; 3]> for Color

fn from(_: [f32; 3]) -> Color

Converts to this type from the input type.

impl From<[f32; 4]> for Color

fn from(_: [f32; 4]) -> Color

Converts to this type from the input type.

impl From<Alpha<Rgb<Srgb, u8>, u8>> for Color

fn from(srgba: Alpha<Rgb<Srgb, u8>, u8>) -> Color

Converts to this type from the input type.

impl From<Alpha<Rgb, f32>> for Color

fn from(srgba: Alpha<Rgb, f32>) -> Color

Converts to this type from the input type.

impl From<Color> for Alpha<Rgb, f32>

fn from(color: Color) -> Alpha<Rgb, f32>

Converts to this type from the input type.

impl From<Color> for Background

fn from(color: Color) -> Background

Converts to this type from the input type.

impl From<Color> for Fill

fn from(color: Color) -> Fill

Converts to this type from the input type.

impl From<Color> for Rgb

fn from(color: Color) -> Rgb

Converts to this type from the input type.

impl From<Color> for Style

fn from(color: Color) -> Style

Converts to this type from the input type.

impl From<Color> for Style

fn from(color: Color) -> Style

Converts to this type from the input type.

impl From<Color> for Text

fn from(color: Color) -> Self

Converts to this type from the input type.

impl From<Rgb<Srgb, u8>> for Color

fn from(srgb: Rgb<Srgb, u8>) -> Color

Converts to this type from the input type.

impl From<Rgb> for Color

fn from(srgb: Rgb) -> Color

Converts to this type from the input type.

impl FromStr for Color

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Color, <Color as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for Color

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Color

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Color

impl StructuralPartialEq for Color