Struct Color32

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

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

impl Color32

pub const TRANSPARENT: Color32 = _

pub const BLACK: Color32 = _

pub const DARK_GRAY: Color32 = _

pub const GRAY: Color32 = _

pub const LIGHT_GRAY: Color32 = _

pub const WHITE: Color32 = _

pub const BROWN: Color32 = _

pub const DARK_RED: Color32 = _

pub const RED: Color32 = _

pub const LIGHT_RED: Color32 = _

pub const YELLOW: Color32 = _

pub const ORANGE: Color32 = _

pub const LIGHT_YELLOW: Color32 = _

pub const KHAKI: Color32 = _

pub const DARK_GREEN: Color32 = _

pub const GREEN: Color32 = _

pub const LIGHT_GREEN: Color32 = _

pub const DARK_BLUE: Color32 = _

pub const BLUE: Color32 = _

pub const LIGHT_BLUE: Color32 = _

pub const GOLD: Color32 = _

pub const DEBUG_COLOR: Color32 = _

pub const PLACEHOLDER: Color32 = _

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

pub const TEMPORARY_COLOR: Color32 = Self::PLACEHOLDER

👎Deprecated: Renamed to PLACEHOLDER

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

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

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

From sRGBA with premultiplied alpha.

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

From sRGBA WITHOUT premultiplied alpha.

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

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

pub fn from_white_alpha(a: u8) -> Color32

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

pub const fn is_opaque(&self) -> bool

pub const fn r(&self) -> u8

pub const fn g(&self) -> u8

pub const fn b(&self) -> u8

pub const fn a(&self) -> u8

pub fn to_opaque(self) -> Color32

Returns an opaque version of self

pub const fn additive(self) -> Color32

Returns an additive version of self

pub fn is_additive(self) -> bool

Is the alpha=0 ?

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

Premultiplied RGBA

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

Premultiplied RGBA

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

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

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.

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

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.

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.

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

Lerp this color towards other by t in gamma space.

impl Color32

pub fn from_hex(hex: &str) -> Result<Color32, 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.

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.

Trait Implementations

impl Clone for Color32

fn clone(&self) -> Color32

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ColorInterop for Color32

type CintTy = PremultipliedAlpha<EncodedSrgb>

fn from_cint(col: Self::CintTy) -> Self

Convert self into its canonical cint type.

fn into_cint(self) -> Self::CintTy

Create a Self from its canonical cint type.

impl Debug for Color32

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

Formats the value using the given formatter.

impl Default for Color32

fn default() -> Color32

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Color32

fn deserialize<__D>( __deserializer: __D, ) -> Result<Color32, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Alpha<EncodedSrgb>> for Color32

fn from(srgba: Alpha<EncodedSrgb>) -> Color32

Converts to this type from the input type.

impl From<Color32> for Rgba

fn from(srgba: Color32) -> Rgba

Converts to this type from the input type.

impl From<Hsva> for Color32

fn from(hsva: Hsva) -> Color32

Converts to this type from the input type.

impl From<HsvaGamma> for Color32

fn from(hsvag: HsvaGamma) -> Color32

Converts to this type from the input type.

impl From<PremultipliedAlpha<EncodedSrgb<f32>>> for Color32

fn from(srgba: PremultipliedAlpha<EncodedSrgb<f32>>) -> Color32

Converts to this type from the input type.

impl From<PremultipliedAlpha<EncodedSrgb>> for Color32

fn from(srgba: PremultipliedAlpha<EncodedSrgb>) -> Color32

Converts to this type from the input type.

impl From<Rgba> for Color32

fn from(rgba: Rgba) -> Color32

Converts to this type from the input type.

impl Hash for Color32

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<usize> for Color32

type Output = u8

The returned type after indexing.

fn index(&self, index: usize) -> &u8

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Color32

fn index_mut(&mut self, index: usize) -> &mut u8

Performs the mutable indexing (container[index]) operation.

impl PartialEq for Color32

fn eq(&self, other: &Color32) -> 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 Color32

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Zeroable for Color32

fn zeroed() -> Self

Calls zeroed.

impl Copy for Color32

impl Eq for Color32

impl Pod for Color32

impl StructuralPartialEq for Color32