pub struct PngDecoder<R: Read> { /* private fields */ }
Expand description
PNG decoder
Implementations
sourceimpl<R: Read> PngDecoder<R>
impl<R: Read> PngDecoder<R>
sourcepub fn new(r: R) -> ImageResult<PngDecoder<R>>
pub fn new(r: R) -> ImageResult<PngDecoder<R>>
Creates a new decoder that decodes from the stream r
sourcepub fn apng(self) -> ApngDecoder<R>
pub fn apng(self) -> ApngDecoder<R>
Turn this into an iterator over the animation frames.
Reading the complete animation requires more memory than reading the data from the IDAT frame–multiple frame buffers need to be reserved at the same time. We further do not support compositing 16-bit colors. In any case this would be lossy as the interface of animation decoders does not support 16-bit colors.
If something is not supported or a limit is violated then the decoding step that requires them will fail and an error will be returned instead of the frame. No further frames will be returned.
sourcepub fn is_apng(&self) -> bool
pub fn is_apng(&self) -> bool
Returns if the image contains an animation.
Note that the file itself decides if the default image is considered to be part of the animation. When it is not the common interpretation is to use it as a thumbnail.
If a non-animated image is converted into an ApngDecoder
then its iterator is empty.
Trait Implementations
sourceimpl<'a, R: 'a + Read> ImageDecoder<'a> for PngDecoder<R>
impl<'a, R: 'a + Read> ImageDecoder<'a> for PngDecoder<R>
sourcefn dimensions(&self) -> (u32, u32)
fn dimensions(&self) -> (u32, u32)
Returns a tuple containing the width and height of the image
sourcefn color_type(&self) -> ColorType
fn color_type(&self) -> ColorType
Returns the color type of the image data produced by this decoder
sourcefn into_reader(self) -> ImageResult<Self::Reader>
fn into_reader(self) -> ImageResult<Self::Reader>
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. Read more
sourcefn read_image(self, buf: &mut [u8]) -> ImageResult<()>
fn read_image(self, buf: &mut [u8]) -> ImageResult<()>
Returns all the bytes in the image. Read more
sourcefn scanline_bytes(&self) -> u64
fn scanline_bytes(&self) -> u64
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()
. Read more
sourcefn original_color_type(&self) -> ExtendedColorType
fn original_color_type(&self) -> ExtendedColorType
Retuns the color type of the image file before decoding
sourcefn total_bytes(&self) -> u64
fn total_bytes(&self) -> u64
Returns the total number of bytes in the decoded image. Read more
sourcefn read_image_with_progress<F: Fn(Progress)>(
self,
buf: &mut [u8],
progress_callback: F
) -> ImageResult<()>
fn read_image_with_progress<F: Fn(Progress)>(
self,
buf: &mut [u8],
progress_callback: F
) -> ImageResult<()>
Same as read_image
but periodically calls the provided callback to give updates on loading
progress. Read more
Auto Trait Implementations
impl<R> RefUnwindSafe for PngDecoder<R> where
R: RefUnwindSafe,
impl<R> Send for PngDecoder<R> where
R: Send,
impl<R> Sync for PngDecoder<R> where
R: Sync,
impl<R> Unpin for PngDecoder<R> where
R: Unpin,
impl<R> UnwindSafe for PngDecoder<R> where
R: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more