Struct tinybmp::RawBmp

pub struct RawBmp<'a> { /* private fields */ }

Low-level access to BMP image data.

This struct can be used to access the image data in a BMP file at a lower level than with the Bmp struct. It doesn’t do automatic color conversion and doesn’t apply the color table, if it is present in the BMP file. For images with a color table the iterator returned by pixels will instead return the color indices, that can be looked up manually using the ColorTable struct.

Implementations

impl<'a> RawBmp<'a>

pub fn from_slice(bytes: &'a [u8]) -> Result<Self, ParseError>

Create a bitmap object from a byte slice.

The created object keeps a shared reference to the input and does not dynamically allocate memory.

pub const fn color_table(&self) -> Option<&ColorTable<'a>>

Returns the color table associated with the image.

pub const fn image_data(&self) -> &'a [u8]

Returns a slice containing the raw image data.

pub const fn header(&self) -> &Header

Returns a reference to the BMP header.

pub fn pixels(&self) -> RawPixels<'_>

Returns an iterator over the raw pixels in the image.

The iterator returns the raw pixel colors as u32 values. To automatically convert the raw values into embedded_graphics color types use Bmp::pixels instead.

pub fn pixel(&self, p: Point) -> Option<u32>

Returns the raw color of a pixel.

Returns None if p is outside the image bounding box. Note that this function doesn’t apply a color map, if the image contains one.

This routine always returns None if the bitmap is RLE compressed, as RLE compressed bitmaps don’t easily allow direct access to any given pixel.

Trait Implementations

impl<'a> Clone for RawBmp<'a>

fn clone(&self) -> RawBmp<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RawBmp<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for RawBmp<'a>

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<'a> Ord for RawBmp<'a>

fn cmp(&self, other: &RawBmp<'a>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<'a> PartialEq for RawBmp<'a>

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

fn partial_cmp(&self, other: &RawBmp<'a>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> Copy for RawBmp<'a>

impl<'a> Eq for RawBmp<'a>

impl<'a> StructuralPartialEq for RawBmp<'a>