Struct BmpDecoder

pub struct BmpDecoder<R> {

    reader: R,
    bmp_header_type: BMPHeaderType,
    indexed_color: bool,
    width: i32,
    height: i32,
    data_offset: u64,
    top_down: bool,
    no_file_header: bool,
    add_alpha_channel: bool,
    has_loaded_metadata: bool,
    image_type: ImageType,
    bit_count: u16,
    colors_used: u32,
    palette: Option<Vec<[u8; 3]>>,
    bitfields: Option<Bitfields>,
}

A bmp decoder

Fields

reader: R

bmp_header_type: BMPHeaderType

indexed_color: bool

width: i32

height: i32

data_offset: u64

top_down: bool

no_file_header: bool

add_alpha_channel: bool

has_loaded_metadata: bool

image_type: ImageType

bit_count: u16

colors_used: u32

palette: Option<Vec<[u8; 3]>>

bitfields: Option<Bitfields>

Implementations

impl<R: BufRead + Seek> BmpDecoder<R>

fn new_decoder(reader: R) -> BmpDecoder<R>

pub fn new(reader: R) -> ImageResult<BmpDecoder<R>>

Create a new decoder that decodes from the stream r

pub fn new_without_file_header(reader: R) -> ImageResult<BmpDecoder<R>>

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(crate) fn new_with_ico_format(reader: R) -> ImageResult<BmpDecoder<R>>

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(crate) fn reader(&mut self) -> &mut R

fn read_file_header(&mut self) -> ImageResult<()>

fn read_bitmap_core_header(&mut self) -> ImageResult<()>

Read BITMAPCOREHEADER https://msdn.microsoft.com/en-us/library/vs/alm/dd183372(v=vs.85).aspx

returns Err if any of the values are invalid.

fn read_bitmap_info_header(&mut self) -> ImageResult<()>

Read BITMAPINFOHEADER https://msdn.microsoft.com/en-us/library/vs/alm/dd183376(v=vs.85).aspx or BITMAPV{2|3|4|5}HEADER.

returns Err if any of the values are invalid.

fn read_bitmasks(&mut self) -> ImageResult<()>

fn read_metadata(&mut self) -> ImageResult<()>

fn get_palette_size(&mut self) -> ImageResult<usize>

fn bytes_per_color(&self) -> usize

fn read_palette(&mut self) -> ImageResult<()>

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

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

fn num_channels(&self) -> usize

fn rows<'a>(&self, pixel_data: &'a mut [u8]) -> RowIterator<'a>

fn read_palettized_pixel_data(&mut self, buf: &mut [u8]) -> ImageResult<()>

fn read_16_bit_pixel_data( &mut self, buf: &mut [u8], bitfields: Option<&Bitfields>, ) -> ImageResult<()>

fn read_32_bit_pixel_data(&mut self, buf: &mut [u8]) -> ImageResult<()>

Read image data from a reader in 32-bit formats that use bitfields.

fn read_full_byte_pixel_data( &mut self, buf: &mut [u8], format: &FormatFullBytes, ) -> ImageResult<()>

Read image data from a reader where the colours are stored as 8-bit values (24 or 32-bit).

fn read_rle_data( &mut self, buf: &mut [u8], image_type: ImageType, ) -> ImageResult<()>

pub(crate) fn read_image_data(&mut self, buf: &mut [u8]) -> ImageResult<()>

Read the actual data of the image. This function is deliberately not public because it cannot be called multiple times without seeking back the underlying reader in between.

Trait Implementations

impl<R: BufRead + Seek> ImageDecoder for BmpDecoder<R>

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]) -> ImageResult<()>

Returns all the bytes in the image.

fn read_image_boxed(self: Box<Self>, buf: &mut [u8]) -> ImageResult<()>

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) -> ImageResult<Option<Vec<u8>>>

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

fn exif_metadata(&mut self) -> ImageResult<Option<Vec<u8>>>

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) -> ImageResult<Orientation>

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) -> ImageResult<()>

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

impl<R: BufRead + Seek> ImageDecoderRect for BmpDecoder<R>

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

Decode a rectangular section of the image.