Struct Bmp

pub struct Bmp<'a, C> { /* private fields */ }

A BMP-format bitmap.

See the crate-level documentation for more information.

Implementations

impl<'a, C> Bmp<'a, C>

where C: PixelColor + From<Rgb555> + From<Rgb565> + From<Rgb888>,

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

Creates a bitmap object from a byte slice.

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

pub fn pixels(&self) -> Pixels<'_, C>

Returns an iterator over the pixels in this image.

The iterator always starts at the top left corner of the image, regardless of the row order of the BMP file. The coordinate of the first pixel is (0, 0).

pub const fn as_raw(&self) -> &RawBmp<'a>

Returns a reference to the raw BMP image.

The RawBmp instance can be used to access lower level information about the BMP file.

Trait Implementations

impl<'a, C: Clone> Clone for Bmp<'a, C>

fn clone(&self) -> Bmp<'a, C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, C: Debug> Debug for Bmp<'a, C>

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

Formats the value using the given formatter.

impl<C> GetPixel for Bmp<'_, C>

where C: PixelColor + From<Rgb555> + From<Rgb565> + From<Rgb888>,

type Color = C

The color type.

fn pixel(&self, p: Point) -> Option<Self::Color>

Gets the color of a pixel.

impl<'a, C: Hash> Hash for Bmp<'a, C>

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<C> ImageDrawable for Bmp<'_, C>

where C: PixelColor + From<Rgb555> + From<Rgb565> + From<Rgb888>,

type Color = C

The color type.

fn draw<D>(&self, target: &mut D) -> Result<(), D::Error>

where D: DrawTarget<Color = C>,

Draws the entire image to the target.

fn draw_sub_image<D>( &self, target: &mut D, area: &Rectangle, ) -> Result<(), D::Error>

where D: DrawTarget<Color = Self::Color>,

Draws a part of the image to the target.

impl<'a, C: Ord> Ord for Bmp<'a, C>

fn cmp(&self, other: &Bmp<'a, C>) -> 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<C> OriginDimensions for Bmp<'_, C>

where C: PixelColor,

fn size(&self) -> Size

Returns the size of the bounding box.

impl<'a, C: PartialEq> PartialEq for Bmp<'a, C>

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

fn partial_cmp(&self, other: &Bmp<'a, C>) -> 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<'a, C: Copy> Copy for Bmp<'a, C>

impl<'a, C: Eq> Eq for Bmp<'a, C>

impl<'a, C> StructuralPartialEq for Bmp<'a, C>