Struct Color

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

A color in the sRGB color space.

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 fn new(r: f32, g: f32, b: f32, a: f32) -> Color

Creates a new Color.

In debug mode, it will panic if the values are not in the correct range: 0.0 - 1.0

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 fn from_rgb8(r: u8, g: u8, b: u8) -> Color

Creates a Color from its RGB8 components.

pub 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) -> Self

Creates a Color from its linear RGBA components.

pub fn parse(s: &str) -> Option<Color>

Parses a Color from a hex string.

Supported formats are #rrggbb, #rrggbbaa, #rgb, and #rgba. The starting “#” is optional. Both uppercase and lowercase are supported.

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

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.

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Color

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

Formats the value using the given formatter.

impl Default for Color

fn default() -> Color

Returns the “default value” for a type.

impl From<[f32; 3]> for Color

fn from([r, g, b]: [f32; 3]) -> Self

Converts to this type from the input type.

impl From<[f32; 4]> for Color

fn from([r, g, b, a]: [f32; 4]) -> Self

Converts to this type from the input type.

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

Converts from palette’s Rgba type to a Color.

fn from(rgba: Srgba) -> Self

Converts to this type from the input type.

impl From<Color> for Srgba

Converts from Color to palette’s Rgba type.

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Background

fn from(color: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Srgb

Converts from Color to palette’s Rgb type.

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Rgb> for Color

Converts from palette’s Rgb type to a Color.

fn from(rgb: Srgb) -> Self

Converts to this type from the input 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 Copy for Color

impl StructuralPartialEq for Color