Skip to main content

PngParser

Struct PngParser 

Source
pub struct PngParser { /* private fields */ }
Expand description

Reads a PNG file or byte buffer and decodes it into a Texture.

Animated PNG (APNG) is supported: parse() still returns the single default image, while the animation frames are exposed via isAnimated(), frameCount(), frame(), frameDelayMs() and frameInfo().

Implementations§

Source§

impl PngParser

Source

pub fn new() -> Self

§Panics

Panics if the native allocation fails.

Source

pub fn parse(&mut self, buffer: &[u8]) -> Option<Texture>

Parse a PNG byte buffer.

Source

pub fn has_issues(&self) -> bool

@return true if the last parse produced any issues.

Source

pub fn issues(&self) -> Vec<String>

@return accumulated issues from the last parse call.

Source

pub fn is_animated(&self) -> bool

@return true if the last parsed PNG carried APNG animation chunks.

Source

pub fn frame_count(&self) -> u32

@return number of animation frames (0 when not animated).

Source

pub fn loop_count(&self) -> u32

@return APNG loop count from the acTL chunk; 0 means loop forever.

Source

pub fn frame(&self, index: u32) -> Option<Texture>

@return animation frame @p index, fully composited to the canvas size as an RGBA8 texture. In lenient mode an out-of-range index yields an empty texture; in strict mode it throws. @param index Zero-based frame index.

Source

pub fn frame_delay_ms(&self, index: u32) -> u32

@return display duration of frame @p index in milliseconds. @param index Zero-based frame index.

Source

pub fn frame_info(&self, index: u32) -> Option<PngApngFrameInfo>

@return raw per-frame metadata for frame @p index. @param index Zero-based frame index.

Trait Implementations§

Source§

impl Debug for PngParser

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for PngParser

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Drop for PngParser

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl Send for PngParser

Auto Trait Implementations§

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