Struct BmpDecoder 

pub struct BmpDecoder<R> { /* private fields */ }

A bmp decoder

Implementations

impl<R> BmpDecoder<R>

where R: BufRead + Seek,

pub fn new(reader: R) -> Result<BmpDecoder<R>, ImageError>

Create a new decoder that decodes from the stream r

pub fn new_without_file_header(reader: R) -> Result<BmpDecoder<R>, ImageError>

Create a new decoder that decodes from the stream r without first reading a BITMAPFILEHEADER. This is useful for decoding the CF_DIB format directly from the Windows clipboard.

pub fn set_indexed_color(&mut self, indexed_color: bool)

If true, the palette in BMP does not apply to the image even if it is found. In other words, the output image is the indexed color.

pub fn get_palette(&self) -> Option<&[[u8; 3]]>

Get the palette that is embedded in the BMP image, if any.

Trait Implementations

impl<R> ImageDecoder for BmpDecoder<R>

where R: BufRead + Seek,

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

Returns a tuple containing the width and height of the image

fn color_type(&self) -> ColorType

Returns the color type of the image data produced by this decoder

fn read_image(self, buf: &mut [u8]) -> Result<(), ImageError>

Returns all the bytes in the image.

fn read_image_boxed( self: Box<BmpDecoder<R>>, buf: &mut [u8], ) -> Result<(), ImageError>

Use read_image instead; this method is an implementation detail needed so the trait can be object safe.

fn original_color_type(&self) -> ExtendedColorType

Returns the color type of the image file before decoding

fn icc_profile(&mut self) -> Result<Option<Vec<u8>>, ImageError>

Returns the ICC color profile embedded in the image, or Ok(None) if the image does not have one.

fn exif_metadata(&mut self) -> Result<Option<Vec<u8>>, ImageError>

Returns the raw Exif chunk, if it is present. A third-party crate such as kamadak-exif is required to actually parse it.

fn orientation(&mut self) -> Result<Orientation, ImageError>

Returns the orientation of the image.

fn total_bytes(&self) -> u64

Returns the total number of bytes in the decoded image.

fn set_limits(&mut self, limits: Limits) -> Result<(), ImageError>

Set the decoder to have the specified limits. See Limits for the different kinds of limits that is possible to set.

impl<R> ImageDecoderRect for BmpDecoder<R>

where R: BufRead + Seek,

fn read_rect( &mut self, x: u32, y: u32, width: u32, height: u32, buf: &mut [u8], row_pitch: usize, ) -> Result<(), ImageError>

Decode a rectangular section of the image.