Struct imgui::color::ImColor32

#[repr(transparent)]
pub struct ImColor32(_);

Wraps u32 that represents a packed RGBA color. Mostly used by types in the low level custom drawing API, such as DrawListMut.

The bits of a color are in “0xAABBGGRR” format (e.g. RGBA as little endian bytes). For clarity: we don’t support an equivalent to the IMGUI_USE_BGRA_PACKED_COLOR define.

This used to be named ImColor32, but was renamed to avoid confusion with the type with that name in the C++ API (which uses 32 bits per channel).

While it doesn’t provide methods to access the fields, they can be accessed via the Deref/DerefMut impls it provides targeting imgui::color::ImColor32Fields, which has no other meaningful uses.

Example

let mut c = imgui::ImColor32::from_rgba(0x80, 0xc0, 0x40, 0xff);
assert_eq!(c.to_bits(), 0xff_40_c0_80); // Note: 0xAA_BB_GG_RR
// Field access
assert_eq!(c.r, 0x80);
assert_eq!(c.g, 0xc0);
assert_eq!(c.b, 0x40);
assert_eq!(c.a, 0xff);
c.b = 0xbb;
assert_eq!(c.to_bits(), 0xff_bb_c0_80);

Implementations

impl ImColor32

pub const BLACK: Self

Convenience constant for solid black.

pub const WHITE: Self

Convenience constant for solid white.

pub const TRANSPARENT: Self

Convenience constant for full transparency.

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

Construct a color from 4 single-byte u8 channel values, which should be between 0 and 255.

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

Construct a fully opaque color from 3 single-byte u8 channel values. Same as Self::from_rgba with a == 255

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

Construct a fully opaque color from 4 f32 channel values in the range 0.0 ..= 1.0 (values outside this range are clamped to it, with NaN mapped to 0.0).

Note: No alpha premultiplication is done, so your input should be have premultiplied alpha if needed.

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

Return the channels as an array of f32 in [r, g, b, a] order.

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

Return the channels as an array of u8 in [r, g, b, a] order.

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

Equivalent to Self::from_rgba_f32s, but with an alpha of 1.0 (e.g. opaque).

pub const fn from_bits(u: u32) -> Self

Construct a color from the u32 that makes up the bits in 0xAABBGGRR format.

Specifically, this takes the RGBA values as a little-endian u32 with 8 bits per channel.

Note that ImColor32::from_rgba may be a bit easier to use.

pub const fn to_bits(self) -> u32

Return the bits of the color as a u32. These are in “0xAABBGGRR” format, that is, little-endian RGBA with 8 bits per channel.

Trait Implementations

impl Clone for ImColor32

fn clone(&self) -> ImColor32

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImColor32

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

Formats the value using the given formatter.

impl Default for ImColor32

fn default() -> Self

Returns the “default value” for a type.

impl Deref for ImColor32

type Target = ImColor32Fields

The resulting type after dereferencing.

fn deref(&self) -> &ImColor32Fields

Dereferences the value.

impl DerefMut for ImColor32

fn deref_mut(&mut self) -> &mut ImColor32Fields

Mutably dereferences the value.

impl From<[f32; 3]> for ImColor32

fn from(v: [f32; 3]) -> Self

Performs the conversion.

impl From<[f32; 4]> for ImColor32

fn from(v: [f32; 4]) -> Self

Performs the conversion.

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

fn from(v: (f32, f32, f32, f32)) -> Self

Performs the conversion.

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

fn from(v: (f32, f32, f32)) -> Self

Performs the conversion.

impl From<ImColor32> for u32

fn from(color: ImColor32) -> Self

Performs the conversion.

impl From<ImColor32> for [f32; 4]

fn from(v: ImColor32) -> Self

Performs the conversion.

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

fn from(color: ImColor32) -> Self

Performs the conversion.

impl From<u32> for ImColor32

fn from(color: u32) -> Self

Performs the conversion.

impl Hash for ImColor32

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for ImColor32

fn cmp(&self, other: &ImColor32) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ImColor32> for ImColor32

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

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

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

This method tests for !=.

impl PartialOrd<ImColor32> for ImColor32

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for ImColor32

impl Eq for ImColor32

impl StructuralEq for ImColor32

impl StructuralPartialEq for ImColor32