Image QML Type

These properties hold the size of the image that is actually painted. In most cases it is the same as width and height, but when using an Image.PreserveAspectFit or an Image.PreserveAspectCrop paintedWidth or paintedHeight can be smaller or larger than width and height of the Image item.

Sets the horizontal and vertical alignment of the image. By default, the image is center aligned.

The valid values for horizontalAlignment are Image.AlignLeft, Image.AlignRight and Image.AlignHCenter. The valid values for verticalAlignment are Image.AlignTop, Image.AlignBottom and Image.AlignVCenter.

currentFrame is the frame that is currently visible. The default is 0. You can set it to a number between 0 and frameCount - 1 to display a different frame, if the image contains multiple frames.

frameCount is the number of frames in the image. Most images have only one frame.

Specifies that images on the local filesystem should be loaded asynchronously in a separate thread. The default value is false, causing the user interface thread to block while the image is loaded. Setting asynchronous to true is useful where maintaining a responsive user interface is more desirable than having images immediately visible.

Note that this property is only valid for images read from the local filesystem. Images loaded via a network resource (e.g. HTTP) are always loaded asynchronously.

This property holds whether the image should automatically apply image transformation metadata such as EXIF orientation.

By default, this property is set to false.

Specifies whether the image should be cached. The default value is true. Setting cache to false is useful when dealing with large images, to make sure that they aren't cached at the expense of small 'ui element' images.

Set this property to define what happens when the source image has a different size than the item.

 Image {
     width: 130; height: 100
     source: "qtlogo.png"
 }

 Image {
     width: 130; height: 100
     fillMode: Image.PreserveAspectFit
     source: "qtlogo.png"
 }

 Image {
     width: 130; height: 100
     fillMode: Image.PreserveAspectCrop
     source: "qtlogo.png"
     clip: true
 }

 Image {
     width: 120; height: 120
     fillMode: Image.Tile
     horizontalAlignment: Image.AlignLeft
     verticalAlignment: Image.AlignTop
     source: "qtlogo.png"
 }

 Image {
     width: 120; height: 120
     fillMode: Image.TileVertically
     verticalAlignment: Image.AlignTop
     source: "qtlogo.png"
 }

 Image {
     width: 120; height: 120
     fillMode: Image.TileHorizontally
     verticalAlignment: Image.AlignLeft
     source: "qtlogo.png"
 }

Note that clip is false by default which means that the item might paint outside its bounding rectangle even if the fillMode is set to PreserveAspectCrop.

See also Qt Quick Examples - Image Elements.

This property holds whether the image uses mipmap filtering when scaled or transformed.

Mipmap filtering gives better visual quality when scaling down compared to smooth, but it may come at a performance cost (both when initializing the image and during rendering).

By default, this property is set to false.

See also smooth.

This property holds whether the image should be horizontally inverted (effectively displaying a mirrored image).

The default value is false.

This property holds whether the image should be vertically inverted (effectively displaying a mirrored image).

The default value is false.

This property was introduced in Qt 6.2.

This property holds the progress of image loading, from 0.0 (nothing loaded) to 1.0 (finished).

See also status.

This property defines the behavior when the source property is changed and loading happens asynchronously. This is the case when the asynchronous property is set to true, or if the image is not on the local file system.

If retainWhileLoading is false (the default), the old image is discarded immediately, and the component is cleared while the new image is being loaded. If set to true, the old image is retained and remains visible until the new one is ready.

Enabling this property can avoid flickering in cases where loading the new image takes a long time. It comes at the cost of some extra memory use for double buffering while the new image is being loaded.

This property was introduced in Qt 6.8.

This property holds whether the image is smoothly filtered when scaled or transformed. Smooth filtering gives better visual quality, but it may be slower on some hardware. If the image is displayed at its natural size, this property has no visual or performance effect.

By default, this property is set to true.

See also mipmap.

Image can handle any image format supported by Qt, loaded from any URL scheme supported by Qt.

The URL may be absolute, or relative to the URL of the component.

See also QQuickImageProvider, Compressed Texture Files, and Automatic Detection of File Extension.

This property, if set, holds the rectangular region of the source image to be loaded.

The sourceClipRect works together with the sourceSize property to conserve system resources when only a portion of an image needs to be loaded.

 Rectangle {
     width: ...
     height: ...

     Image {
        anchors.fill: parent
        source: "reallyBigImage.svg"
        sourceSize.width: 1024
        sourceSize.height: 1024
        sourceClipRect: Qt.rect(100, 100, 512, 512)
     }
 }

In the above example, we conceptually scale the SVG graphic to 1024x1024 first, and then cut out a region of interest that is 512x512 pixels from a location 100 pixels from the top and left edges. Thus sourceSize determines the scale, but the actual output image is 512x512 pixels.

Some image formats are able to conserve CPU time by rendering only the specified region. Others will need to load the entire image first and then clip it to the specified region.

This property can be cleared to reload the entire image by setting sourceClipRect to undefined.

This property holds the scaled width and height of the full-frame image.

Unlike the width and height properties, which scale the painting of the image, this property sets the maximum number of pixels stored for the loaded image so that large images do not use more memory than necessary. For example, this ensures the image in memory is no larger than 1024x1024 pixels, regardless of the Image's width and height values:

 Rectangle {
     width: ...
     height: ...

     Image {
        anchors.fill: parent
        source: "reallyBigImage.jpg"
        sourceSize.width: 1024
        sourceSize.height: 1024
     }
 }

If the image's actual size is larger than the sourceSize, the image is scaled down. If only one dimension of the size is set to greater than 0, the other dimension is set in proportion to preserve the source image's aspect ratio. (The fillMode is independent of this.)

If both the sourceSize.width and sourceSize.height are set, the image will be scaled down to fit within the specified size (unless PreserveAspectCrop or PreserveAspectFit are used, then it will be scaled to match the optimal size for cropping/fitting), maintaining the image's aspect ratio. The actual size of the image after scaling is available via Item::implicitWidth and Item::implicitHeight.

If the source is an intrinsically scalable image (eg. SVG), this property determines the size of the loaded image regardless of intrinsic size. Avoid changing this property dynamically; rendering an SVG is slow compared to an image.

If the source is a non-scalable image (eg. JPEG), the loaded image will be no greater than this property specifies. For some formats (currently only JPEG), the whole image will never actually be loaded into memory.

If the sourceClipRect property is also set, sourceSize determines the scale, but it will be clipped to the size of the clip rectangle.

sourceSize can be cleared to the natural size of the image by setting sourceSize to undefined.

See also Qt Quick Examples - Pointer Handlers.

This property holds the status of image loading. It can be one of:

Use this status to provide an update or respond to the status change in some way. For example, you could:

• Trigger a state change:

   State { name: 'loaded'; when: image.status == Image.Ready }
  

• Implement an onStatusChanged signal handler:

   Image {
       id: image
       onStatusChanged: if (image.status == Image.Ready) console.log('Loaded')
   }
  

• Bind to the status value:

   Text { text: image.status == Image.Ready ? 'Loaded' : 'Not loaded' }
  

See also progress.