blob: 2fd4e3b6985a90051457545921a1f657e50c27c5 (
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
|
/****************************************************************************
**
** 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 OpacityMask
\inqmlmodule QtGraphicalEffects 1.0
\since QtGraphicalEffects 1.0
\inherits QtQuick2::Item
\ingroup qtgraphicaleffects-mask
\brief Masks the source item with another item.
\table
\header
\li Source
\li MaskSource
\li Effect applied
\row
\li \image Original_bug.png
\li \image OpacityMask_mask.png
\li \image OpacityMask_bug.png
\endtable
\section1 Example
The following example shows how to apply the effect.
\snippet snippets/OpacityMask-example.qml example
*/
/*!
\qmlproperty variant QtGraphicalEffects1::OpacityMask::source
This property defines the source item that is going to be masked.
*/
/*!
\qmlproperty variant QtGraphicalEffects1::OpacityMask::maskSource
This property defines the item that is going to be used as the mask. The mask item gets rendered into an intermediate pixel buffer and
the alpha values from the result are used to determine the source item's pixels visibility in the display.
\table
\header
\li Original
\li Mask
\li Effect applied
\row
\li \image Original_bug.png
\li \image OpacityMask_mask.png
\li \image OpacityMask_bug.png
\endtable
*/
/*!
\qmlproperty bool QtGraphicalEffects1::OpacityMask::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.
*/
|
