blob: 36037f8f53f62eb74fbd5bc5b2c164f690232c8b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Graphical Effects module.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\qmltype Desaturate
\inqmlmodule QtGraphicalEffects 1.0
\since QtGraphicalEffects 1.0
\inherits QtQuick2::Item
\ingroup qtgraphicaleffects-color
\brief Reduces the saturation of the colors.
Desaturated pixel values are calculated as averages of the original RGB
component values of the source item.
\table
\header
\li Source
\li Effect applied
\row
\li \image Original_bug.png
\li \image Desaturate_bug.png
\endtable
\section1 Example
The following example shows how to apply the effect.
\snippet snippets/Desaturate-example.qml example
*/
/*!
\qmlproperty variant QtGraphicalEffects1::Desaturate::source
This property defines the source item that provides the source pixels to the
effect.
*/
/*!
\qmlproperty real QtGraphicalEffects1::Desaturate::desaturation
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 \c 0.0 (no chnage).
\table
\header
\li Output examples with different desaturation values
\li
\li
\row
\li \image Desaturate_desaturation1.png
\li \image Desaturate_desaturation2.png
\li \image Desaturate_desaturation3.png
\row
\li \b { desaturation: 0.0 }
\li \b { desaturation: 0.5 }
\li \b { desaturation: 1.0 }
\endtable
*/
/*!
\qmlproperty bool QtGraphicalEffects1::Desaturate::cached
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 \c false.
*/
|
