blob: 2b2f2a62a86442fd9b8c2126c65551ca297c11c4 (
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
|
/****************************************************************************
**
** 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 ColorOverlay
\inqmlmodule QtGraphicalEffects 1.0
\since QtGraphicalEffects 1.0
\inherits QtQuick2::Item
\ingroup qtgraphicaleffects-color
\brief Alters the colors of the source item by applying an overlay color.
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.
\table
\header
\li Source
\li Effect applied
\row
\li \image Original_butterfly.png
\li \image ColorOverlay_butterfly.png
\endtable
\section1 Example
The following example shows how to apply the effect.
\snippet snippets/ColorOverlay-example.qml example
*/
/*!
\qmlproperty variant QtGraphicalEffects1::ColorOverlay::source
This property defines the source item that provides the source pixels for
the effect.
*/
/*!
\qmlproperty color QtGraphicalEffects1::ColorOverlay::color
This property defines the RGBA color value which is used to colorize the source.
By default, the property is set to \c "transparent".
\table
\header
\li Output examples with different color values
\li
\li
\row
\li \image ColorOverlay_color1.png
\li \image ColorOverlay_color2.png
\li \image ColorOverlay_color3.png
\row
\li \b { color: #80ff0000 }
\li \b { color: #8000ff00 }
\li \b { color: #800000ff }
\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.
*/
|
