Struct Color

pub struct Color {
    pub name: Option<String>,
    /* private fields */
}

Represents a single color in the palette.

The color components are stored in extended linear sRGB color space, but the API primarily works with non-linear (gamma-corrected) values which better match human perception.

Fields

name: Option<String>

Optional name for the color.

Implementations

impl Color

pub fn new( red: f32, green: f32, blue: f32, opacity: Option<f32>, name: Option<String>, ) -> Self

Creates a color using extended non-linear sRGB components.

• Note: If you don’t know the difference between linear and non-linear, this is the initializer you want.

• Parameters:

  • red: Red component.
  • green: Green component.
  • blue: Blue component.
  • opacity: Optional opacity value (0.0…1.0), defaults to 1.0.
  • name: Optional name for the color.

pub fn from_linear( red: f32, green: f32, blue: f32, opacity: Option<f32>, name: Option<String>, ) -> Self

Creates a color using extended linear sRGB components.

• Note: For most purposes, you will want to use new() instead.

• Parameters:

  • red: Linear red component.
  • green: Linear green component.
  • blue: Linear blue component.
  • opacity: Optional opacity value (0.0…1.0), defaults to 1.0.
  • name: Optional name for the color.

pub fn components(&self) -> ColorComponents

Returns the color components in extended non-linear sRGB color space.

This is probably what you want. The color components are adjusted for human perception and display on screens.

pub fn components_linear(&self) -> &ColorComponents

Returns the color components in extended linear sRGB color space.

• Note: For most purposes, you will want to use components() instead which returns normal sRGB values.

pub fn from_hex_str(hex: &str) -> Result<Self, &'static str>

Creates a color from a hex string.

Supports the following formats:

• RGB: “#RGB” or “RGB”
• RGBA: “#RGBA” or “RGBA”
• RRGGBB: “#RRGGBB” or “RRGGBB”
• RRGGBBAA: “#RRGGBBAA” or “RRGGBBAA”

The “#” prefix is optional.

Returns an error if the string format is invalid.

pub fn from_hex_int(hex: u32) -> Result<Self, &'static str>

Creates a color from an integer hex value.

Supports the following formats:

• RGB: 0xRGB (12-bit)
• RGBA: 0xRGBA (16-bit)
• RRGGBB: 0xRRGGBB (24-bit)
• RRGGBBAA: 0xRRGGBBAA (32-bit)

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

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Color