Struct Color

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

The color

Fields

r: f32

Red

g: f32

Green

b: f32

Blue

a: f32

Alpha

Implementations

impl Color

pub const fn new(r: f32, g: f32, b: f32, a: f32) -> Self

Arguments:

• r: Red value [0..1]
• g: Green value [0..1]
• b: Blue value [0..1]
• a: Alpha value [0..1]

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

Arguments:

• r: Red value [0..255]
• g: Green value [0..255]
• b: Blue value [0..255]
• a: Alpha value [0..255]

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

Arguments:

• r: Red value [0..1]
• g: Green value [0..1]
• b: Blue value [0..1]
• a: Alpha value [0..1]

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

Arguments:

• r: Red value [0..255]
• g: Green value [0..255]
• b: Blue value [0..255]
• a: Alpha value [0..255]

pub fn from_hsva(h: f32, s: f32, v: f32, a: f32) -> Self

Arguments:

• h: Hue angle [0..360]
• s: Saturation [0..1]
• v: Value [0..1]
• a: Alpha [0..1]

pub fn from_hsla(h: f32, s: f32, l: f32, a: f32) -> Self

Arguments:

• h: Hue angle [0..360]
• s: Saturation [0..1]
• l: Lightness [0..1]
• a: Alpha [0..1]

pub fn from_hwba(h: f32, w: f32, b: f32, a: f32) -> Self

Arguments:

• h: Hue angle [0..360]
• w: Whiteness [0..1]
• b: Blackness [0..1]
• a: Alpha [0..1]

pub fn from_oklaba(l: f32, a: f32, b: f32, alpha: f32) -> Self

Arguments:

• l: Perceived lightness
• a: How green/red the color is
• b: How blue/yellow the color is
• alpha: Alpha [0..1]

pub fn from_oklcha(l: f32, c: f32, h: f32, alpha: f32) -> Self

Arguments:

• l: Perceived lightness
• c: Chroma
• h: Hue angle in radians
• alpha: Alpha [0..1]

pub fn from_html<S: AsRef<str>>(s: S) -> Result<Self, ParseColorError>

Create color from CSS color string.

Examples

use csscolorparser::Color;

let c = Color::from_html("rgb(255,0,0)")?;

assert_eq!(c.to_array(), [1.0, 0.0, 0.0, 1.0]);
assert_eq!(c.to_rgba8(), [255, 0, 0, 255]);
assert_eq!(c.to_css_hex(), "#ff0000");
assert_eq!(c.to_css_rgb(), "rgb(255 0 0)");

pub fn clamp(&self) -> Self

Restricts R, G, B, A values to the range [0..1].

pub fn name(&self) -> Option<&'static str>

Returns name if there is a name for this color.

Note: It ignores transparency (alpha value).

use csscolorparser::Color;

assert_eq!(Color::from_rgba8(255, 0, 0, 255).name(), Some("red"));
assert_eq!(Color::from_rgba8(238, 130, 238, 255).name(), Some("violet"));
assert_eq!(Color::from_rgba8(90, 150, 200, 255).name(), None);

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

Returns: [r, g, b, a]

• Red, green, blue and alpha in the range [0..1]

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

Returns: [r, g, b, a]

• Red, green, blue and alpha in the range [0..255]

pub fn to_rgba16(&self) -> [u16; 4]

Returns: [r, g, b, a]

• Red, green, blue and alpha in the range [0..65535]

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

Returns: [h, s, v, a]

• h: Hue angle [0..360]
• s: Saturation [0..1]
• v: Value [0..1]
• a: Alpha [0..1]

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

Returns: [h, s, l, a]

• h: Hue angle [0..360]
• s: Saturation [0..1]
• l: Lightness [0..1]
• a: Alpha [0..1]

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

Returns: [h, w, b, a]

• h: Hue angle [0..360]
• w: Whiteness [0..1]
• b: Blackness [0..1]
• a: Alpha [0..1]

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

Returns: [r, g, b, a]

• Red, green, blue and alpha in the range [0..1]

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

Returns: [r, g, b, a]

• Red, green, blue and alpha in the range [0..255]

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

Returns: [l, a, b, alpha]

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

Returns: [l, c, h, alpha]

pub fn to_css_hex(&self) -> String

Get CSS RGB hexadecimal color representation

pub fn to_css_rgb(&self) -> String

Get CSS rgb() color representation

pub fn to_css_hsl(&self) -> String

Get CSS hsl() color representation

pub fn to_css_hwb(&self) -> String

Get CSS hwb() color representation

pub fn to_css_oklab(&self) -> String

Get CSS oklab() color representation

pub fn to_css_oklch(&self) -> String

Get CSS oklch() color representation

pub fn interpolate_rgb(&self, other: &Color, t: f32) -> Self

