Struct image::codecs::webp::WebPDecoder

pub struct WebPDecoder<R> {
    r: R,
    image: WebPImage,
}

WebP Image format decoder. Currently only supports lossy RGB images or lossless RGBA images.

Fields

r: R

image: WebPImage

Implementations

impl<R: Read> WebPDecoder<R>

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

Create a new WebPDecoder from the Reader r. This function takes ownership of the Reader.

fn read_riff_header(&mut self) -> ImageResult<u32>

fn read_frame(&mut self) -> ImageResult<WebPImage>

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

pub fn has_animation(&self) -> bool

Returns true if the image as described by the bitstream is animated.

pub fn set_background_color(&mut self, color: Rgba<u8>) -> ImageResult<()>

Sets the background color if the image is an extended and animated webp.

Trait Implementations

impl<'a, R: 'a + Read> AnimationDecoder<'a> for WebPDecoder<R>

fn into_frames(self) -> Frames<'a>

Consume the decoder producing a series of frames.

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

type Reader = WebpReader<R>

The type of reader produced by into_reader.

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

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

Returns all the bytes in the image.

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

Returns the ICC color profile embedded in the image

fn original_color_type(&self) -> ExtendedColorType

Returns the color type of the image file before decoding

fn total_bytes(&self) -> u64

Returns the total number of bytes in the decoded image.

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

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.

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.