Struct Color32

Source

#[repr(C)]
pub struct Color32(/* private fields */);

Expand description

This format is used for space-efficient color representation (32 bits).

Instead of manipulating this directly it is often better to first convert it to either Rgba or crate::Hsva.

Internally this uses 0-255 gamma space sRGBA color with premultiplied alpha. Alpha channel is in linear space.

The special value of alpha=0 means the color is to be treated as an additive color.

Implementations§

Source §

pub const PLACEHOLDER: Self

An ugly color that is planned to be replaced before making it to the screen.

This is an invalid color, in that it does not correspond to a valid multiplied color, nor to an additive color.

This is used as a special color key, i.e. often taken to mean “no color”.

Source

pub const TEMPORARY_COLOR: Self = Self::PLACEHOLDER

👎Deprecated: Renamed to PLACEHOLDER

Source

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

Source

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

Source

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

From sRGBA with premultiplied alpha.

Source

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

From sRGBA WITHOUT premultiplied alpha.

Source

pub const fn from_gray(l: u8) -> Self

Source

pub const fn from_black_alpha(a: u8) -> Self

Source

pub fn from_white_alpha(a: u8) -> Self

Source

pub const fn from_additive_luminance(l: u8) -> Self

Source

pub const fn is_opaque(&self) -> bool

Source

pub const fn r(&self) -> u8

Source

pub const fn g(&self) -> u8

Source

pub const fn b(&self) -> u8

Source

pub const fn a(&self) -> u8

Source

pub fn to_opaque(self) -> Self

Returns an opaque version of self

Source

pub const fn additive(self) -> Self

Returns an additive version of self

Source

pub fn is_additive(self) -> bool

Is the alpha=0 ?

Source

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

Premultiplied RGBA

Source

pub const fn to_tuple(&self) -> (u8, u8, u8, u8)

Premultiplied RGBA

Source

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

Source

pub fn gamma_multiply(self, factor: f32) -> Self

Multiply with 0.5 to make color half as opaque, perceptually.

Fast multiplication in gamma-space.

This is perceptually even, and faster that Self::linear_multiply.

Source

pub fn gamma_multiply_u8(self, factor: u8) -> Self

Multiply with 127 to make color half as opaque, perceptually.

Fast multiplication in gamma-space.

This is perceptually even, and faster that Self::linear_multiply.

Source

pub fn linear_multiply(self, factor: f32) -> Self

Multiply with 0.5 to make color half as opaque in linear space.

This is using linear space, which is not perceptually even. You likely want to use Self::gamma_multiply instead.

Source

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

Converts to floating point values in the range 0-1 without any gamma space conversion.

Use this with great care! In almost all cases, you want to convert to crate::Rgba instead in order to obtain linear space color values.

Source

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

Lerp this color towards other by t in gamma space.

Source

pub fn blend(self, on_top: Self) -> Self

Blend two colors, so that self is behind the argument.

Source §

impl Color32

Source

pub fn from_hex(hex: &str) -> Result<Self, ParseHexColorError>

Parses a color from a hex string.

Supports the 3, 4, 6, and 8-digit formats, according to the specification in https://drafts.csswg.org/css-color-4/#hex-color

To parse hex colors from string literals with compile-time checking, use the macro [crate::hex_color!] instead.

§Example

use ecolor::Color32;
assert_eq!(Ok(Color32::RED), Color32::from_hex("#ff0000"));
assert_eq!(Ok(Color32::GREEN), Color32::from_hex("#00ff00ff"));
assert_eq!(Ok(Color32::BLUE), Color32::from_hex("#00f"));
assert_eq!(Ok(Color32::TRANSPARENT), Color32::from_hex("#0000"));

§Errors

Returns an error if the string doesn’t start with the hash # character, if the remaining length does not correspond to one of the standard formats (3, 4, 6, or 8), if it contains non-hex characters.

Source

pub fn to_hex(&self) -> String

Formats the color as a hex string.

§Example

use ecolor::Color32;
assert_eq!(Color32::RED.to_hex(), "#ff0000ff");
assert_eq!(Color32::GREEN.to_hex(), "#00ff00ff");
assert_eq!(Color32::BLUE.to_hex(), "#0000ffff");
assert_eq!(Color32::TRANSPARENT.to_hex(), "#00000000");

Uses the 8-digit format described in https://drafts.csswg.org/css-color-4/#hex-color, as that is the only format that is lossless. For other formats, see HexColor.