/usr/share/qt5/doc/qtgraphicaleffects/qml-qtgraphicaleffects-displace.html is in qtgraphicaleffects5-doc-html 5.9.5-0ubuntu1.
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 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- Displace.qml -->
<title>Displace QML Type | Qt Graphical Effects 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtgraphicaleffects-index.html">Qt Graphical Effects</a></td><td ><a href="graphicaleffects.html">QML Types</a></td><td >Displace QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.5 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<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>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Displace QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Displace-brief -->
<p>Moves the pixels of the source item according to the given displacement map. <a href="#details">More...</a></p>
<!-- @@@Displace -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtGraphicalEffects 1.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> QtGraphicalEffects 1.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="../qtquick/qml-qtquick-item.html">Item</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtgraphicaleffects-displace-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-displace.html#cached-prop">cached</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-displace.html#displacement-prop">displacement</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-displace.html#displacementSource-prop">displacementSource</a></b></b> : variant</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-displace.html#source-prop">source</a></b></b> : variant</li>
</ul>
<!-- $$$Displace-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Source</th><th >DisplacementSource</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/Displace_map.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/Displace_bug.png" alt="" /></p></td></tr>
</table></div>
<p><b>Note: </b>This effect is available when running with OpenGL.</p><a name="example"></a>
<h2 id="example">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"><a href="../qtquick/qml-qtquick-item.html">Item</a></span> {
<span class="name">width</span>: <span class="number">300</span>
<span class="name">height</span>: <span class="number">300</span>
<span class="type"><a href="../qtquick/qml-qtquick-image.html">Image</a></span> {
<span class="name">id</span>: <span class="name">bug</span>
<span class="name">source</span>: <span class="string">"images/bug.jpg"</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"><a href="../qtquick/qml-qtquick-rectangle.html">Rectangle</a></span> {
<span class="name">id</span>: <span class="name">displacement</span>
<span class="name">color</span>: <span class="name">Qt</span>.<span class="name">rgba</span>(<span class="number">0.5</span>, <span class="number">0.5</span>, <span class="number">1.0</span>, <span class="number">1.0</span>)
<span class="name">anchors</span>.fill: <span class="name">parent</span>
<span class="name">visible</span>: <span class="number">false</span>
<span class="type"><a href="../qtquick/qml-qtquick-image.html">Image</a></span> {
<span class="name">anchors</span>.centerIn: <span class="name">parent</span>
<span class="name">source</span>: <span class="string">"images/glass_normal.png"</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="operator">/</span><span class="number">2</span>, <span class="name">parent</span>.<span class="name">height</span><span class="operator">/</span><span class="number">2</span>)
<span class="name">smooth</span>: <span class="number">true</span>
}
}
<span class="type"><a href="qml-qtgraphicaleffects-displace.html">Displace</a></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">displacementSource</span>: <span class="name">displacement</span>
<span class="name">displacement</span>: <span class="number">0.1</span>
}
}
</pre>
<!-- @@@Displace -->
<h2>Property Documentation</h2>
<!-- $$$cached -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="cached-prop">
<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><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 <code>false</code>.</p>
</div></div><!-- @@@cached -->
<br/>
<!-- $$$displacement -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="displacement-prop">
<td class="tblQmlPropNode"><p>
<a name="displacement-prop"></a><span class="name">displacement</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property defines the scale for the displacement. The bigger scale, the bigger the displacement of the pixels. The value set to 0.0 causes no displacement.</p>
<p>The value ranges from -1.0 (inverted maximum shift, according to <a href="qml-qtgraphicaleffects-displace.html#displacementSource-prop">displacementSource</a>) to 1.0 (maximum shift, according to <a href="qml-qtgraphicaleffects-displace.html#displacementSource-prop">displacementSource</a>). By default, the property is set to <code>0.0</code> (no displacement).</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Output examples with different displacement values</th><th ></th><th ></th></tr></thead>
<tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/Displace_displacement1.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/Displace_displacement2.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/Displace_displacement3.png" alt="" /></p></td></tr>
<tr valign="top" class="even"><td ><b> displacement: -0.2 </b></td><td ><b> displacement: 0.0 </b></td><td ><b> displacement: 0.2 </b></td></tr>
</table></div>
</div></div><!-- @@@displacement -->
<br/>
<!-- $$$displacementSource -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="displacementSource-prop">
<td class="tblQmlPropNode"><p>
<a name="displacementSource-prop"></a><span class="name">displacementSource</span> : <span class="type"><a href="../qtqml/qml-variant.html">variant</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property defines the item that is going to be used as the displacement map. The displacementSource item gets rendered into the intermediate pixel buffer. The red and green component values from the result determine the displacement of the pixels from the source item.</p>
<p>The format for the displacement map is similar to the tangent space normal maps, which can be created with most 3D-modeling tools. Many image processing tools include the support for generating normal maps. Alternatively, the displacement map for this effect can also be a QML element which is colored appropriately. Like any QML element, it can be animated. It is recommended that the size of the diplacement map matches the size of the <a href="qml-qtgraphicaleffects-displace.html#source-prop">source</a>.</p>
<p>The displace data is interpreted in the RGBA format. For every pixel: the red channel stores the x-axis displacement, and the green channel stores the y-axis displacement. Blue and alpha channels are ignored for this effect.</p>
<p>Assuming that red channel value 1.0 is fully red (0.0 having no red at all), this effect considers pixel component value 0.5 to cause no displacement at all. Values above 0.5 shift pixels to the left, values below 0.5 do the shift to the right. In a similar way, green channel values above 0.5 displace the pixels upwards, and values below 0.5 shift the pixels downwards. The actual amount of displacement in pixels depends on the <a href="qml-qtgraphicaleffects-displace.html#displacement-prop">displacement</a> property.</p>
</div></div><!-- @@@displacementSource -->
<br/>
<!-- $$$source -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="source-prop">
<td class="tblQmlPropNode"><p>
<a name="source-prop"></a><span class="name">source</span> : <span class="type"><a href="../qtqml/qml-variant.html">variant</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property defines the source item for the pixels that are going to be displaced according to the data from <a href="qml-qtgraphicaleffects-displace.html#displacementSource-prop">displacementSource</a>.</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/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
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> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|