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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the documentation of the Qt Graphical Effects module.
**
** $QT_BEGIN_LICENSE:FDL$
** GNU Free Documentation License
** 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.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms
** and conditions contained in a signed written agreement between you
** and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\qmltype RadialGradient
\inqmlmodule QtGraphicalEffects 1.0
\since QtGraphicalEffects 1.0
\inherits QtQuick2::Item
\ingroup qtgraphicaleffects-gradient
\brief Draws a radial gradient.
A gradient is defined by two or more colors, which are blended seamlessly.
The colors start from the middle of the item and end at the borders.
\table
\header
\li Effect applied
\row
\li \image RadialGradient.png
\endtable
\section1 Example
The following example shows how to apply the effect.
\snippet snippets/RadialGradient-example.qml example
*/
/*!
\qmlproperty variant QtGraphicalEffects1::RadialGradient::source
This property defines the item that is going to be filled with gradient. Source
item gets rendered into an intermediate pixel buffer and the alpha values
from the result are used to determine the gradient's pixels visibility in
the display.
The default value for source is undefined and in that case whole effect area
is filled with gradient.
\table
\header
\li Output examples with different source values
\li
\li
\row
\li \image RadialGradient_maskSource1.png
\li \image RadialGradient_maskSource2.png
\row
\li \b { source: undefined }
\li \b { source: Image { source: images/butterfly.png } }
\row
\li \l horizontalOffset: 0
\li \l horizontalOffset: 0
\row
\li \l verticalOffset: 0
\li \l verticalOffset: 0
\row
\li \l horizontalRadius: 300
\li \l horizontalRadius: 300
\row
\li \l verticalRadius: 300
\li \l verticalRadius: 300
\row
\li \l angle: 0
\li \l angle: 0
\endtable
*/
/*!
\qmlproperty real QtGraphicalEffects1::RadialGradient::angle
This property defines the rotation of the gradient around its center point.
The rotation is only visible when the \l{RadialGradient::horizontalRadius}{horizontalRadius}
and \l{RadialGradient::verticalRadius}{verticalRadius} properties are not equal. The angle
is given in degrees and the default value is \c 0.
\table
\header
\li Output examples with different angle values
\li
\li
\row
\li \image RadialGradient_angle1.png
\li \image RadialGradient_angle2.png
\li \image RadialGradient_angle3.png
\row
\li \b { angle: 0 }
\li \b { angle: 45 }
\li \b { angle: 90 }
\row
\li \l horizontalOffset: 0
\li \l horizontalOffset: 0
\li \l horizontalOffset: 0
\row
\li \l verticalOffset: 0
\li \l verticalOffset: 0
\li \l verticalOffset: 0
\row
\li \l horizontalRadius: 100
\li \l horizontalRadius: 100
\li \l horizontalRadius: 100
\row
\li \l verticalRadius: 300
\li \l verticalRadius: 300
\li \l verticalRadius: 300
\endtable
*/
/*!
\qmlproperty real QtGraphicalEffects1::RadialGradient::horizontalOffset
\qmlproperty real QtGraphicalEffects1::RadialGradient::verticalOffset
The HorizontalOffset and verticalOffset properties define the offset in
pixels for the center point of the gradient compared to the item center.
The values range from -inf to inf. By default, these properties are set to \c 0.
\table
\header
\li Output examples with different horizontalOffset values
\li
\li
\row
\li \image RadialGradient_horizontalOffset1.png
\li \image RadialGradient_horizontalOffset2.png
\li \image RadialGradient_horizontalOffset3.png
\row
\li \b { horizontalOffset: -150 }
\li \b { horizontalOffset: 0 }
\li \b { horizontalOffset: 150 }
\row
\li \l verticalOffset: 0
\li \l verticalOffset: 0
\li \l verticalOffset: 0
\row
\li \l horizontalRadius: 300
\li \l horizontalRadius: 300
\li \l horizontalRadius: 300
\row
\li \l verticalRadius: 300
\li \l verticalRadius: 300
\li \l verticalRadius: 300
\row
\li \l angle: 0
\li \l angle: 0
\li \l angle: 0
\endtable
*/
/*!
\qmlproperty real QtGraphicalEffects1::RadialGradient::horizontalRadius
\qmlproperty real QtGraphicalEffects1::RadialGradient::verticalRadius
The HorizontalRadius and verticalRadius properties define the shape and size
of the radial gradient. If the radiuses are equal, the shape of the gradient
is a circle. If the horizontal and vertical radiuses differ, the shape is
elliptical. The radiuses are given in pixels.
The value ranges from -inf to inf. By default, horizontalRadius is bound to
width and verticalRadius is bound to height.
\table
\header
\li Output examples with different horizontalRadius values
\li
\li
\row
\li \image RadialGradient_horizontalRadius1.png
\li \image RadialGradient_horizontalRadius2.png
\row
\li \b { horizontalRadius: 300 }
\li \b { horizontalRadius: 100 }
\row
\li \l horizontalOffset: 0
\li \l horizontalOffset: 0
\row
\li \l verticalOffset: 0
\li \l verticalOffset: 0
\row
\li \l verticalRadius: 300
\li \l verticalRadius: 300
\row
\li \l angle: 0
\li \l angle: 0
\row
\li \l gradient: QQuickGradient(0xa05fb10)
\li \l gradient: QQuickGradient(0xa05fb10)
\endtable
*/
/*!
\qmlproperty Gradient QtGraphicalEffects1::RadialGradient::gradient
A gradient is defined by two or more colors, which are blended seamlessly.
The colors are specified as a set of GradientStop child items, each of which
defines a position on the gradient from 0.0 to 1.0 and a color. The position
of each GradientStop is defined by setting the position property. The color
is defined by setting the color property.
\table
\header
\li Output examples with different gradient values
\li
\li
\row
\li \image RadialGradient_gradient1.png
\li \image RadialGradient_gradient2.png
\li \image RadialGradient_gradient3.png
\row
\li \b {gradient:} \code
Gradient {
GradientStop { position: 0.000
color: Qt.rgba(1, 0, 0, 1) }
GradientStop { position: 0.167;
color: Qt.rgba(1, 1, 0, 1) }
GradientStop { position: 0.333;
color: Qt.rgba(0, 1, 0, 1) }
GradientStop { position: 0.500;
color: Qt.rgba(0, 1, 1, 1) }
GradientStop { position: 0.667;
color: Qt.rgba(0, 0, 1, 1) }
GradientStop { position: 0.833;
color: Qt.rgba(1, 0, 1, 1) }
GradientStop { position: 1.000;
color: Qt.rgba(1, 0, 0, 1) }
}
\endcode
\li \b {gradient:} \code
Gradient {
GradientStop { position: 0.0
color: "#F0F0F0"
}
GradientStop { position: 0.5
color: "#000000"
}
GradientStop { position: 1.0
color: "#F0F0F0"
}
}
\endcode
\li \b {gradient:} \code
Gradient {
GradientStop { position: 0.0
color: "#00000000"
}
GradientStop { position: 1.0
color: "#FF000000"
}
}
\endcode
\row
\li \l horizontalOffset: 0
\li \l horizontalOffset: 0
\li \l horizontalOffset: 0
\row
\li \l verticalOffset: 0
\li \l verticalOffset: 0
\li \l verticalOffset: 0
\row
\li \l horizontalRadius: 300
\li \l horizontalRadius: 300
\li \l horizontalRadius: 300
\row
\li \l verticalRadius: 300
\li \l verticalRadius: 300
\li \l verticalRadius: 300
\row
\li \l angle: 0
\li \l angle: 0
\li \l angle: 0
\endtable
*/
/*!
\qmlproperty bool QtGraphicalEffects1::RadialGradient::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.
*/
|
