This file is indexed.

/usr/share/qt5/doc/qtgraphicaleffects/qml-qtgraphicaleffects-thresholdmask.html is in qtgraphicaleffects5-doc-html 5.2.1-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- ThresholdMask.qml -->
  <title>ThresholdMask | QtGraphicalEffects 5.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
    <div class="main">
    <div class="main-rounded">
        <div class="navigationbar">
        <ul>
<li>Qt 5.2</li>
<li><a href="qtgraphicaleffects-index.html">Qt Graphical Effects</a></li>
<li><a href="graphicaleffects.html">QML Types</a></li>
<li>ThresholdMask</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
    </ul>
    </div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#example">Example</a></li>
</ul>
</div>
<h1 class="title">ThresholdMask</h1>
<span class="subtitle"></span>
<!-- $$$ThresholdMask-brief -->
<p>Masks the source item with another item and applies a threshold value. <a href="#details">More...</a></p>
<!-- @@@ThresholdMask -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> </b><tt>import QtGraphicalEffects 1.0</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  QtGraphicalEffects 1.0</td></tr></table><ul>
<li><a href="qml-qtgraphicaleffects-thresholdmask-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-thresholdmask.html#cached-prop">cached</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-thresholdmask.html#maskSource-prop">maskSource</a></b></b> : variant</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-thresholdmask.html#source-prop">source</a></b></b> : variant</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-thresholdmask.html#spread-prop">spread</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-thresholdmask.html#threshold-prop">threshold</a></b></b> : real</li>
</ul>
<!-- $$$ThresholdMask-description -->
<a name="details"></a>
<h2>Detailed Description</h2>
<p>The masking behavior can be controlled with the <a href="qml-qtgraphicaleffects-thresholdmask.html#threshold-prop">threshold</a> value for the mask pixels.</p>
<table class="generic">
 <thead><tr class="qt-style"><th >Source</th><th >MaskSource</th><th >Effect applied</th></tr></thead>
<tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/Original_bug.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/ThresholdMask_mask.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/ThresholdMask_bug.png" alt="" /></p></td></tr>
</table>
<a name="example"></a>
<h2>Example</h2>
<p>The following example shows how to apply the effect.</p>
<pre class="qml">import QtQuick 2.0
import QtGraphicalEffects 1.0

<span class="type">Item</span> {
    <span class="name">width</span>: <span class="number">300</span>
    <span class="name">height</span>: <span class="number">300</span>

    <span class="type">Image</span> {
        <span class="name">id</span>: <span class="name">background</span>
        <span class="name">anchors</span>.fill: <span class="name">parent</span>
        <span class="name">source</span>: <span class="string">&quot;images/checker.png&quot;</span>
        <span class="name">smooth</span>: <span class="number">true</span>
        <span class="name">fillMode</span>: <span class="name">Image</span>.<span class="name">Tile</span>
    }

    <span class="type">Image</span> {
        <span class="name">id</span>: <span class="name">bug</span>
        <span class="name">source</span>: <span class="string">&quot;images/bug.jpg&quot;</span>
        <span class="name">sourceSize</span>: <span class="name">Qt</span>.<span class="name">size</span>(<span class="name">parent</span>.<span class="name">width</span>, <span class="name">parent</span>.<span class="name">height</span>)
        <span class="name">smooth</span>: <span class="number">true</span>
        <span class="name">visible</span>: <span class="number">false</span>
    }

    <span class="type">Image</span> {
        <span class="name">id</span>: <span class="name">mask</span>
        <span class="name">source</span>: <span class="string">&quot;images/fog.png&quot;</span>
        <span class="name">sourceSize</span>: <span class="name">Qt</span>.<span class="name">size</span>(<span class="name">parent</span>.<span class="name">width</span>, <span class="name">parent</span>.<span class="name">height</span>)
        <span class="name">smooth</span>: <span class="number">true</span>
        <span class="name">visible</span>: <span class="number">false</span>
    }

    <span class="type">ThresholdMask</span> {
        <span class="name">anchors</span>.fill: <span class="name">bug</span>
        <span class="name">source</span>: <span class="name">bug</span>
        <span class="name">maskSource</span>: <span class="name">mask</span>
        <span class="name">threshold</span>: <span class="number">0.4</span>
        <span class="name">spread</span>: <span class="number">0.2</span>
    }
}</pre>
<!-- @@@ThresholdMask -->
<h2>Property Documentation</h2>
<!-- $$$cached -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="cached-prop"></a><span class="name">cached</span> : <span class="type">bool</span></p></td></tr></table></div><div class="qmldoc"><p>This property allows the effect output pixels to be cached in order to improve the rendering performance.</p>
<p>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.</p>
<p>It is recommended to disable the cache when the source or the effect properties are animated.</p>
<p>By default, the property is set to <tt>false</tt>.</p>
</div></div><!-- @@@cached -->
<br/>
<!-- $$$maskSource -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="maskSource-prop"></a><span class="name">maskSource</span> : <span class="type">variant</span></p></td></tr></table></div><div class="qmldoc"><p>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.</p>
<table class="generic">
 <thead><tr class="qt-style"><th >Original</th><th >Mask</th><th >Effect applied</th></tr></thead>
<tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/Original_bug.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/ThresholdMask_mask.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/ThresholdMask_bug.png" alt="" /></p></td></tr>
</table>
<p><b>Note: </b>It is not supported to let the effect include itself, for instance by setting maskSource to the effect's parent.</p></div></div><!-- @@@maskSource -->
<br/>
<!-- $$$source -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="source-prop"></a><span class="name">source</span> : <span class="type">variant</span></p></td></tr></table></div><div class="qmldoc"><p>This property defines the source item that is going to be masked.</p>
<p><b>Note: </b>It is not supported to let the effect include itself, for instance by setting source to the effect's parent.</p></div></div><!-- @@@source -->
<br/>
<!-- $$$spread -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="spread-prop"></a><span class="name">spread</span> : <span class="type">real</span></p></td></tr></table></div><div class="qmldoc"><p>This property defines the smoothness of the mask edges near the <a href="qml-qtgraphicaleffects-thresholdmask.html#threshold-prop">threshold</a> 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.</p>
<p>The value ranges from 0.0 (sharp mask edge) to 1.0 (smooth mask edge). By default, the property is set to <tt>0.0</tt>.</p>
<table class="generic">
 <thead><tr class="qt-style"><th >Output examples with different spread values</th><th ></th><th ></th></tr></thead>
<tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/ThresholdMask_spread1.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/ThresholdMask_spread2.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/ThresholdMask_spread3.png" alt="" /></p></td></tr>
<tr valign="top" class="even"><td ><b> spread: 0.0 </b></td><td ><b> spread: 0.2 </b></td><td ><b> spread: 0.8 </b></td></tr>
<tr valign="top" class="odd"><td ><a href="qml-qtgraphicaleffects-thresholdmask.html#threshold-prop">threshold</a>: 0.4</td><td ><a href="qml-qtgraphicaleffects-thresholdmask.html#threshold-prop">threshold</a>: 0.4</td><td ><a href="qml-qtgraphicaleffects-thresholdmask.html#threshold-prop">threshold</a>: 0.4</td></tr>
</table>
</div></div><!-- @@@spread -->
<br/>
<!-- $$$threshold -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="threshold-prop"></a><span class="name">threshold</span> : <span class="type">real</span></p></td></tr></table></div><div class="qmldoc"><p>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.</p>
<p>The value ranges from 0.0 (alpha value 0) to 1.0 (alpha value 255). By default, the property is set to <tt>0.0</tt>.</p>
<table class="generic">
 <thead><tr class="qt-style"><th >Output examples with different threshold values</th><th ></th><th ></th></tr></thead>
<tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/ThresholdMask_threshold1.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/ThresholdMask_threshold2.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/ThresholdMask_threshold3.png" alt="" /></p></td></tr>
<tr valign="top" class="even"><td ><b> threshold: 0.0 </b></td><td ><b> threshold: 0.5 </b></td><td ><b> threshold: 0.7 </b></td></tr>
<tr valign="top" class="odd"><td ><a href="qml-qtgraphicaleffects-thresholdmask.html#spread-prop">spread</a>: 0.2</td><td ><a href="qml-qtgraphicaleffects-thresholdmask.html#spread-prop">spread</a>: 0.2</td><td ><a href="qml-qtgraphicaleffects-thresholdmask.html#spread-prop">spread</a>: 0.2</td></tr>
</table>
</div></div><!-- @@@threshold -->
<br/>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2013 Digia Plc and/or its
   subsidiaries. Documentation contributions included herein are the copyrights of
   their respective owners.<br>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br>    Digia, Qt and their respective logos are trademarks of Digia Plc     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>