The Effect.MaskImage effect is a pixel effect that masks its parent Item (and children) against the alpha channel of an image.

The following example shows a dinosaur mask being applied to a video.

Video {
    with Effect.MaskImage {
        source: "dinosaur.png"

property Bool enabled: true

When the effect is disabled, the mask is not applied.

property Url source

The path or URL of the image to use for the alpha mask.

property Float amount: 1

The proportion of the mask effect applied. A value of 0 leaves the input unchanged, whereas a value of 1 has the mask fully applied.

Animating this property allows you to fade the mask effect in and out.

property Int imageWidthread only

property Int imageHeightread only

The size of the source image.

property Effect.MaskImage.Status statusread only


No source url has been specified.


The element is loading the image.


The element has successfully loaded the image.


The element has failed to load the image.