Qt Reference Documentation

QML AnimatedImage Element

Inherits Image

  • List of all members, including inherited members
  • Properties

    Detailed Description

    The AnimatedImage element extends the features of the Image element, 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 totla 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.


     import QtQuick 1.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

    currentFrame : int

    read-onlyframeCount : int

    currentFrame is the frame that is currently visible. By monitoring this property for changes, you can animate other items at the same time as the image.

    frameCount is the number of frames in the animation. For some animation formats, frameCount is unknown and has a value of zero.


    paused : bool

    This property holds whether the animated image is paused.

    By default, this property is false. Set it to true when you want to pause the animation.


    playing : bool

    This property holds whether the animated image is playing.

    By defaults, this property is true, meaning that the animation will start playing immediately.


    X

    Thank you for giving your feedback.

    Make sure it is related to this specific page. For more general bugs and requests, please use the Qt Bug Tracker.