• Home
• Qt 5.11
• Qt Quick
• QML Types
• AnimatedImage QML Type

AnimatedImage

Plays animations stored as a series of images. More...

• List of all members, including inherited members

Properties

• currentFrame : int
• frameCount : int
• paused : bool
• playing : bool
• source : url
• speed : real

Detailed Description

The AnimatedImage type extends the features of the Image type, providing a way to play animations stored as images containing a series of frames, such as those stored in GIF files.

Information about the current frame and total length of the animation can be obtained using the currentFrame and frameCount properties. You can start, pause and stop the animation by changing the values of the playing and paused properties.

The full list of supported formats can be determined with QMovie::supportedFormats().

Example Usage

The following QML shows how to display an animated image and obtain information about its state, such as the current frame and total number of frames. The result is an animated image with a simple progress indicator underneath it.

Note: When animated images are cached, every frame of the animation will be cached.

Set cache to false if you are playing a long or large animation and you want to conserve memory.

If the image data comes from a sequential device (e.g. a socket), AnimatedImage can only loop if cache is set to true.

import QtQuick 2.0

Rectangle {
    width: animation.width; height: animation.height + 8

    AnimatedImage { id: animation; source: "animation.gif" }

    Rectangle {
        property int frames: animation.frameCount

        width: 4; height: 8
        x: (animation.width - width) * animation.currentFrame / frames
        y: animation.height
        color: "red"
    }
}

See also BorderImage and Image.

Property Documentation

AnimatedImage {
    onStatusChanged: playing = (status == AnimatedImage.Ready)
}