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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
/****************************************************************************
**
** 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 Colorize
\inqmlmodule QtGraphicalEffects 1.0
\since QtGraphicalEffects 1.0
\inherits QtQuick2::Item
\ingroup qtgraphicaleffects-color
\brief Sets the color in the HSL color space.
The effect is similar to what happens when a colorized glass is put on top
of a grayscale image. Colorize uses the hue, saturation, and lightness (HSL)
color space. You can specify a desired value for each property. You can
shift all HSL values with the
\l{QtGraphicalEffects1::HueSaturation}{HueSaturation} effect.
Alternatively, you can use the
\l{QtGraphicalEffects1::ColorOverlay}{ColorOverlay} effect to colorize the
source item in the RGBA color space.
\table
\header
\li Source
\li Effect applied
\row
\li \image Original_bug.png
\li \image Colorize_bug.png
\endtable
\section1 Example
The following example shows how to apply the effect.
\snippet snippets/Colorize-example.qml example
*/
/*!
\qmlproperty variant QtGraphicalEffects1::Colorize::source
This property defines the source item that provides the source pixels for
the effect.
*/
/*!
\qmlproperty real QtGraphicalEffects1::Colorize::hue
This property defines the hue value which is used to colorize the source.
The value ranges from 0.0 to 1.0. By default, the property is set to \c 0.0,
which produces a slightly red color.
\table
\header
\li Allowed hue values
\row
\li \image Colorize_hue_scale.png
\endtable
\table
\header
\li Output examples with different hue values
\li
\li
\row
\li \image Colorize_hue1.png
\li \image Colorize_hue2.png
\li \image Colorize_hue3.png
\row
\li \b { hue: 0.2 }
\li \b { hue: 0.5 }
\li \b { hue: 0.8 }
\row
\li \l saturation: 1
\li \l saturation: 1
\li \l saturation: 1
\row
\li \l lightness: 0
\li \l lightness: 0
\li \l lightness: 0
\endtable
*/
/*!
\qmlproperty real QtGraphicalEffects1::Colorize::saturation
This property defines the saturation value which is used to colorize the
source.
The value ranges from 0.0 (desaturated) to 1.0 (saturated). By default, the
property is set to \c 1.0 (saturated).
\table
\header
\li Output examples with different saturation values
\li
\li
\row
\li \image Colorize_saturation1.png
\li \image Colorize_saturation2.png
\li \image Colorize_saturation3.png
\row
\li \b { saturation: 0 }
\li \b { saturation: 0.5 }
\li \b { saturation: 1 }
\row
\li \l hue: 0
\li \l hue: 0
\li \l hue: 0
\row
\li \l lightness: 0
\li \l lightness: 0
\li \l lightness: 0
\endtable
*/
/*!
\qmlproperty real QtGraphicalEffects1::Colorize::lightness
This property defines how much the source lightness value is increased or
decreased.
Unlike hue and saturation properties, lightness does not set the used value,
but it shifts the existing source pixel lightness value.
The value ranges from -1.0 (decreased) to 1.0 (increased). By default, the
property is set to \c 0.0 (no change).
\table
\header
\li Output examples with different lightness values
\li
\li
\row
\li \image Colorize_lightness1.png
\li \image Colorize_lightness2.png
\li \image Colorize_lightness3.png
\row
\li \b { lightness: -0.75 }
\li \b { lightness: 0 }
\li \b { lightness: 0.75 }
\row
\li \l hue: 0
\li \l hue: 0
\li \l hue: 0
\row
\li \l saturation: 1
\li \l saturation: 1
\li \l saturation: 1
\endtable
*/
/*!
\qmlproperty bool QtGraphicalEffects1::Colorize::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.
*/
|
