/usr/share/qt5/doc/qtgraphicaleffects/qml-qtgraphicaleffects-rectangularglow.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 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- RectangularGlow.qml -->
<title>RectangularGlow 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 >RectangularGlow 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">RectangularGlow QML Type</h1>
<span class="subtitle"></span>
<!-- $$$RectangularGlow-brief -->
<p>Generates a blurred and colorized rectangle, which gives the impression that the source is glowing. <a href="#details">More...</a></p>
<!-- @@@RectangularGlow -->
<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-rectangularglow-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-rectangularglow.html#cached-prop">cached</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-rectangularglow.html#color-prop">color</a></b></b> : color</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-rectangularglow.html#cornerRadius-prop">cornerRadius</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-rectangularglow.html#glowRadius-prop">glowRadius</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-rectangularglow.html#spread-prop">spread</a></b></b> : real</li>
</ul>
<!-- $$$RectangularGlow-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>This effect is intended to have good performance. The shape of the glow is limited to a rectangle with a custom corner radius. For situations where custom shapes are required, consider <a href="qml-qtgraphicaleffects-glow.html">Glow</a> effect.</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Effect applied</th></tr></thead>
<tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/RectangularGlow_applied.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-rectangle.html">Rectangle</a></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">color</span>: <span class="string">"black"</span>
}
<span class="type"><a href="qml-qtgraphicaleffects-rectangularglow.html">RectangularGlow</a></span> {
<span class="name">id</span>: <span class="name">effect</span>
<span class="name">anchors</span>.fill: <span class="name">rect</span>
<span class="name">glowRadius</span>: <span class="number">10</span>
<span class="name">spread</span>: <span class="number">0.2</span>
<span class="name">color</span>: <span class="string">"white"</span>
<span class="name">cornerRadius</span>: <span class="name">rect</span>.<span class="name">radius</span> <span class="operator">+</span> <span class="name">glowRadius</span>
}
<span class="type"><a href="../qtquick/qml-qtquick-rectangle.html">Rectangle</a></span> {
<span class="name">id</span>: <span class="name">rect</span>
<span class="name">color</span>: <span class="string">"black"</span>
<span class="name">anchors</span>.centerIn: <span class="name">parent</span>
<span class="name">width</span>: <span class="name">Math</span>.<span class="name">round</span>(<span class="name">parent</span>.<span class="name">width</span> <span class="operator">/</span> <span class="number">1.5</span>)
<span class="name">height</span>: <span class="name">Math</span>.<span class="name">round</span>(<span class="name">parent</span>.<span class="name">height</span> <span class="operator">/</span> <span class="number">2</span>)
<span class="name">radius</span>: <span class="number">25</span>
}
}
</pre>
<!-- @@@RectangularGlow -->
<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/>
<!-- $$$color -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="color-prop">
<td class="tblQmlPropNode"><p>
<a name="color-prop"></a><span class="name">color</span> : <span class="type">color</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property defines the RGBA color value which is used for the glow.</p>
<p>By default, the property is set to <code>"white"</code>.</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Output examples with different color values</th><th ></th><th ></th></tr></thead>
<tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/RectangularGlow_color1.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/RectangularGlow_color2.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/RectangularGlow_color3.png" alt="" /></p></td></tr>
<tr valign="top" class="even"><td ><b> color: #ffffff </b></td><td ><b> color: #55ff55 </b></td><td ><b> color: #5555ff </b></td></tr>
<tr valign="top" class="odd"><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#glowRadius-prop">glowRadius</a>: 20</td><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#glowRadius-prop">glowRadius</a>: 20</td><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#glowRadius-prop">glowRadius</a>: 20</td></tr>
<tr valign="top" class="even"><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#spread-prop">spread</a>: 0</td><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#spread-prop">spread</a>: 0</td><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#spread-prop">spread</a>: 0</td></tr>
<tr valign="top" class="odd"><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#cornerRadius-prop">cornerRadius</a>: 25</td><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#cornerRadius-prop">cornerRadius</a>: 25</td><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#cornerRadius-prop">cornerRadius</a>: 25</td></tr>
</table></div>
</div></div><!-- @@@color -->
<br/>
<!-- $$$cornerRadius -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="cornerRadius-prop">
<td class="tblQmlPropNode"><p>
<a name="cornerRadius-prop"></a><span class="name">cornerRadius</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property defines the corner radius that is used to draw a glow with rounded corners.</p>
<p>The value ranges from 0.0 to half of the effective width or height of the glow, whichever is smaller. This can be calculated with: <code>min(width, height) / 2.0 + glowRadius</code></p>
<p>By default, the property is bound to <a href="qml-qtgraphicaleffects-rectangularglow.html#glowRadius-prop">glowRadius</a> property. The glow behaves as if the rectangle was blurred when adjusting the <a href="qml-qtgraphicaleffects-rectangularglow.html#glowRadius-prop">glowRadius</a> property.</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Output examples with different cornerRadius values</th><th ></th><th ></th></tr></thead>
<tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/RectangularGlow_cornerRadius1.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/RectangularGlow_cornerRadius2.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/RectangularGlow_cornerRadius3.png" alt="" /></p></td></tr>
<tr valign="top" class="even"><td ><b> cornerRadius: 0 </b></td><td ><b> cornerRadius: 25 </b></td><td ><b> cornerRadius: 50 </b></td></tr>
<tr valign="top" class="odd"><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#glowRadius-prop">glowRadius</a>: 20</td><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#glowRadius-prop">glowRadius</a>: 20</td><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#glowRadius-prop">glowRadius</a>: 20</td></tr>
<tr valign="top" class="even"><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#spread-prop">spread</a>: 0</td><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#spread-prop">spread</a>: 0</td><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#spread-prop">spread</a>: 0</td></tr>
<tr valign="top" class="odd"><td ><a href="graphicaleffects.html#color">color</a>: #ffffff</td><td ><a href="graphicaleffects.html#color">color</a>: #ffffff</td><td ><a href="graphicaleffects.html#color">color</a>: #ffffff</td></tr>
</table></div>
</div></div><!-- @@@cornerRadius -->
<br/>
<!-- $$$glowRadius -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="glowRadius-prop">
<td class="tblQmlPropNode"><p>
<a name="glowRadius-prop"></a><span class="name">glowRadius</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property defines how many pixels outside the item area are reached by the glow.</p>
<p>The value ranges from 0.0 (no glow) to inf (infinite glow). By default, the property is set to <code>0.0</code>.</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Output examples with different glowRadius values</th><th ></th><th ></th></tr></thead>
<tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/RectangularGlow_glowRadius1.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/RectangularGlow_glowRadius2.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/RectangularGlow_glowRadius3.png" alt="" /></p></td></tr>
<tr valign="top" class="even"><td ><b> glowRadius: 10 </b></td><td ><b> glowRadius: 20 </b></td><td ><b> glowRadius: 40 </b></td></tr>
<tr valign="top" class="odd"><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#spread-prop">spread</a>: 0</td><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#spread-prop">spread</a>: 0</td><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#spread-prop">spread</a>: 0</td></tr>
<tr valign="top" class="even"><td ><a href="graphicaleffects.html#color">color</a>: #ffffff</td><td ><a href="graphicaleffects.html#color">color</a>: #ffffff</td><td ><a href="graphicaleffects.html#color">color</a>: #ffffff</td></tr>
<tr valign="top" class="odd"><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#cornerRadius-prop">cornerRadius</a>: 25</td><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#cornerRadius-prop">cornerRadius</a>: 25</td><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#cornerRadius-prop">cornerRadius</a>: 25</td></tr>
</table></div>
</div></div><!-- @@@glowRadius -->
<br/>
<!-- $$$spread -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="spread-prop">
<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><div class="qmldoc"><p>This property defines how large part of the glow color is strengthened near the source edges.</p>
<p>The value ranges from 0.0 (no strength increase) to 1.0 (maximum strength increase). By default, the property is set to <code>0.0</code>.</p>
<div class="table"><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/RectangularGlow_spread1.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/RectangularGlow_spread2.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/RectangularGlow_spread3.png" alt="" /></p></td></tr>
<tr valign="top" class="even"><td ><b> spread: 0.0 </b></td><td ><b> spread: 0.5 </b></td><td ><b> spread: 1.0 </b></td></tr>
<tr valign="top" class="odd"><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#glowRadius-prop">glowRadius</a>: 20</td><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#glowRadius-prop">glowRadius</a>: 20</td><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#glowRadius-prop">glowRadius</a>: 20</td></tr>
<tr valign="top" class="even"><td ><a href="graphicaleffects.html#color">color</a>: #ffffff</td><td ><a href="graphicaleffects.html#color">color</a>: #ffffff</td><td ><a href="graphicaleffects.html#color">color</a>: #ffffff</td></tr>
<tr valign="top" class="odd"><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#cornerRadius-prop">cornerRadius</a>: 25</td><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#cornerRadius-prop">cornerRadius</a>: 25</td><td ><a href="qml-qtgraphicaleffects-rectangularglow.html#cornerRadius-prop">cornerRadius</a>: 25</td></tr>
</table></div>
</div></div><!-- @@@spread -->
<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>
|