blob: eaf725773dc7ce5b481f5fcc09eedd942f8e280b (
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
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
|
/****************************************************************************
**
** 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 ThresholdMask
\inqmlmodule QtGraphicalEffects 1.0
\since QtGraphicalEffects 1.0
\inherits QtQuick2::Item
\ingroup qtgraphicaleffects-mask
\brief Masks the source item with another item and applies a threshold value.
The masking behavior can be controlled with the \l threshold value for the
mask pixels.
\table
\header
\li Source
\li MaskSource
\li Effect applied
\row
\li \image Original_bug.png
\li \image ThresholdMask_mask.png
\li \image ThresholdMask_bug.png
\endtable
\section1 Example
The following example shows how to apply the effect.
\snippet snippets/ThresholdMask-example.qml example
*/
/*!
\qmlproperty variant QtGraphicalEffects1::ThresholdMask::source
This property defines the source item that is going to be masked.
*/
/*!
\qmlproperty variant QtGraphicalEffects1::ThresholdMask::maskSource
This property defines the item that is going to be used as the mask. 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 ThresholdMask_mask.png
\li \image ThresholdMask_bug.png
\endtable
*/
/*!
\qmlproperty real QtGraphicalEffects1::ThresholdMask::threshold
This property defines a threshold value for the mask pixels. The mask pixels that have an alpha value
below this property are used to completely mask away the corresponding pixels from the source item.
The mask pixels that have a higher alpha value are used to alphablend the source item to the display.
The value ranges from 0.0 (alpha value 0) to 1.0 (alpha value 255). By default, the property is set to \c 0.0.
\table
\header
\li Output examples with different threshold values
\li
\li
\row
\li \image ThresholdMask_threshold1.png
\li \image ThresholdMask_threshold2.png
\li \image ThresholdMask_threshold3.png
\row
\li \b { threshold: 0.0 }
\li \b { threshold: 0.5 }
\li \b { threshold: 0.7 }
\row
\li \l spread: 0.2
\li \l spread: 0.2
\li \l spread: 0.2
\endtable
*/
/*!
\qmlproperty real QtGraphicalEffects1::ThresholdMask::spread
This property defines the smoothness of the mask edges near the
\l{ThresholdMask::threshold}{threshold} alpha value. Setting spread to 0.0
uses mask normally with the specified threshold. Setting higher spread values
softens the transition from the transparent mask pixels towards opaque mask
pixels by adding interpolated values between them.
The value ranges from 0.0 (sharp mask edge) to 1.0 (smooth mask edge). By default, the property is set to \c 0.0.
\table
\header
\li Output examples with different spread values
\li
\li
\row
\li \image ThresholdMask_spread1.png
\li \image ThresholdMask_spread2.png
\li \image ThresholdMask_spread3.png
\row
\li \b { spread: 0.0 }
\li \b { spread: 0.2 }
\li \b { spread: 0.8 }
\row
\li \l threshold: 0.4
\li \l threshold: 0.4
\li \l threshold: 0.4
\endtable
*/
/*!
\qmlproperty bool QtGraphicalEffects1::ThresholdMask::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.
*/
|
