Struct x11rb::image::PixelLayout

pub struct PixelLayout { /* fields omitted */ }

A collection of color components describing the red, green, and blue components of a pixel.

A ColorComponent describes a single color component in an image. This structure describes the red, green, and blue color components by containing a ColorComponent for each of them.

Implementations

impl PixelLayout

pub fn new(
    red: ColorComponent,
    green: ColorComponent,
    blue: ColorComponent
) -> Self

Create a new pixel layout from the description of each component

pub fn from_visual_type(visual: Visualtype) -> Result<Self, ParseError>

Create a new pixel layout

This function errors if the visual has a different class than TrueColor or DirectColor, because color pallets and grayscales are not supported. This function also errors if the mask components of the visual are malformed.

pub fn depth(self) -> u8

Get the depth of this pixel layout.

The depth is the number of significant bits of each pixel value.

pub fn decode(self, pixel: u32) -> (u16, u16, u16)

Decode a pixel value into its red, green, and blue components.

This function returns each component expanded to width 16.

let layout = PixelLayout::new(
    ColorComponent::new(8, 16)?,
    ColorComponent::new(8, 8)?,
    ColorComponent::new(8, 0)?,
);
assert_eq!((0xABAB, 0x4343, 0x2121), layout.decode(0x78AB_4321));

pub fn encode(self, (red, green, blue): (u16, u16, u16)) -> u32

Encode a color value according to this layout.

let layout = PixelLayout::new(
    ColorComponent::new(8, 16)?,
    ColorComponent::new(8, 8)?,
    ColorComponent::new(8, 0)?,
);
assert_eq!(0x00AB_4321, layout.encode((0xABAB, 0x4343, 0x2121)));

Trait Implementations

impl Clone for PixelLayout

fn clone(&self) -> PixelLayout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PixelLayout

impl Debug for PixelLayout

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

Formats the value using the given formatter.

impl Eq for PixelLayout

impl PartialEq<PixelLayout> for PixelLayout

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

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

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

This method tests for !=.

impl StructuralEq for PixelLayout

impl StructuralPartialEq for PixelLayout