Struct tinybmp::RawBmp

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

A BMP-format bitmap.

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.

In contrast to the from_slice constructor no color type needs to be specified when calling this method. This will disable all functions that requires a specified color type, like the pixels method.

pub fn size(&self) -> Size

Returns the size of this image in pixels.

pub fn color_bpp(&self) -> Bpp

Returns the BPP (bits per pixel) for this image.

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

Returns a slice containing the raw image data.

pub fn header(&self) -> &Header

Returns a reference to the BMP header.

pub fn pixels<'b>(&'b self) -> RawPixels<'b, 'a>

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 the color specified by C use pixels instead.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

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

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for RawBmp<'a>

pub fn cmp(&self, other: &RawBmp<'a>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

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

pub fn eq(&self, other: &RawBmp<'a>) -> bool

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

pub fn ne(&self, other: &RawBmp<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<RawBmp<'a>> for RawBmp<'a>

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

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

pub fn lt(&self, other: &RawBmp<'a>) -> bool

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

pub fn le(&self, other: &RawBmp<'a>) -> bool

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

pub fn gt(&self, other: &RawBmp<'a>) -> bool

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

pub fn ge(&self, other: &RawBmp<'a>) -> bool

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

impl<'a> StructuralEq for RawBmp<'a>

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