Struct Color

pub struct Color { /* private fields */ }

An RGBA color value, holding four floating point components.

Guarantees

• All values are in 0..=1 range.

Implementations

impl Color

pub const TRANSPARENT: Color = _

A transparent color.

pub const BLACK: Color = _

A black color.

pub const WHITE: Color = _

A white color.

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

Creates a new color from 4 components.

All values must be in 0..=1 range.

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

Creates a new color from 4 components.

u8 will be divided by 255 to get the float component.

pub fn red(&self) -> f32

Returns color’s red component.

The value is guarantee to be in a 0..=1 range.

pub fn green(&self) -> f32

Returns color’s green component.

The value is guarantee to be in a 0..=1 range.

pub fn blue(&self) -> f32

Returns color’s blue component.

The value is guarantee to be in a 0..=1 range.

pub fn alpha(&self) -> f32

Returns color’s alpha component.

The value is guarantee to be in a 0..=1 range.

pub fn set_red(&mut self, c: f32)

Sets the red component value.

The new value will be clipped to the 0..=1 range.

pub fn set_green(&mut self, c: f32)

Sets the green component value.

The new value will be clipped to the 0..=1 range.

pub fn set_blue(&mut self, c: f32)

Sets the blue component value.

The new value will be clipped to the 0..=1 range.

pub fn set_alpha(&mut self, c: f32)

Sets the alpha component value.

The new value will be clipped to the 0..=1 range.

pub fn apply_opacity(&mut self, opacity: f32)

Shifts color’s opacity.

Essentially, multiplies color’s alpha by opacity.

opacity will be clamped to the 0..=1 range first. The final alpha will also be clamped.

pub fn is_opaque(&self) -> bool

Check that color is opaque.

Alpha == 1.0

pub fn premultiply(&self) -> PremultipliedColor

Converts into a premultiplied color.

pub fn to_color_u8(&self) -> ColorU8

Converts into ColorU8.

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 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