diff options
author | Mitch Curtis <mitch.curtis@qt.io> | 2018-02-26 15:32:53 +0100 |
---|---|---|
committer | Mitch Curtis <mitch.curtis@qt.io> | 2018-02-28 11:35:06 +0000 |
commit | c8bac27a97c64f09a2c5c59de676804a25fa06aa (patch) | |
tree | 1b3af234133a795372fa1e5d12adf5f1c2bbe086 /src/quick/items | |
parent | 52d9a725098735e6350fe63cf471a27d4106ad18 (diff) |
Doc: add code examples and GIFs of AnimatedSprite
Change-Id: Ie1c7541e526e2777af83a46d6ff01b3f7a9a0d3e
Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
Diffstat (limited to 'src/quick/items')
-rw-r--r-- | src/quick/items/qquickanimatedsprite.cpp | 64 |
1 files changed, 61 insertions, 3 deletions
diff --git a/src/quick/items/qquickanimatedsprite.cpp b/src/quick/items/qquickanimatedsprite.cpp index 8e486add44..741e4607e5 100644 --- a/src/quick/items/qquickanimatedsprite.cpp +++ b/src/quick/items/qquickanimatedsprite.cpp @@ -69,9 +69,67 @@ QT_BEGIN_NAMESPACE as multiple frames in the same image file. You can play it at a fixed speed, at the frame rate of your display, or manually advance and control the progress. - For details of how a sprite animation is defined see the \l{Sprite Animations} overview. - Note that the AnimatedSprite type does not use Sprite types to define multiple animations, - but instead encapsulates a single animation itself. + Consider the following sprite sheet: + + \image animatedsprite-loading.png + + It can be divided up into four frames: + + \image animatedsprite-loading-frames.png + + To play each of these frames at a speed of 500 milliseconds per frame, the + following code can be used: + + \table + \header + \li Code + \li Result + \row + \li + \code + AnimatedSprite { + source: "loading.png" + frameWidth: 64 + frameHeight: 64 + frameCount: 4 + frameDuration: 500 + } + \endcode + \li + \image animatedsprite-loading-interpolated.gif + \endtable + + By default, the frames are interpolated (blended together) to make the + animation appear smoother. To disable this, set \l interpolate to \c false: + + \table + \header + \li Code + \li Result + \row + \li + \code + AnimatedSprite { + source: "loading.png" + frameWidth: 64 + frameHeight: 64 + frameCount: 4 + frameDuration: 500 + interpolate: false + } + \endcode + \li + \image animatedsprite-loading.gif + \endtable + + To control how AnimatedSprite responds to being scaled, use the + \l {Item::}{smooth} property. + + Note that unlike \l SpriteSequence, the AnimatedSprite type does not use + \l Sprite to define multiple animations, but instead encapsulates a + single animation itself. + + \sa {Sprite Animations} */ /*! |