Enum Format 

pub enum Format {
    Xy {
        format: XyFormatType,
        quantum: Quantum,
        bit_order: ImageOrder,
        left_pad: u8,
    },
    Z {
        depth: u8,
        bits_per_pixel: BitsPerPixel,
    },
}

The format that an image can have.

Variants

Xy

The image is in XY format.

The image is serialized as a series of planes of pixels, where one can determine the value by adding up the values taken from the planes.

Fields

format: XyFormatType

The direct format of the image.

This determines whether it is in bitmap format or pixmap format.

quantum: Quantum

The quantum of the image.

Each scanline can be broken down into a series of values of this type. For instance, if the quantum was 32, you could represent the scanline as a slice of u32s, although the padding may actually differ.

bit_order: ImageOrder

The bit order to be used in the image.

This determines whether the leftmost bit is either the least or most significant bit.

left_pad: u8

Leftmost padding to apply.

Z

The image in in Z format.

The image is serialized such that each pixel exists in its entire bit pattern.

Fields

depth: u8

The depth of the image.

bits_per_pixel: BitsPerPixel

The bits per pixel for this image.

This value is always greater than or equal to the depth. If it is larger, the least significant bits hold the data.

Implementations

impl Format

pub fn depth(&self) -> u8

pub fn format(&self) -> ImageFormat

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Format

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

Formats the value using the given formatter.

impl Hash for Format

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Format

fn cmp(&self, other: &Format) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Format

fn eq(&self, other: &Format) -> 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 PartialOrd for Format

fn partial_cmp(&self, other: &Format) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Format

impl Eq for Format

impl StructuralPartialEq for Format