Struct image::codecs::bmp::encoder::BmpEncoder

pub struct BmpEncoder<'a, W: 'a> {
    writer: &'a mut W,
}

The representation of a BMP encoder.

Fields

writer: &'a mut W

Implementations

impl<'a, W: Write + 'a> BmpEncoder<'a, W>

pub fn new(w: &'a mut W) -> Self

Create a new encoder that writes its output to w.

pub fn encode( &mut self, image: &[u8], width: u32, height: u32, c: ColorType, ) -> ImageResult<()>

Encodes the image image that has dimensions width and height and ColorType c.

Panics

Panics if width * height * c.bytes_per_pixel() != image.len().

pub fn encode_with_palette( &mut self, image: &[u8], width: u32, height: u32, c: ColorType, palette: Option<&[[u8; 3]]>, ) -> ImageResult<()>

Same as encode, but allow a palette to be passed in. The palette is ignored for color types other than Luma/Luma-with-alpha.

Panics

Panics if width * height * c.bytes_per_pixel() != image.len().

fn encode_rgb( &mut self, image: &[u8], width: u32, height: u32, row_pad_size: u32, bytes_per_pixel: u32, ) -> Result<()>

fn encode_rgba( &mut self, image: &[u8], width: u32, height: u32, row_pad_size: u32, bytes_per_pixel: u32, ) -> Result<()>

fn encode_gray( &mut self, image: &[u8], width: u32, height: u32, row_pad_size: u32, bytes_per_pixel: u32, palette: Option<&[[u8; 3]]>, ) -> Result<()>

fn write_row_pad(&mut self, row_pad_size: u32) -> Result<()>

Trait Implementations

impl<'a, W: Write> ImageEncoder for BmpEncoder<'a, W>

fn write_image( self, buf: &[u8], width: u32, height: u32, color_type: ColorType, ) -> ImageResult<()>

Writes all the bytes in an image to the encoder.