Struct Encoder

pub struct Encoder<'a, F: Write> { /* private fields */ }

APNG Encoder

Example

use apng_encoder::{Color, Delay, Frame, Meta};
use apng_encoder::Encoder;
use std::fs::File;

// Generate 2x2 Animated PNG (4 frames)
let meta = Meta {
    width: 2,
    height: 2,
    color: Color::RGB(8),
    frames: 4,
    plays: None, // Infinite loop
};

// Delay = 1/2 (0.5) seconds
let frame = Frame {
    delay: Some(Delay::new(1, 2)),
    ..Default::default()
};

let mut file = File::create("test-output/2x2.png").unwrap();
let mut encoder = Encoder::create(&mut file, meta).unwrap();

// RED   GREEN
// BLACK BLUE
encoder.write_frame(
    &[
 // (x=0,y=0)            (x=1,y=0)
    0xFF, 0x00, 0x00,    0x00, 0xFF, 0x00,
 // (x=0,y=1)            (x=1,y=1)
    0x00, 0x00, 0x00,    0x00, 0x00, 0xFF,
    ],
    Some(&frame),
    None,
    None).unwrap();
// BLACK RED
// BLUE  GREEN
encoder.write_frame(
    &[
    0x00, 0x00, 0x00,   0xFF, 0x00, 0x00,
    0x00, 0x00, 0xFF,   0x00, 0xFF, 0x00,
    ],
    Some(&frame),
    None,
    None).unwrap();
// BLUE  BLACK
// GREEN RED
encoder.write_frame(
    &[
    0x00, 0x00, 0xFF,   0x00, 0x00, 0x00,
    0x00, 0xFF, 0x00,   0xFF, 0x00, 0x00,
    ],
    Some(&frame),
    None,
    None).unwrap();
// GREEN BLUE
// RED   BLACK
encoder.write_frame(
    &[
    0x00, 0xFF, 0x00,   0x00, 0x00, 0xFF,
    0xFF, 0x00, 0x00,   0x00, 0x00, 0x00,
    ],
    Some(&frame),
    None,
    None).unwrap();
// !!IMPORTANT DONT FORGET!!
encoder.finish().unwrap();

Implementations

impl<'a, F: Write> Encoder<'a, F>

pub fn create(writer: &'a mut F, meta: Meta) -> ApngResult<Self>

pub fn finish(self) -> ApngResult<()>

pub fn write_default_image( &mut self, image_data: &[u8], filter: Option<Filter>, row_stride: Option<usize>, ) -> ApngResult<()>

pub fn write_frame( &mut self, image_data: &[u8], frame: Option<&Frame>, filter: Option<Filter>, row_stride: Option<usize>, ) -> ApngResult<()>