Struct Color32

#[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 Hsva.

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

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 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 TEMPORARY_COLOR: Color32

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

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 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 linear_multiply(self, factor: f32) -> Color32

Multiply with 0.5 to make color half as opaque.

Trait Implementations§

impl Clone for Color32

fn clone(&self) -> Color32

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Color32

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

Formats the value using the given formatter. Read more

impl Default for Color32

fn default() -> Color32

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

impl From<Color32> for Hsva

fn from(srgba: Color32) -> Hsva

Converts to this type from the input type.

impl From<Color32> for HsvaGamma

fn from(srgba: Color32) -> HsvaGamma

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

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. Read more

impl IndexMut<usize> for Color32

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

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

impl PartialEq for Color32

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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 Zeroable for Color32

fn zeroed() -> Self

Calls zeroed. Read more

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§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.

impl<T> AsAny for T
where T: Any,

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

fn type_name(&self) -> &'static str

Gets the type name of self

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.

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.

fn is_valid_bit_pattern(_bits: &T) -> bool

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

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

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.

impl<T> Downcast for T
where T: AsAny + ?Sized,

fn is<T>(&self) -> bool
where T: AsAny,

Returns true if the boxed type is the same as T. Read more

fn downcast_ref<T>(&self) -> Option<&T>
where T: AsAny,

Forward to the method defined on the type Any.

fn downcast_mut<T>(&mut self) -> Option<&mut T>
where T: AsAny,

Forward to the method defined on the type Any.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromAngle<T> for T

fn from_angle(angle: T) -> T

Performs a conversion from angle.

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T, U> IntoAngle<U> for T
where U: FromAngle<T>,

fn into_angle(self) -> U

Performs a conversion into T.

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> IntoStimulus<T> for T

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

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

Performs the conversion.

impl<T, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

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

impl<T> Component for T
where T: Send + Sync + 'static,

impl<T> ErasedDestructor for T
where T: 'static,

impl<E> Event for E
where E: Clone + Send + Sync + 'static,

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

impl<T> Resource for T
where T: AsAny + Send + Sync + 'static,

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,