Struct image::bmp::BMPDecoder

pub struct BMPDecoder<R> { /* fields omitted */ }

A bmp decoder

Methods

impl<R: Read + Seek> BMPDecoder<R>

pub fn new(r: R) -> ImageResult<BMPDecoder<R>>

Create a new decoder that decodes from the stream r

Trait Implementations

impl<R: Read + Seek> ImageDecoder for BMPDecoder<R>

type Reader = Cursor<Vec<u8>>

The type of reader produced by into_reader.

fn dimensions(&self) -> (u64, u64)

Returns a tuple containing the width and height of the image

fn colortype(&self) -> ColorType

Returns the color type of the image e.g. RGB(8) (8bit RGB)

fn into_reader(self) -> ImageResult<Self::Reader>

Returns a reader that can be used to obtain the bytes of the image. For the best performance, always try to read at least scanline_bytes from the reader at a time. Reading fewer bytes will cause the reader to perform internal buffering.

fn read_image(self) -> ImageResult<Vec<u8>>

Returns all the bytes in the image.

fn row_bytes(&self) -> u64

Returns the number of bytes in a single row of the image. All decoders will pad image rows to a byte boundary.

fn total_bytes(&self) -> u64

Returns the total number of bytes in the image.

fn scanline_bytes(&self) -> u64

Returns the minimum number of bytes that can be efficiently read from this decoder. This may be as few as 1 or as many as total_bytes().

fn read_image_with_progress<F: Fn(Progress)>(
    self,
    progress_callback: F
) -> ImageResult<Vec<u8>>

Same as read_image but periodically calls the provided callback to give updates on loading progress.

impl<R: Read + Seek> ImageDecoderExt for BMPDecoder<R>

fn read_rect_with_progress<F: Fn(Progress)>(
    &mut self,
    x: u64,
    y: u64,
    width: u64,
    height: u64,
    buf: &mut [u8],
    progress_callback: F
) -> ImageResult<()>

Read a rectangular section of the image, periodically reporting progress.

fn read_rect(
    &mut self,
    x: u64,
    y: u64,
    width: u64,
    height: u64,
    buf: &mut [u8]
) -> ImageResult<()>

Read a rectangular section of the image.