Qt Documentation

Contents

Desaturate QML Type

Reduces the saturation of the colors. More...

Import Statement: import QtGraphicalEffects 1.12
Since: QtGraphicalEffects 1.0
Inherits:

Item

Properties

Detailed Description

Desaturated pixel values are calculated as averages of the original RGB component values of the source item.

SourceEffect applied

Note: This effect is available when running with OpenGL.

Example

The following example shows how to apply the effect.

import QtQuick 2.12
import QtGraphicalEffects 1.12

Item {
    width: 300
    height: 300

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

    Desaturate {
        anchors.fill: bug
        source: bug
        desaturation: 0.8
    }
}

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.


desaturation : real

This property defines how much the source colors are desaturated.

The value ranges from 0.0 (no change) to 1.0 (desaturated). By default, the property is set to 0.0 (no change).

Output examples with different desaturation values

desaturation: 0.0 desaturation: 0.5 desaturation: 1.0

source : variant

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

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


© 2019 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.