Struct Color32

#[repr(C)]
pub struct Color32 {
    pub r: u8,
    pub g: u8,
    pub b: u8,
    pub a: u8,
}

A 32 bit color struct! This is often directly used by StereoKit data structures, and so is often necessary for setting texture data, or mesh data. Note that the Color type implicitly converts to Color32, so you can use the static methods there to create Color32 values!

It’s generally best to avoid doing math on 32-bit color values, as they lack the precision necessary to create results. It’s best to think of a Color32 as an optimized end stage format of a color. https://stereokit.net/Pages/StereoKit/Color32.html

see also Color128

Examples

use stereokit_rust::util::{Color32, named_colors, Color128};

// Cyan from different sources:
let color_cyan1 = named_colors::CYAN;
let color_cyan2: Color32  = [0, 255, 255, 255].into();
let color_cyan3: Color32 = Color128 { r: 0.0, g: 1.0, b: 1.0, a: 1.0 }.into();
let color_cyan4 = Color32 {r: 0, g: 255, b: 255, a: 255};
let color_cyan5 = Color32::new (0, 255, 255, 255);
let color_cyan6 = Color32::rgba(0, 255, 255, 255);
let color_cyan7 = Color32::rgb (0, 255, 255 );
let color_cyan8 = Color32::hex (0x00FFFFFF);

assert_eq!(color_cyan1, color_cyan8);

Fields

r: u8

g: u8

b: u8

a: u8

Implementations

impl Color32

pub const BLACK: Color32

Opaque black color.

pub const BLACK_TRANSPARENT: Color32

transparent black color.

pub const WHITE: Color32

Opaque white color.

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

Constructs a 32-bit color from bytes! You may also be interested in Color32::hex. https://stereokit.net/Pages/StereoKit/Color32/Color32.html

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

Constructs a 32-bit color from bytes! You may also be interested in Color32::hex. https://stereokit.net/Pages/StereoKit/Color32/Color32.html

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

Constructs a 32-bit color from bytes! You may also be interested in Color32::hex. https://stereokit.net/Pages/StereoKit/Color32/Color32.html

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

👎Deprecated: Use Color32::rgb instead

Constructs a 32-bit color from bytes! You may also be interested in Color32::hex. a is set to 255 ! https://stereokit.net/Pages/StereoKit/Color32/Color32.html

pub fn hex(hex_value: u32) -> Self

Create a color from an integer based hex value! This can make it easier to copy over colors from the web. This isn’t a string function though, so you’ll need to fill it out the whole way. Ex: Color.Hex(0x0000FFFF) would be RGBA(0,0,255,255). https://stereokit.net/Pages/StereoKit/Color32/Hex.html

Trait Implementations

impl Clone for Color32

fn clone(&self) -> Color32

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Color32

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

Formats the value using the given formatter.

impl Default for Color32

fn default() -> Color32

Returns the “default value” for a type.

impl Display for Color32

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

Mostly for debug purposes, this is a decent way to log or inspect the color in debug mode. Looks like “Color32{r: 255, g: 255, b: 255, a: 255}” https://stereokit.net/Pages/StereoKit/Color/ToString.html

impl From<[u8; 4]> for Color32

fn from(s: [u8; 4]) -> Self

Converts to this type from the input type.

impl From<Color128> for Color32

fn from(a: Color128) -> Self

Converts to this type from the input type.

impl From<Color32> for Color128

fn from(a: Color32) -> Self

Converts to this type from the input type.

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

impl StructuralPartialEq for Color32