Struct divoom::DivoomAnimationBuilder

pub struct DivoomAnimationBuilder { /* private fields */ }

Animation builder

This class holds a series of tiny_skia::Pixmap inside with the same size to provide an interface for building animations.

Implementations

impl DivoomAnimationBuilder

pub fn new(
    canvas_size: u32,
    speed: Duration
) -> DivoomAPIResult<DivoomAnimationBuilder>

Create a new animation builder with canvas size and speed.

For Divoom devices, only 16, 32 and 64 pixels canvas are allowed. When other value is specified, we will return failure.

pub fn canvas_size(&self) -> u32

Return canvas size

pub fn build_frame(&mut self, index: usize) -> DivoomAnimationFrameBuilder<'_>

Return a builder for the specified frame.

If the frame is not created or any previous frame is not created for the specified index, we will create all of them and return the builder for the last frame.

pub fn new_frame(&mut self) -> DivoomAnimationFrameBuilder<'_>

impl DivoomAnimationBuilder

pub fn draw_frames(self, frames: &[Pixmap], start_frame_index: usize) -> Self

Draw a series of frames to the canvas.

• Frames doesn’t need to be having the same size, as they will be drawn separately one by one.
• If we have more frames than what we have internally, the new frames will be automatically created.

pub fn draw_frames_fit(
    self,
    frames: &[Pixmap],
    start_frame_index: usize,
    fit: DivoomDrawFitMode,
    rotation: f32,
    opacity: f32,
    blend: BlendMode
) -> Self

Draw a series of frames to the canvas with DivoomDrawFitMode option and other options. With DivoomDrawFitMode option, we provided a few ways to calculate the position and size of each frame to simplify the usage.

pub fn draw_frames_sized(
    self,
    frames: &[Pixmap],
    start_frame_index: usize,
    x: i32,
    y: i32,
    width: u32,
    height: u32,
    rotation: f32,
    opacity: f32,
    blend: BlendMode
) -> Self

Draw a series of frames to the canvas with specified position and size.

pub fn draw_frames_scaled(
    self,
    frames: &[Pixmap],
    start_frame_index: usize,
    x: i32,
    y: i32,
    scale_x: f32,
    scale_y: f32,
    rotation: f32,
    opacity: f32,
    blend: BlendMode
) -> Self

Draw a series of frames to the canvas with specified position and scale on X and Y axis.

impl DivoomAnimationBuilder

pub fn build(&self) -> DivoomImageAnimation

Create the final animation that is used for being sent to the device, and one animation builder can be reused to create multiple animations.