Struct png_framing::Png

pub struct Png<T> { /* fields omitted */ }

A raw RGBA image that can be converted easily to/from a PNG.

Methods

impl Png<Native>

fn decode(bytes: &[u8]) -> Result<Self, Error>

Decodes the image which has been encoded in the given bytes.

fn load<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Loads the PNG at the given file path.

impl<T> Png<T>

fn buffer(&self) -> &T

Borrows the buffer that the PNG was created with.

fn into_buffer(self) -> T

Recovers the buffer that the PNG was created with.

This operation destroys the PNG, since mutations to the buffer could alter the length of the buffer, and thus lead to undefined behavior.

impl<T> Png<T> where
    T: AsRef<[u8]>, 

fn from_bytes(width: usize, height: usize, buffer: T) -> Png<T>

Creates a new PNG given the width, height, and raw RGBA image data.

Panics

Panics if the buffer's length is not exactly width * height * 4.

fn save<P: AsRef<Path>>(&self, path: P) -> Result<(), Error>

Saves the PNG to the given file path.

Any existing file at the path will be overwritten. This is basically the same as encoding the image and writing it yourself, but is a lot more convenient.

fn encode(&self) -> Result<CVec<u8>, Error>

Encodes the PNG, allocating the necessary memory for the encoded data.

The output is an array of bytes with the compressed PNG data, suitable for sending over a network or writing to a file.

impl Png<Bytes>

fn new<T>(frame: T) -> Self where
    T: VideoFrame + Sync,
    T::Pixel: Into<Rgba>, 

Creates a new image from the given frame.

Note that this function allocates, since the underlying library, lodepng, can unfortunately only operate on a contiguous buffer. Maybe when I get good enough to write my own encoder, this won't have to allocate any memory.

Trait Implementations

impl From<ChunkyFrame<Rgba>> for Png<Bytes>

fn from(frame: ChunkyFrame<Rgba>) -> Self

Performs the conversion.

impl<T> AsRef<[u8]> for Png<T> where
    T: AsRef<[u8]>, 

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl<T> AsMut<[u8]> for Png<T> where
    T: AsMut<[u8]>, 

fn as_mut(&mut self) -> &mut [u8]

Performs the conversion.

impl<T> VideoFrame for Png<T> where
    T: AsRef<[u8]>, 

type Pixel = Rgba

The kind of pixel that the frame is made of.

fn width(&self) -> usize

The width of the frame in pixels.

fn height(&self) -> usize

The height of the frame in pixels.

unsafe fn pixel(&self, x: usize, y: usize) -> Self::Pixel

Gets the pixel at the specified zero-indexed coordinates.