Skip to content
Snippets Groups Projects
Normal view Permalink
qml-qtgraphicaleffects-huesaturation.html 13.1 KiB
Newer Older
  • Learn to ignore specific revisions
    • Hannah Senftleben's avatar
    Upload Dateien erstes Semester
    Hannah Senftleben committed
    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 
    <!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
<!-- HueSaturation.qml -->
  <title>HueSaturation QML Type | Qt Graphical Effects 5.15.0</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">
        <ul>
<li><a href="../qtdoc/index.html">Qt 5.15</a></li>
<li><a href="qtgraphicaleffects-index.html">Qt Graphical Effects</a></li>
<li><a href="graphicaleffects.html">QML Types</a></li>
<li>HueSaturation QML Type</li>
<li id="buildversion"><a href="qtgraphicaleffects-index.html">Qt 5.15.0 Reference Documentation</a></li>
    </ul>
    </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">HueSaturation QML Type</h1>
<span class="subtitle"></span>
<!-- $$$HueSaturation-brief -->
<p>Alters the source item colors in the HSL color space. <a href="#details">More...</a></p>
<!-- @@@HueSaturation -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtGraphicalEffects 1.15</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-huesaturation-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-huesaturation.html#cached-prop">cached</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-huesaturation.html#hue-prop">hue</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-huesaturation.html#lightness-prop">lightness</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-huesaturation.html#saturation-prop">saturation</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtgraphicaleffects-huesaturation.html#source-prop">source</a></b></b> : variant</li>
</ul>
<!-- $$$HueSaturation-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>HueSaturation is similar to the <a href="qml-qtgraphicaleffects-colorize.html">Colorize</a> effect, but the hue and saturation property values are handled differently. The HueSaturation effect always shifts the hue, saturation, and lightness from the original, instead of setting them.</p>
<div class="table"><table class="generic">
 <thead><tr class="qt-style"><th >Source</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/HueSaturation_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.12
 import QtGraphicalEffects 1.12

 <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">&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"><a href="qml-qtgraphicaleffects-huesaturation.html">HueSaturation</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">hue</span>: -<span class="number">0.3</span>
         <span class="name">saturation</span>: <span class="number">0.5</span>
         <span class="name">lightness</span>: -<span class="number">0.1</span>
     }
 }
</pre>
<!-- @@@HueSaturation -->
<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"><a href="../qtqml/qml-bool.html">bool</a></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/>
<!-- $$$hue -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="hue-prop">
<td class="tblQmlPropNode"><p>
<a name="hue-prop"></a><span class="name">hue</span> : <span class="type"><a href="../qtqml/qml-real.html">real</a></span></p></td></tr>
</table></div></div>
<div class="qmldoc"><p>This property defines the hue value which is added to the source hue value.</p>
<p>The value ranges from -1.0 (decrease) to 1.0 (increase). By default, the property is set to <code>0.0</code> (no change).</p>
<div class="table"><table class="generic">
 <thead><tr class="qt-style"><th >Output examples with different hue values</th><th ></th><th ></th></tr></thead>
<tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/HueSaturation_hue1.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/HueSaturation_hue2.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/HueSaturation_hue3.png" alt="" /></p></td></tr>
<tr valign="top" class="even"><td ><b> hue: -0.3 </b></td><td ><b> hue: 0.0 </b></td><td ><b> hue: 0.3 </b></td></tr>
<tr valign="top" class="odd"><td ><a href="qml-qtgraphicaleffects-huesaturation.html#saturation-prop">saturation</a>: 0</td><td ><a href="qml-qtgraphicaleffects-huesaturation.html#saturation-prop">saturation</a>: 0</td><td ><a href="qml-qtgraphicaleffects-huesaturation.html#saturation-prop">saturation</a>: 0</td></tr>
<tr valign="top" class="even"><td ><a href="qml-qtgraphicaleffects-huesaturation.html#lightness-prop">lightness</a>: 0</td><td ><a href="qml-qtgraphicaleffects-huesaturation.html#lightness-prop">lightness</a>: 0</td><td ><a href="qml-qtgraphicaleffects-huesaturation.html#lightness-prop">lightness</a>: 0</td></tr>
</table></div>
</div></div><!-- @@@hue -->
<br/>
<!-- $$$lightness -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="lightness-prop">
<td class="tblQmlPropNode"><p>
<a name="lightness-prop"></a><span class="name">lightness</span> : <span class="type"><a href="../qtqml/qml-real.html">real</a></span></p></td></tr>
</table></div></div>
<div class="qmldoc"><p>This property defines the lightness value which is added to the source saturation value.</p>
<p>The value ranges from -1.0 (decrease) to 1.0 (increase). By default, the property is set to <code>0.0</code> (no change).</p>
<div class="table"><table class="generic">
 <thead><tr class="qt-style"><th >Output examples with different lightness values</th><th ></th><th ></th></tr></thead>
<tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/HueSaturation_lightness1.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/HueSaturation_lightness2.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/HueSaturation_lightness3.png" alt="" /></p></td></tr>
<tr valign="top" class="even"><td ><b> lightness: -0.5 </b></td><td ><b> lightness: 0.0 </b></td><td ><b> lightness: 0.5 </b></td></tr>
<tr valign="top" class="odd"><td ><a href="qml-qtgraphicaleffects-huesaturation.html#hue-prop">hue</a>: 0</td><td ><a href="qml-qtgraphicaleffects-huesaturation.html#hue-prop">hue</a>: 0</td><td ><a href="qml-qtgraphicaleffects-huesaturation.html#hue-prop">hue</a>: 0</td></tr>
<tr valign="top" class="even"><td ><a href="qml-qtgraphicaleffects-huesaturation.html#saturation-prop">saturation</a>: 0</td><td ><a href="qml-qtgraphicaleffects-huesaturation.html#saturation-prop">saturation</a>: 0</td><td ><a href="qml-qtgraphicaleffects-huesaturation.html#saturation-prop">saturation</a>: 0</td></tr>
</table></div>
</div></div><!-- @@@lightness -->
<br/>
<!-- $$$saturation -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="saturation-prop">
<td class="tblQmlPropNode"><p>
<a name="saturation-prop"></a><span class="name">saturation</span> : <span class="type"><a href="../qtqml/qml-real.html">real</a></span></p></td></tr>
</table></div></div>
<div class="qmldoc"><p>This property defines the saturation value value which is added to the source saturation value.</p>
<p>The value ranges from -1.0 (decrease) to 1.0 (increase). By default, the property is set to <code>0.0</code> (no change).</p>
<div class="table"><table class="generic">
 <thead><tr class="qt-style"><th >Output examples with different saturation values</th><th ></th><th ></th></tr></thead>
<tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/HueSaturation_saturation1.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/HueSaturation_saturation2.png" alt="" /></p></td><td ><p class="centerAlign"><img src="images/HueSaturation_saturation3.png" alt="" /></p></td></tr>
<tr valign="top" class="even"><td ><b> saturation: -0.8 </b></td><td ><b> saturation: 0.0 </b></td><td ><b> saturation: 1.0 </b></td></tr>
<tr valign="top" class="odd"><td ><a href="qml-qtgraphicaleffects-huesaturation.html#hue-prop">hue</a>: 0</td><td ><a href="qml-qtgraphicaleffects-huesaturation.html#hue-prop">hue</a>: 0</td><td ><a href="qml-qtgraphicaleffects-huesaturation.html#hue-prop">hue</a>: 0</td></tr>
<tr valign="top" class="even"><td ><a href="qml-qtgraphicaleffects-huesaturation.html#lightness-prop">lightness</a>: 0</td><td ><a href="qml-qtgraphicaleffects-huesaturation.html#lightness-prop">lightness</a>: 0</td><td ><a href="qml-qtgraphicaleffects-huesaturation.html#lightness-prop">lightness</a>: 0</td></tr>
</table></div>
</div></div><!-- @@@saturation -->
<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 that provides the source pixels for the effect.</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">&copy;</acronym> 2020 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>