- Qt 6.5
- Qt 5 Compatibility APIs: Graphical Effects
- QML Types
- ColorOverlay
- Qt 6.5.3 Reference Documentation

# ColorOverlay QML Type

Alters the colors of the source item by applying an overlay color. More...

Import Statement: | import Qt5Compat.GraphicalEffects
Since: | QtGraphicalEffects 1.0
Inherits: | Item

- List of all members, including inherited members

## Properties

- cached : bool
- color : color
- source : variant

## Detailed Description

The effect is similar to what happens when a colorized glass is put on top of a grayscale image. The color for the overlay is given in the RGBA format.

Source | Effect applied
--- | ---

## Example

The following example shows how to apply the effect.

     import QtQuick
     import Qt5Compat.GraphicalEffects

     Item {
         width: 300
         height: 300

         Image {
             id: bug
             source: "images/butterfly.png"
             sourceSize: Qt.size(parent.width, parent.height)
             smooth: true
             visible: false
         }

         ColorOverlay {
             anchors.fill: bug
             source: bug
             color: "#80800000"
         }
     }

## Property Documentation

cached : bool

This property allows the effect output pixels to be cached in order to improve the rendering performance.

Every time the source or effect properties are changed, the pixels in the cache must be updated. Memory consumption is increased, because an extra buffer of memory is required for storing the effect output.

It is recommended to disable the cache when the source or the effect properties are animated.

By default, the property is set to `false`.

color : color

This property defines the color value which is used to colorize the source.

By default, the property is set to `"transparent"`.

Output examples with different color values |  |
--- | --- | ---
color: #80ff0000 | color: #8000ff00 | color: #800000ff

source : variant

This property defines the source item that provides the source pixels for the effect.

Note: It is not supported to let the effect include itself, for instance by setting source to the effect's parent.