Document recursion limitations of the graphical effects.
[qt:qtgraphicaleffects.git] / src / effects / ColorOverlay.qml
1 /****************************************************************************
2 **
3 ** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the Qt Graphical Effects module.
7 **
8 ** $QT_BEGIN_LICENSE:BSD$
9 ** You may use this file under the terms of the BSD license as follows:
10 **
11 ** "Redistribution and use in source and binary forms, with or without
12 ** modification, are permitted provided that the following conditions are
13 ** met:
14 **   * Redistributions of source code must retain the above copyright
15 **     notice, this list of conditions and the following disclaimer.
16 **   * Redistributions in binary form must reproduce the above copyright
17 **     notice, this list of conditions and the following disclaimer in
18 **     the documentation and/or other materials provided with the
19 **     distribution.
20 **   * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
21 **     of its contributors may be used to endorse or promote products derived
22 **     from this software without specific prior written permission.
23 **
24 **
25 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
36 **
37 ** $QT_END_LICENSE$
38 **
39 ****************************************************************************/
40
41 import QtQuick 2.0
42 import "private"
43
44 /*!
45     \qmltype ColorOverlay
46     \inqmlmodule QtGraphicalEffects 1.0
47     \since QtGraphicalEffects 1.0
48     \inherits QtQuick2::Item
49     \ingroup qtgraphicaleffects-color
50     \brief Alters the colors of the source item by applying an overlay color.
51
52     The effect is similar to what happens when a colorized glass is put on top
53     of a grayscale image. The color for the overlay is given in the RGBA format.
54
55     \table
56     \header
57         \li Source
58         \li Effect applied
59     \row
60         \li \image Original_butterfly.png
61         \li \image ColorOverlay_butterfly.png
62     \endtable
63
64     \section1 Example
65
66     The following example shows how to apply the effect.
67     \snippet ColorOverlay-example.qml example
68
69 */
70 Item {
71     id: rootItem
72
73     /*!
74         This property defines the source item that provides the source pixels
75         for the effect.
76
77         \note It is not supported to let the effect include itself, for
78         instance by setting source to the effect's parent.
79     */
80     property variant source
81
82     /*!
83         This property defines the RGBA color value which is used to colorize the
84         source.
85
86         By default, the property is set to \c "transparent".
87
88         \table
89         \header
90         \li Output examples with different color values
91         \li
92         \li
93         \row
94             \li \image ColorOverlay_color1.png
95             \li \image ColorOverlay_color2.png
96             \li \image ColorOverlay_color3.png
97         \row
98             \li \b { color: #80ff0000 }
99             \li \b { color: #8000ff00 }
100             \li \b { color: #800000ff }
101         \endtable
102
103     */
104     property color color: "transparent"
105
106     /*!
107         This property allows the effect output pixels to be cached in order to
108         improve the rendering performance.
109
110         Every time the source or effect properties are changed, the pixels in
111         the cache must be updated. Memory consumption is increased, because an
112         extra buffer of memory is required for storing the effect output.
113
114         It is recommended to disable the cache when the source or the effect
115         properties are animated.
116
117         By default, the property is set to \c false.
118
119     */
120     property bool cached: false
121
122     SourceProxy {
123         id: sourceProxy
124         input: rootItem.source
125     }
126
127     ShaderEffectSource {
128         id: cacheItem
129         anchors.fill: parent
130         visible: rootItem.cached
131         smooth: true
132         sourceItem: shaderItem
133         live: true
134         hideSource: visible
135     }
136
137     ShaderEffect {
138         id: shaderItem
139         property variant source: sourceProxy.output
140         property color color: rootItem.color
141
142         anchors.fill: parent
143
144         fragmentShader: "
145             varying mediump vec2 qt_TexCoord0;
146             uniform highp float qt_Opacity;
147             uniform lowp sampler2D source;
148             uniform highp vec4 color;
149             void main() {
150                 highp vec4 pixelColor = texture2D(source, qt_TexCoord0);
151                 gl_FragColor = vec4(mix(pixelColor.rgb/max(pixelColor.a, 0.00390625), color.rgb/max(color.a, 0.00390625), color.a) * pixelColor.a, pixelColor.a) * qt_Opacity;
152             }
153         "
154     }
155 }