Struct x11rb::image::ColorComponent

pub struct ColorComponent { /* private fields */ }

The description of a single color component.

For example, in an RGB image, pixels are often saved as 0xRRGGBB, where each letter represents the respective color component. In the example, green has a width of 8 (it takes up 8 bits) and a shift of 16 (there are 16 less significant bits beyond it). This info is represented as a ColorComponent.

Implementations

impl ColorComponent

pub fn new(width: u8, shift: u8) -> Result<Self, ParseError>

Create a new color component with the given information.

The following conditions must be satisfied:

• width <= 16: color components have at most 16 bits.
• shift < 32: pixel values have at most 32 bits.
• shift + width <= 32: pixel values have at most 32 bits.

pub fn width(self) -> u8

Get the bit width of the color component.

pub fn shift(self) -> u8

Get the bit shift of the color component.

pub fn mask(self) -> u32

Get the pixel mask representing this color component.

The mask can be used to mask off other colors in a pixel value. Only the bits that correspond to this color component are set.

let red = ColorComponent::new(8, 16)?;
assert_eq!(red.mask(), 0xff0000);

pub fn from_mask(mask: u32) -> Result<Self, ParseError>

Create a new color component from a color mask.

This turns a color mask into its individual components.

let red1 = ColorComponent::new(8, 16);
let red2 = ColorComponent::from_mask(0xff0000);

Errors

This function fails if the given value is not a well-formed mask. This means that at least one bit must be set and the set bits must be consecutive.

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

Get this color component out of a pixel value.

This function gets a single pixel value and returns this color component’s value in that pixel value, expanded to width 16.

let red = ColorComponent::new(8, 16)?;
assert_eq!(0xABAB, red.decode(0x78AB_4321));

pub fn encode(self, intensity: u16) -> u32

Encode a color value according to this pixel format.

let red = ColorComponent::new(8, 16)?;
assert_eq!(0xAB0000, red.encode(0xABCD));

Trait Implementations

impl Clone for ColorComponent

fn clone(&self) -> ColorComponent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColorComponent

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

Formats the value using the given formatter.

impl PartialEq for ColorComponent

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ColorComponent

impl Eq for ColorComponent

impl StructuralPartialEq for ColorComponent