Struct PixelFormat

pub struct PixelFormat {
    pub bits_per_pixel: u8,
    pub depth: u8,
    pub big_endian_flag: u8,
    pub true_color_flag: u8,
    pub red_max: u16,
    pub green_max: u16,
    pub blue_max: u16,
    pub red_shift: u8,
    pub green_shift: u8,
    pub blue_shift: u8,
    /* private fields */
}

Pixel Format Data Structure according to RFC6143

+--------------+--------------+-----------------+
| No. of bytes | Type [Value] | Description     |
+--------------+--------------+-----------------+
| 1            | U8           | bits-per-pixel  |
| 1            | U8           | depth           |
| 1            | U8           | big-endian-flag |
| 1            | U8           | true-color-flag |
| 2            | U16          | red-max         |
| 2            | U16          | green-max       |
| 2            | U16          | blue-max        |
| 1            | U8           | red-shift       |
| 1            | U8           | green-shift     |
| 1            | U8           | blue-shift      |
| 3            |              | padding         |
+--------------+--------------+-----------------+

Fields

bits_per_pixel: u8

the number of bits used for each pixel value on the wire

8, 16, 32(usually) only

depth: u8

Although the depth should

be consistent with the bits-per-pixel and the various -max values,

clients do not use it when interpreting pixel data.

big_endian_flag: u8

true if multi-byte pixels are interpreted as big endian

true_color_flag: u8

true then the last six items specify how to extract the red, green and blue intensities from the pixel value

red_max: u16

the next three always in big-endian order no matter how the big_endian_flag is set

green_max: u16

blue_max: u16

red_shift: u8

the number of shifts needed to get the red value in a pixel to the least significant bit

green_shift: u8

blue_shift: u8

Implementations

impl PixelFormat

pub fn bgra() -> PixelFormat

pub fn rgba() -> PixelFormat

Trait Implementations

impl Clone for PixelFormat

fn clone(&self) -> PixelFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PixelFormat

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

Formats the value using the given formatter.

impl Default for PixelFormat

fn default() -> Self

Returns the “default value” for a type.

impl From<PixelFormat> for Vec<u8>

fn from(pf: PixelFormat) -> Vec<u8>

Converts to this type from the input type.

impl TryFrom<[u8; 16]> for PixelFormat

type Error = VncError

The type returned in the event of a conversion error.

fn try_from(pf: [u8; 16]) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for PixelFormat