Struct image::codecs::bmp::decoder::BmpDecoder

source ·
pub struct BmpDecoder<R> {
Show 15 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>,
}
Expand description

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§

source§

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

source

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

source

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

Create a new decoder that decodes from the stream r

source

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.

source

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

source

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.

source

pub(crate) fn reader(&mut self) -> &mut R

source

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

source

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.

source

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.

source

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

source

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

source

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

source

fn bytes_per_color(&self) -> usize

source

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

source

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

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

source

fn num_channels(&self) -> usize

source

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

source

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

source

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

source

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.

source

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).

source

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

source

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§

source§

impl<'a, R: 'a + Read + Seek> ImageDecoder<'a> for BmpDecoder<R>

source§

type Reader = BmpReader<R>

The type of reader produced by into_reader.
source§

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

Returns a tuple containing the width and height of the image
source§

fn color_type(&self) -> ColorType

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

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

👎Deprecated: Planned for removal. See https://github.com/image-rs/image/issues/1989
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.
source§

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

Returns all the bytes in the image. Read more
source§

fn original_color_type(&self) -> ExtendedColorType

Returns the color type of the image file before decoding
source§

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

Returns the ICC color profile embedded in the image Read more
source§

fn total_bytes(&self) -> u64

Returns the total number of bytes in the decoded image. Read more
source§

fn scanline_bytes(&self) -> u64

👎Deprecated: Planned for removal. See https://github.com/image-rs/image/issues/1989
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().
source§

fn read_image_with_progress<F: Fn(Progress)>( self, buf: &mut [u8], progress_callback: F, ) -> ImageResult<()>

👎Deprecated: Use read_image instead. See https://github.com/image-rs/image/issues/1989
Same as read_image but periodically calls the provided callback to give updates on loading progress.
source§

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

Set decoding limits for this decoder. See Limits for the different kinds of limits that is possible to set. Read more
source§

impl<'a, R: 'a + Read + Seek> ImageDecoderRect<'a> for BmpDecoder<R>

source§

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

👎Deprecated: Use read_image instead. See https://github.com/image-rs/image/issues/1989
Decode a rectangular section of the image, periodically reporting progress. Read more
source§

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

Decode a rectangular section of the image; see read_rect_with_progress().

Auto Trait Implementations§

§

impl<R> Freeze for BmpDecoder<R>
where R: Freeze,

§

impl<R> RefUnwindSafe for BmpDecoder<R>
where R: RefUnwindSafe,

§

impl<R> Send for BmpDecoder<R>
where R: Send,

§

impl<R> Sync for BmpDecoder<R>
where R: Sync,

§

impl<R> Unpin for BmpDecoder<R>
where R: Unpin,

§

impl<R> UnwindSafe for BmpDecoder<R>
where R: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
source§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.