Struct WebpAnimation 

pub struct WebpAnimation { /* private fields */ }

Represents a WebP animation, handling frame data, playback control, and rendering.

Implementations

impl WebpAnimation

pub fn from_file<P: AsRef<Path>>(path: P, app: &App) -> Result<Self, String>

Creates a new WebpAnimation instance by loading frames from a WebP file.

This function decodes the WebP file at the given path and prepares the animation for playback.

Parameters

• path: Path to the WebP file containing the animation.
• app: Reference to the Nannou App instance, used for creating textures.

Returns

A Result containing:

• Ok(WebpAnimation): The animation instance if successful.
• Err(String): An error message if loading fails.

Errors

Returns an error if the file cannot be decoded or contains no frames.

Examples found in repository

examples/basic_example.rs (line 18)

fn model(app: &App) -> Model {
    // Create a new window
    app.new_window().view(view).build().unwrap();

    // Load the WEBP animation
    let assets = app.assets_path().expect("Failed to find assets directory");
    let webp_path = assets.join("animation.webp"); // Place 'animation.webp' in the 'assets' directory

    // Initialize the animation
    let animation =
        WebpAnimation::from_file(&webp_path, app).expect("Failed to load WEBP animation");

    Model { animation }
}

pub fn update(&mut self)

Updates the animation’s current frame based on elapsed time.

This function should be called in each frame of the main loop to keep the animation in sync with its intended frame durations.

Examples found in repository

examples/basic_example.rs (line 25)

fn update(_app: &App, model: &mut Model, _update: Update) {
    // Update the animation
    model.animation.update();
}

pub fn texture(&self) -> &Texture

Returns a reference to the current texture.

Returns

A reference to the Texture of the current frame.

Examples found in repository

examples/basic_example.rs (line 42)

fn view(app: &App, model: &Model, frame: Frame) {
    // Clear the frame
    frame.clear(BLACK);

    let win = app.window_rect();

    // Define the rectangle where the animation will be drawn
    let r = Rect::from_w_h(
        model.animation.width() as f32,
        model.animation.height() as f32,
    )
    .top_left_of(win);

    let draw = app.draw();
    draw.texture(model.animation.texture())
        .xy(r.xy())
        .wh(r.wh());

    draw.to_frame(app, &frame).unwrap();
}

pub fn width(&self) -> u32

Returns the width of the current frame.

Returns

The width (in pixels) of the current frame’s texture.

Examples found in repository

examples/basic_example.rs (line 36)

fn view(app: &App, model: &Model, frame: Frame) {
    // Clear the frame
    frame.clear(BLACK);

    let win = app.window_rect();

    // Define the rectangle where the animation will be drawn
    let r = Rect::from_w_h(
        model.animation.width() as f32,
        model.animation.height() as f32,
    )
    .top_left_of(win);

    let draw = app.draw();
    draw.texture(model.animation.texture())
        .xy(r.xy())
        .wh(r.wh());

    draw.to_frame(app, &frame).unwrap();
}

pub fn height(&self) -> u32

Returns the height of the current frame.

Returns

The height (in pixels) of the current frame’s texture.

Examples found in repository

examples/basic_example.rs (line 37)

fn view(app: &App, model: &Model, frame: Frame) {
    // Clear the frame
    frame.clear(BLACK);

    let win = app.window_rect();

    // Define the rectangle where the animation will be drawn
    let r = Rect::from_w_h(
        model.animation.width() as f32,
        model.animation.height() as f32,
    )
    .top_left_of(win);

    let draw = app.draw();
    draw.texture(model.animation.texture())
        .xy(r.xy())
        .wh(r.wh());

    draw.to_frame(app, &frame).unwrap();
}

pub fn set_looping(&mut self, looping: bool)

Sets whether the animation should loop after reaching the final frame.

Parameters

• looping: If true, the animation will loop indefinitely. If false, it will stop at the last frame.