Struct AnimImage 

pub struct AnimImage {
    pub style: Style,
    /* private fields */
}

Tick-driven animated image widget.

See the module-level documentation for the full design contract.

Fields

style: Style

Visual style for the widget background (Part::MAIN).

Implementations

impl AnimImage

pub fn new(bounds: Rect, frames: FrameSource) -> Self

Create an animated image at bounds from the provided frames.

Default: Running, Loop, 3 ticks/frame, forward direction.

pub fn set_ticks_per_frame(&mut self, n: u32)

Set the number of ticks between frame advances. 0 is clamped to 1.

pub fn ticks_per_frame(&self) -> u32

Number of ticks between frame advances (always ≥ 1).

pub fn frame_count(&self) -> usize

Number of frames in the animation (may be zero for an empty source).

pub fn current_frame_index(&self) -> usize

Index of the currently displayed frame.

pub fn set_current_frame(&mut self, index: usize)

Force-set the displayed frame index. Out-of-bounds values are clamped to frame_count().saturating_sub(1).

pub fn play(&mut self)

Start playback (equivalent to LVGL lv_animimg_start).

pub fn pause(&mut self)

Pause playback (equivalent to LVGL lv_animimg_stop).

pub fn set_play_state(&mut self, state: AnimPlayState)

Set the play state directly.

pub fn play_state(&self) -> AnimPlayState

Current play state.

pub fn is_playing(&self) -> bool

Return true when the animation is currently running.

pub fn set_loop_mode(&mut self, mode: AnimImageLoopMode)

Set the loop mode.

pub fn loop_mode(&self) -> AnimImageLoopMode

Current loop mode.

pub fn set_reverse(&mut self, reverse: bool)

When true, the initial playback direction is reversed (frame index decrements toward 0 rather than incrementing).

pub fn on_complete<F: FnMut() + 'static>(self, handler: F) -> Self

Register a callback fired when AnimImageLoopMode::Once reaches the last frame. Replaces any previously registered callback.

Trait Implementations

impl Widget for AnimImage

fn draw(&self, renderer: &mut dyn Renderer)

Draw the current animation frame.

Part::MAIN — widget background. Part::INDICATOR — current frame via Renderer::blit_image.

fn handle_event(&mut self, event: &Event) -> bool

Handle events. Returns true when Event::Tick is consumed (matching the Spinner pattern: Tick is always consumed when Running).

fn set_bounds(&mut self, bounds: Rect)

Adopt a layout-computed bounds rect.

fn bounds(&self) -> Rect

Return the area this widget occupies relative to its parent.

fn clear_region(&mut self) -> Option<Rect>

Return a region (in draw/landscape coordinates) that should be restored from the pristine background copy, or None.

fn widget_font_mut(&mut self) -> Option<&mut WidgetFont>

Expose this widget’s font slot for cascade-driven font resolution (FONT-05 §5.B).