Enum PixelFormat

#[repr(u8)]
pub enum PixelFormat {
    RGB555 = 1,
    RGB565 = 2,
    RGB888 = 3,
    BGR555 = 4,
    BGR565 = 5,
    BGR888 = 6,
    ARGB8888 = 16,
    RGBA8888 = 17,
    ABGR8888 = 18,
    BGRA8888 = 19,
    G1 = 64,
    G2 = 65,
    G4 = 66,
    G8 = 67,
    AG88 = 83,
    GA88 = 99,
    PAL1 = 128,
    PAL2 = 129,
    PAL4 = 130,
    PAL8 = 131,
}

Available on crate feature alloc and crate feature term and (crate features io or std) and (crate features dep_hashbrown or std) and crate feature image only.

Pixel format type of input image.

Adaptation

Derived from pixelFormat enum in the libsixel C library.

Variants

RGB555 = 1

RGB color 15bpp.

RGB565 = 2

RGB color 16bpp.

RGB888 = 3

RGB color 24bpp. (Default)

BGR555 = 4

BGR color 15bpp.

BGR565 = 5

BGR color 16bpp.

BGR888 = 6

BGR color 24bpp.

ARGB8888 = 16

ARGB color 32bpp.

RGBA8888 = 17

RGBA color 32bpp.

ABGR8888 = 18

ABGR color 32bpp.

BGRA8888 = 19

BGRA color 32bpp.

G1 = 64

Grayscale 1bpp.

G2 = 65

Grayscale 2bpp.

G4 = 66

Grayscale 4bpp.

G8 = 67

Grayscale 8bpp.

AG88 = 83

AG grayscale 16bpp.

GA88 = 99

GA grayscale 16bpp.

PAL1 = 128

Palette 1bpp.

PAL2 = 129

Palette 2bpp.

PAL4 = 130

Palette 4bpp.

PAL8 = 131

Palette 8bpp.

Implementations

impl PixelFormat

pub const fn bits_per_pixel(self) -> usize

Returns the bits per pixel of the current format.

pub const fn bytes_per_pixel(self) -> usize

Returns the bytes per pixel of the current format.

pub const fn required_bytes(self, width: i32, height: i32) -> usize

Returns the number of bytes required to store an image of the given dimensions, using the current pixel format.

Trait Implementations

impl Clone for PixelFormat

fn clone(&self) -> PixelFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConstDefault for PixelFormat

const DEFAULT: Self = Self::RGB888

Returns the compile-time “default value” for a type.

impl Debug for PixelFormat

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

Formats the value using the given formatter.

impl Default for PixelFormat

fn default() -> PixelFormat

Returns the “default value” for a type.

impl Hash for PixelFormat

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 PartialEq for PixelFormat

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

impl Eq for PixelFormat

impl StructuralPartialEq for PixelFormat