Struct ImageBuffer 

pub struct ImageBuffer {
    pub width: usize,
    pub height: usize,
    pub background_color: Option<RGBA>,
    pub buffer: Option<Vec<u8>>,
    pub animation: Option<Vec<AnimationLayer>>,
    pub current: Option<usize>,
    pub loop_count: Option<u32>,
    pub first_wait_time: Option<u64>,
    pub metadata: Option<HashMap<String, DataMap>>,
    /* private fields */
}

Default in-memory RGBA image store used by decoders and encoders.

Fields

width: usize

Canvas width in pixels.

height: usize

Canvas height in pixels.

background_color: Option<RGBA>

Optional background color.

buffer: Option<Vec<u8>>

Base canvas RGBA pixels.

animation: Option<Vec<AnimationLayer>>

Animation frames, if present.

current: Option<usize>

Current animation frame index while decoding.

loop_count: Option<u32>

Animation loop count, if known.

first_wait_time: Option<u64>

Delay of the first frame, if known.

metadata: Option<HashMap<String, DataMap>>

Arbitrary metadata collected during decode.

Implementations

impl ImageBuffer

pub fn new() -> Self

Creates an empty image buffer.

pub fn from_buffer(width: usize, height: usize, buf: Vec<u8>) -> Self

Creates an image buffer from an RGBA pixel buffer.

pub fn set_animation(&mut self, flag: bool)

Enables or disables animation storage.

pub fn set_verbose( &mut self, verbose: fn(&str) -> Result<Option<CallbackResponse>, Box<dyn Error>>, )

Installs a verbose logging callback used by decoders.

Trait Implementations

impl DrawCallback for ImageBuffer

fn init( &mut self, width: usize, height: usize, option: Option<InitOptions>, ) -> Result<Option<CallbackResponse>, Box<dyn Error>>

Initializes the in-memory canvas.

fn draw( &mut self, start_x: usize, start_y: usize, width: usize, height: usize, data: &[u8], _: Option<DrawOptions>, ) -> Result<Option<CallbackResponse>, Box<dyn Error>>

Draws part of the current image or animation frame.

fn terminate( &mut self, _: Option<TerminateOptions>, ) -> Result<Option<CallbackResponse>, Box<dyn Error>>

Finalizes decoding.

fn next( &mut self, opt: Option<NextOptions>, ) -> Result<Option<CallbackResponse>, Box<dyn Error>>

Starts a new animation frame in the buffer.

fn verbose( &mut self, str: &str, _: Option<VerboseOptions>, ) -> Result<Option<CallbackResponse>, Box<dyn Error>>

Passes through verbose decoder output.

fn set_metadata( &mut self, key: &str, value: DataMap, ) -> Result<Option<CallbackResponse>, Box<dyn Error>>

Stores decoded metadata on the buffer.

impl PickCallback for ImageBuffer

fn encode_start( &mut self, _: Option<EncoderOptions>, ) -> Result<Option<ImageProfiles>, Box<dyn Error>>

Exposes the image profile to encoders.

fn encode_pick( &mut self, start_x: usize, start_y: usize, width: usize, height: usize, _: Option<PickOptions>, ) -> Result<Option<Vec<u8>>, Box<dyn Error>>

Reads an RGBA rectangle from the base canvas.

fn encode_end(&mut self, _: Option<EndOptions>) -> Result<(), Box<dyn Error>>

Finalizes encoding.

fn metadata( &mut self, ) -> Result<Option<HashMap<String, DataMap>>, Box<dyn Error>>

Returns stored metadata.