Enum evegfx::display_list::options::BitmapFormat

#[repr(u8)]pub enum BitmapFormat {
    ARGB1555,
    L1,
    L4,
    L8,
    RGB332,
    ARGB2,
    ARGB4,
    RGB565,
    Text8x8,
    TextVGA,
    Bargraph,
    Paletted565,
    Paletted4444,
    Paletted8,
    L2,
    GLFormat,
}

Variants

ARGB1555

L1

L4

L8

RGB332

ARGB2

ARGB4

RGB565

Text8x8

TextVGA

Bargraph

Paletted565

Paletted4444

Paletted8

L2

GLFormat

Implementations

impl BitmapFormat

pub fn minimum_stride(self, width: u32) -> u32

Computes the most compact possible stride for an image of the given width (in pixels) in the associated bitmap format.

A bitmap might have a larger stride than returned by this function, whether due to its representation in memory having gaps or due to there being multiple "cells" associated with the bitmap, each of which is of the indicated width. In the latter case, you can multiply the minimum_stride result by the number of cells to find the true stride, assuming that the cells are stored compactly.

For bitmap formats with fewer than eight bits per pixel, the result is automatically padded to a round number of bytes, as expected by the display engine.

For the bitmap formats that are based on character cells rather than on pixels, the width should be given in character cells, and the result will be the minimum stride for that given number of character cells.

BitmapFormat::GLFormat is not supported for this method, because it's not a real format but rather just a marker that the format is specified as a BitmapExtFormat instead. BitmapFormat::GLFormat therefore always returns a stride of zero, as an invalid placeholder.

pub fn needs_ext_format(self) -> bool

Returns true if the format requires an extended format to be specified and is therefore not self-sufficient.

If you intend to represent extended formats then you should use BitmapExtFormat instead. Converting a BitmapExtFormat to BitmapFormat will return a format which returns true from this method if the extended format doesn't correspond with one of the base formats.

Trait Implementations

impl Clone for BitmapFormat

fn clone(&self) -> BitmapFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for BitmapFormat

impl From<BitmapExtFormat> for BitmapFormat

fn from(ext: BitmapExtFormat) -> Self

Performs the conversion.

impl PartialEq<BitmapFormat> for BitmapFormat

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralPartialEq for BitmapFormat

impl TryFrom<BitmapFormat> for BitmapExtFormat

type Error = ()

The type returned in the event of a conversion error.

fn try_from(fmt: BitmapFormat) -> Result<Self, ()>

Performs the conversion.

impl TryFrom<u8> for BitmapFormat

type Error = TryFromPrimitiveError<Self>

The type returned in the event of a conversion error.

fn try_from(number: u8) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFromPrimitive for BitmapFormat

type Primitive = u8

const NAME: &'static str

fn try_from_primitive(
    number: Self::Primitive
) -> Result<Self, TryFromPrimitiveError<Self>>