Struct ecolor::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§

impl Color32

source

pub const TRANSPARENT: Self = _

source

pub const BLACK: Self = _

source

pub const DARK_GRAY: Self = _

source

pub const GRAY: Self = _

source

pub const LIGHT_GRAY: Self = _

source

pub const WHITE: Self = _

source

pub const BROWN: Self = _

source

pub const DARK_RED: Self = _

source

pub const RED: Self = _

source

pub const LIGHT_RED: Self = _

source

pub const YELLOW: Self = _

source

pub const LIGHT_YELLOW: Self = _

source

pub const KHAKI: Self = _

source

pub const DARK_GREEN: Self = _

source

pub const GREEN: Self = _

source

pub const LIGHT_GREEN: Self = _

source

pub const DARK_BLUE: Self = _

source

pub const BLUE: Self = _

source

pub const LIGHT_BLUE: Self = _

source

pub const GOLD: Self = _

source

pub const DEBUG_COLOR: Self = _

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

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 at compile-time (e.g. for use in const contexts) 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.

Trait Implementations§

source§

impl Clone for Color32

source§

fn clone(&self) -> Color32

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Color32

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Color32

source§

fn default() -> Color32

Returns the “default value” for a type. Read more
source§

impl From<Color32> for Hsva

source§

fn from(srgba: Color32) -> Self

Converts to this type from the input type.
source§

impl From<Color32> for HsvaGamma

source§

fn from(srgba: Color32) -> Self

Converts to this type from the input type.
source§

impl From<Color32> for Rgba

source§

fn from(srgba: Color32) -> Self

Converts to this type from the input type.
source§

impl From<Hsva> for Color32

source§

fn from(hsva: Hsva) -> Self

Converts to this type from the input type.
source§

impl From<HsvaGamma> for Color32

source§

fn from(hsvag: HsvaGamma) -> Self

Converts to this type from the input type.
source§

impl From<Rgba> for Color32

source§

fn from(rgba: Rgba) -> Self

Converts to this type from the input type.
source§

impl Hash for Color32

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Index<usize> for Color32

§

type Output = u8

The returned type after indexing.
source§

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

Performs the indexing (container[index]) operation. Read more
source§

impl IndexMut<usize> for Color32

source§

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

Performs the mutable indexing (container[index]) operation. Read more
source§

impl PartialEq for Color32

source§

fn eq(&self, other: &Color32) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Zeroable for Color32

source§

fn zeroed() -> Self

source§

impl Copy for Color32

source§

impl Eq for Color32

source§

impl Pod for Color32

source§

impl StructuralEq for Color32

source§

impl StructuralPartialEq for Color32

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CheckedBitPattern for T
where T: AnyBitPattern,

§

type Bits = T

Self must have the same layout as the specified Bits except for the possible invalid bit patterns being checked during is_valid_bit_pattern.
source§

fn is_valid_bit_pattern(_bits: &T) -> bool

If this function returns true, then it must be valid to reinterpret bits as &Self.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> AnyBitPattern for T
where T: Pod,

source§

impl<T> NoUninit for T
where T: Pod,