#[repr(C)]pub struct Color32(pub(crate) [u8; 4]);
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.
Tuple Fields§
§0: [u8; 4]
Implementations§
source§impl Color32
impl Color32
pub const TRANSPARENT: Self = _
pub const BLACK: Self = _
pub const DARK_GRAY: Self = _
pub const GRAY: Self = _
pub const LIGHT_GRAY: Self = _
pub const WHITE: Self = _
pub const BROWN: Self = _
pub const DARK_RED: Self = _
pub const RED: Self = _
pub const LIGHT_RED: Self = _
pub const YELLOW: Self = _
pub const LIGHT_YELLOW: Self = _
pub const KHAKI: Self = _
pub const DARK_GREEN: Self = _
pub const GREEN: Self = _
pub const LIGHT_GREEN: Self = _
pub const DARK_BLUE: Self = _
pub const BLUE: Self = _
pub const LIGHT_BLUE: Self = _
pub const GOLD: Self = _
pub const DEBUG_COLOR: Self = _
sourcepub const PLACEHOLDER: Self = _
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”.
pub const TEMPORARY_COLOR: Self = Self::PLACEHOLDER
pub const fn from_rgb(r: u8, g: u8, b: u8) -> Self
pub const fn from_rgb_additive(r: u8, g: u8, b: u8) -> Self
sourcepub const fn from_rgba_premultiplied(r: u8, g: u8, b: u8, a: u8) -> Self
pub const fn from_rgba_premultiplied(r: u8, g: u8, b: u8, a: u8) -> Self
From sRGBA
with premultiplied alpha.
sourcepub fn from_rgba_unmultiplied(r: u8, g: u8, b: u8, a: u8) -> Self
pub fn from_rgba_unmultiplied(r: u8, g: u8, b: u8, a: u8) -> Self
From sRGBA
WITHOUT premultiplied alpha.
pub const fn from_gray(l: u8) -> Self
pub const fn from_black_alpha(a: u8) -> Self
pub fn from_white_alpha(a: u8) -> Self
pub const fn from_additive_luminance(l: u8) -> Self
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
sourcepub fn is_additive(self) -> bool
pub fn is_additive(self) -> bool
Is the alpha=0 ?
pub fn to_srgba_unmultiplied(&self) -> [u8; 4]
sourcepub fn gamma_multiply(self, factor: f32) -> Self
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
.
sourcepub fn linear_multiply(self, factor: f32) -> Self
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.
sourcepub fn to_normalized_gamma_f32(self) -> [f32; 4]
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.
sourcepub fn lerp_to_gamma(&self, other: Self, t: f32) -> Self
pub fn lerp_to_gamma(&self, other: Self, t: f32) -> Self
Lerp this color towards other
by t
in gamma space.
source§impl Color32
impl Color32
sourcepub fn from_hex(hex: &str) -> Result<Self, ParseHexColorError>
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.
sourcepub fn to_hex(&self) -> String
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 PartialEq for Color32
impl PartialEq for Color32
impl Copy for Color32
impl Eq for Color32
impl Pod for Color32
impl StructuralPartialEq for Color32
Auto Trait Implementations§
impl Freeze for Color32
impl RefUnwindSafe for Color32
impl Send for Color32
impl Sync for Color32
impl Unpin for Color32
impl UnwindSafe for Color32
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CheckedBitPattern for Twhere
T: AnyBitPattern,
impl<T> CheckedBitPattern for Twhere
T: AnyBitPattern,
§type Bits = T
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
fn is_valid_bit_pattern(_bits: &T) -> bool
bits
as &Self
.