- Qt 6.10
- Qt Quick
- QML Types
- Sprite
- Qt 6.10.2 Reference Documentation

# Sprite QML Type

Specifies sprite animations. More...

Import Statement: | `import QtQuick`

- List of all members, including inherited members

## Properties

- duration : int
- durationVariation : int
- frameCount : int
- frameDuration : int
- frameDurationVariation : int
- frameHeight : int
- frameRate : real
- frameRateVariation : real
- frameSync : bool
- frameWidth : int
- frameX : int
- frameY : int
- name : string
- randomStart : bool
- reverse : bool
- source : url
- to : QVariantMap

## Detailed Description

Sprite defines a series of one or more frames to be animated and rendered by SpriteSequence. The sprites can be in the middle of an image file, or split along multiple rows, as long as they form a contiguous line wrapping to the next row of the file from the left edge of the file.

For full details, see the Sprite Animations overview.

## Property Documentation

duration : int

Duration of the animation. Values below 0 are invalid.

If frameRate is valid then it will be used to calculate the duration of the frames. If not, and frameDuration is valid, then frameDuration will be used. Otherwise duration is used.

durationVariation : int

The duration of the animation can vary by up to this amount. Variation will never decrease the length of the animation to less than 0.

durationVariation will only take effect if duration is used to calculate the duration of frames.

Default is 0.

frameCount : int

Number of frames in this sprite.

frameDuration : int

Duration of each frame of the animation in milliseconds. Values below 0 are invalid.

If frameRate is valid then it will be used to calculate the duration of the frames. If not, and frameDuration is valid, then frameDuration will be used. Otherwise duration is used.

frameDurationVariation : int

The duration of a frame in the animation can vary by up to this amount. Variation will never decrease the length of the animation to less than 0.

frameDurationVariation will only take effect if frameDuration is used to calculate the duration of frames.

Default is 0.

frameHeight : int

Height of a single frame in this sprite.

frameRate : real

Frames per second to show in the animation. Values below 0 are invalid.

If frameRate is valid then it will be used to calculate the duration of the frames. If not, and frameDuration is valid , then frameDuration will be used. Otherwise duration is used.

frameRateVariation : real

The frame rate between animations can vary by up to this amount. Variation will never decrease the length of the animation to less than 0.

frameRateVariation will only take effect if frameRate is used to calculate the duration of frames.

Default is 0.

frameSync : bool

If true, then the animation will have no duration. Instead, the animation will advance one frame each time a frame is rendered to the screen. This synchronizes it with the painting rate as opposed to elapsed time.

If frameSync is set to true, it overrides all of duration, frameRate and frameDuration.

Default is false.

frameWidth : int

Width of a single frame in this sprite.

frameX : int

The X coordinate in the image file of the first frame of the sprite.

frameY : int

The Y coordinate in the image file of the first frame of the sprite.

name : string

The name of this sprite, for use in the to property of other sprites.

randomStart : bool

If true, then the animation will start its first animation with a random amount of its duration skipped. This allows them to not look like they all just started when the animation begins.

This only affects the very first animation played. Transitioning to another animation, or the same animation again, will not trigger this.

Default is false.

reverse : bool

If true, then the animation will be played in reverse.

Default is false.

source : url

The image source for the animation.

If frameHeight and frameWidth are not specified, it is assumed to be a single long row of square frames. Otherwise, it can be multiple contiguous rows or rectangluar frames, when one row runs out the next will be used.

If frameX and frameY are specified, the row of frames will be taken with that x/y coordinate as the upper left corner.

to : QVariantMap

A list of other sprites and weighted transitions to them, for example {"a":1, "b":2, "c":0} would specify that one-third should transition to sprite "a" when this sprite is done, and two-thirds should transition to sprite "b" when this sprite is done. As the transitions are chosen randomly, these proportions will not be exact. With "c":0 in the list, no sprites will randomly transition to "c", but it wll be a valid path if a sprite goal is set.

If no list is specified, or the sum of weights in the list is zero, then the sprite will repeat itself after completing.