Struct pathfinder::map::gif::Gif

pub struct Gif<'a> { /* fields omitted */ }

Wrapper around the Gif struct found in the gif crate.

With additions for pathfinder support, and cycling features.

Methods

impl<'a> Gif<'a>

pub fn new(filename: &str, width: u16, height: u16) -> Self

Constructs a Gif struct and initializes a file on the system for the Gif to be stored.

Errors

If it is unable to create the Encoder, or if the file can not be created.

See also

examples/hello_world_gif.rs example/cycles.rs

pub fn cycle(&mut self, interval: u8, map: Vec<Node>)

Adds in a repeating patttern every interval frame on to the gif image.

See also

examples/cycles.rs

pub fn cycle_predicate(
    &mut self,
    interval: u8,
    map: Vec<Node>,
    predicate: &'a dyn Fn(&Node) -> Node
)

Adds in a repeating patttern every interval frame on to the gif image.

pub fn remove_cycles(&mut self)

Removes all cycles from the gif.

pub fn advance_cycle(&mut self) -> Vec<Node>

Advances the cycles and returns the patterns it matched.

pub fn frames(&self) -> u16

Returns the number of frames that has been written.

pub fn push(&mut self, map: Map) -> Result<(), Error>

Pushes a frame using a map struct.

pub fn push_frame(&mut self, image: &IW) -> Result<(), Error>

Pushes a frame to the structure, This also immediately saves it to disk.

Errors

If the encoder fails to write the frame to disk.

pub fn blank(&mut self) -> Result<(), Error>

Appends a blank frame to the gif.

This will also advance Gif cycles.