Blend this color with the other one, in the RGB color-space. t in the range [0..1].

pub fn interpolate_linear_rgb(&self, other: &Color, t: f32) -> Self

Blend this color with the other one, in the linear RGB color-space. t in the range [0..1].

pub fn interpolate_hsv(&self, other: &Color, t: f32) -> Self

Blend this color with the other one, in the HSV color-space. t in the range [0..1].

pub fn interpolate_oklab(&self, other: &Color, t: f32) -> Self

Blend this color with the other one, in the Oklab color-space. t in the range [0..1].

impl Color

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

👎Deprecated: Use new instead.

Arguments:

• r: Red value [0..1]
• g: Green value [0..1]
• b: Blue value [0..1]

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

👎Deprecated: Use new instead.

Arguments:

• r: Red value [0..1]
• g: Green value [0..1]
• b: Blue value [0..1]
• a: Alpha value [0..1]

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

👎Deprecated: Use from_rgba8 instead.

Arguments:

• r: Red value [0..255]
• g: Green value [0..255]
• b: Blue value [0..255]

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

👎Deprecated: Use from_rgba8 instead.

Arguments:

• r: Red value [0..255]
• g: Green value [0..255]
• b: Blue value [0..255]
• a: Alpha value [0..255]

pub fn from_linear_rgb(r: f32, g: f32, b: f32) -> Self

👎Deprecated: Use from_linear_rgba instead.

Arguments:

• r: Red value [0..1]
• g: Green value [0..1]
• b: Blue value [0..1]

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

👎Deprecated: Use from_linear_rgba8 instead.

Arguments:

• r: Red value [0..255]
• g: Green value [0..255]
• b: Blue value [0..255]

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

👎Deprecated: Use from_linear_rgba8 instead.

Arguments:

• r: Red value [0..255]
• g: Green value [0..255]
• b: Blue value [0..255]
• a: Alpha value [0..255]

pub fn from_hsv(h: f32, s: f32, v: f32) -> Self

👎Deprecated: Use from_hsva instead.

Arguments:

• h: Hue angle [0..360]
• s: Saturation [0..1]
• v: Value [0..1]

pub fn from_hsl(h: f32, s: f32, l: f32) -> Self

👎Deprecated: Use from_hsla instead.

Arguments:

• h: Hue angle [0..360]
• s: Saturation [0..1]
• l: Lightness [0..1]

pub fn from_hwb(h: f32, w: f32, b: f32) -> Self

👎Deprecated: Use from_hwba instead.

Arguments:

• h: Hue angle [0..360]
• w: Whiteness [0..1]
• b: Blackness [0..1]

pub fn from_oklab(l: f32, a: f32, b: f32) -> Self

👎Deprecated: Use from_oklaba instead.

Arguments:

• l: Perceived lightness
• a: How green/red the color is
• b: How blue/yellow the color is

pub fn rgba(&self) -> (f32, f32, f32, f32)

👎Deprecated

Returns: (r, g, b, a)

• Red, green, blue and alpha in the range [0..1]

pub fn rgba_u8(&self) -> (u8, u8, u8, u8)

👎Deprecated: Use to_rgba8 instead.

Returns: (r, g, b, a)

• Red, green, blue and alpha in the range [0..255]

pub fn to_hex_string(&self) -> String

👎Deprecated: Use to_css_hex instead.

Get the RGB hexadecimal color string.

pub fn to_rgb_string(&self) -> String

👎Deprecated: Use to_css_rgb instead.

Get the CSS rgb() format string.

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

fn default() -> Self

Returns the “default value” for a type.

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

Implement Serde deserialization from string

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Color

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

Formats the value using the given formatter.

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<[f64; 3]> for Color

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

Converts to this type from the input type.

impl From<[f64; 4]> for Color

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

Converts to this type from the input type.

impl From<[u8; 3]> for Color

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

Converts to this type from the input type.

impl From<[u8; 4]> for Color

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

Converts to this type from the input type.

impl From<(f32, f32, f32)> for Color

fn from((r, g, b): (f32, f32, f32)) -> Self

Converts to this type from the input type.

impl From<(f32, f32, f32, f32)> for Color

fn from((r, g, b, a): (f32, f32, f32, f32)) -> Self

Converts to this type from the input type.

impl From<(u8, u8, u8)> for Color

fn from((r, g, b): (u8, u8, u8)) -> Self

Converts to this type from the input type.

impl From<(u8, u8, u8, u8)> for Color

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

Converts to this type from the input type.

impl FromStr for Color

type Err = ParseColorError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::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 PartialOrd for Color

fn partial_cmp(&self, other: &Color) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Color

Implement Serde serialization into HEX string

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Color

type Error = ParseColorError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Color