Struct palette::Packed

#[repr(C)]
pub struct Packed<C = Argb> {
    pub color: u32,
    pub channel_order: PhantomData<C>,
}

RGBA color packed into a 32-bit unsigned integer. Defaults to ARGB ordering for Rgb types and RGBA ordering for Rgba types.

Packed integer type represented in u32. Two hexadecimal digits (8-bits) express each value of the Red, Green, Blue, and Alpha components in the RGBA color.

Note that conversion from float to integer component types in palette rounds to nearest even: an Rgb component of 0.5 will convert to 0x80/128, not 0x7F/127.

use approx::assert_relative_eq;
use palette::{Packed, Srgb, Srgba};
use palette::rgb::channels::{Argb, Rgba};

let packed: Packed = Srgb::new(0.5, 0.0, 0.5).into_format().into();
assert_eq!(0xFF80_0080, packed.color);

let unpacked: Srgba<u8> = Packed::<Rgba>::from(0xFFFF_FF80).into();
assert_relative_eq!(
    Srgba::new(1.0, 1.0, 1.0, 0.5),
    unpacked.into_format(),
    epsilon = 0.01
);

// By default, `Packed` uses `Argb` order for creating `Rgb` colors to make
// entering 6-digit hex numbers more convenient
let rgb = Srgb::from(0xFF8000);
assert_eq!(Srgb::new(0xFF, 0x80, 0x00), rgb);

let rgba = Srgba::from(0xFF80007F);
assert_eq!(Srgba::new(0xFF, 0x80, 0x00, 0x7F), rgba);

When an Rgb type is packed, the alpha value will be 0xFF in the corresponding u32. Converting from a packed color type back to an Rgb type will disregard the alpha value.

Packed implements Pixel and can be constructed from a slice of &[u32].

use palette::{Packed, Pixel};
use palette::rgb::channels::Argb;

let raw = &[0x7F0080u32, 0x60BBCC];
let colors = Packed::<Argb>::from_raw_slice(raw);

assert_eq!(colors.len(), 2);
assert_eq!(colors[0].color, 0x7F0080);
assert_eq!(colors[1].color, 0x60BBCC);

Fields

color: u32

The sRGB color packed into a u32.

channel_order: PhantomData<C>

The channel ordering for red, green, blue, and alpha components in the packed integer; can be Abgr, Argb, Bgra, or Rgba. See RgbChannels.

Trait Implementations

impl<C> Clone for Packed<C>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for Packed<C>

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

Formats the value using the given formatter.

impl<S, C> From<Alpha<Rgb<S, u8>, u8>> for Packed<C> where
    S: RgbStandard,
    C: RgbChannels, 

fn from(color: Rgba<S, u8>) -> Self

Converts to this type from the input type.

impl<S, C> From<Packed<C>> for Rgb<S, u8> where
    S: RgbStandard,
    C: RgbChannels, 

fn from(packed: Packed<C>) -> Self

Converts to this type from the input type.

impl<S, C> From<Packed<C>> for Rgba<S, u8> where
    S: RgbStandard,
    C: RgbChannels, 

fn from(packed: Packed<C>) -> Self

Converts to this type from the input type.

impl<S, C> From<Rgb<S, u8>> for Packed<C> where
    S: RgbStandard,
    C: RgbChannels, 

fn from(color: Rgb<S, u8>) -> Self

Converts to this type from the input type.

impl<C: RgbChannels> From<u32> for Packed<C>

fn from(color: u32) -> Self

Converts to this type from the input type.

impl<C: PartialEq> PartialEq<Packed<C>> for Packed<C>

fn eq(&self, other: &Packed<C>) -> bool

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

fn ne(&self, other: &Packed<C>) -> bool

This method tests for !=.

impl<C> Pixel<u32> for Packed<C>

const CHANNELS: usize = 1usize

The number of color channels.

fn as_raw<P: RawPixel<T> + ?Sized>(&self) -> &P

Cast as a reference to raw color components.

fn as_raw_mut<P: RawPixel<T> + ?Sized>(&mut self) -> &mut P

Cast as a mutable reference to raw color components.

fn into_raw<P: RawPixelSized<T>>(self) -> P

Convert into raw color components.

fn from_raw<P: RawPixel<T> + ?Sized>(pixel: &P) -> &Self

Cast from a reference to raw color components.

fn from_raw_mut<P: RawPixel<T> + ?Sized>(pixel: &mut P) -> &mut Self

Cast from a mutable reference to raw color components.

fn from_raw_slice(slice: &[T]) -> &[Self]

Cast a slice of raw color components to a slice of colors.

fn from_raw_slice_mut(slice: &mut [T]) -> &mut [Self]

Cast a mutable slice of raw color components to a mutable slice of colors.

fn into_raw_slice(slice: &[Self]) -> &[T]

Cast a slice of colors to a slice of raw color components.

fn into_raw_slice_mut(slice: &mut [Self]) -> &mut [T]

Cast a mutable slice of colors to a mutable slice of raw color components.

impl<C> Copy for Packed<C>

impl<C: Eq> Eq for Packed<C>

impl<C> StructuralEq for Packed<C>

impl<C> StructuralPartialEq for Packed<C>