ImagePaintDefinition

This class is used to define an ImagePaint in QML, which is typically used to add background images to containers.

An ImagePaintDefinition has no visual representation and you therefore have to add it as an attached object. To actually set the background property of a container, you must use the imagePaint property. To specify how and if the image should be repeated over the surface, set the repeatPattern property.

The provided image must have the power of two dimensions in order to be tileable (for example, 4x4, 8x8, 16x16, 32x32, 64x64, 128x128, 256x256, 128x64, 32x16). If image has dimensions that are not to the power of two, the paint will not be rendered and a warning will be printed out to the console.

The image also needs to have the "repeatable: true|false" property set in the asset metadata file. The asset metadata file is an .amd file with the same name as the image itself. This file can also contain nine-slicing attributes, however the tiling of nine-sliced images is not currently supported.

Here's an example of an .amd file called tiled_image.amd that has the repeatable property set to true.

#RimCascadesAssetMetaData version=1.0
source: "tiled_image.png"
repeatable: true

When referencing the image from your application, you reference the .amd file instead of the image itself. Here's an example of how to tile the background image in a container:

Container {
    id: rootContainer
    background: back.imagePaint
    attachedObjects: [
        ImagePaintDefinition {
            id: back
            repeatPattern: RepeatPattern.XY
            imageSource: "asset:///tiled_image.amd"
        }
    ]
}   

And here's how to do the same, but this time using an image tracker.

Container {
    id: rootContainer
    background: back.imagePaint
    attachedObjects: [
        ImagePaintDefinition {
            id: back
            repeatPattern: RepeatPattern.XY
            image: tracker.image
        },
        ImageTracker {
            id: tracker
            imageSource: "asset:///tiled_image.amd"
        }
    ]
}