<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qsgnode.cpp -->
<title>QSGClipNode Class | Qt Quick 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="qtquick-index.html">Qt Quick</a></td><td ><a href="qtquick-module.html">C++ Classes</a></td><td >QSGClipNode</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QSGClipNode Class</h1>
<!-- $$$QSGClipNode-brief -->
<p>The <a href="qsgclipnode.html">QSGClipNode</a> class implements the clipping functionality in the scene graph. <a href="#details">More...</a></p>
<!-- @@@QSGClipNode -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QSGClipNode></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += quick</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qsgbasicgeometrynode.html">QSGBasicGeometryNode</a></td></tr></table></div><ul>
<li><a href="qsgclipnode-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qsgclipnode.html#QSGClipNode">QSGClipNode</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qsgclipnode.html#dtor.QSGClipNode">~QSGClipNode</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRectF </td><td class="memItemRight bottomAlign"><b><a href="qsgclipnode.html#clipRect">clipRect</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsgclipnode.html#isRectangular">isRectangular</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsgclipnode.html#setClipRect">setClipRect</a></b>(const QRectF &<i>rect</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsgclipnode.html#setIsRectangular">setIsRectangular</a></b>(bool <i>rectHint</i>)</td></tr>
</table></div>
<ul>
<li class="fn">3 public functions inherited from <a href="qsgbasicgeometrynode.html#public-functions">QSGBasicGeometryNode</a></li>
<li class="fn">20 public functions inherited from <a href="qsgnode.html#public-functions">QSGNode</a></li>
</ul>
<a name="details"></a>
<!-- $$$QSGClipNode-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qsgclipnode.html">QSGClipNode</a> class implements the clipping functionality in the scene graph.</p>
<p>Clipping applies to the node's subtree and can be nested. Multiple clip nodes will be accumulated by intersecting all their geometries. The accumulation happens as part of the rendering.</p>
<p>Clip nodes must have a geometry before they can be added to the scene graph.</p>
<p>Clipping is usually implemented by using the stencil buffer.</p>
<p><b>Note: </b>All classes with QSG prefix should be used solely on the scene graph's rendering thread. See <a href="qtquick-visualcanvas-scenegraph.html#scene-graph-and-rendering">Scene Graph and Rendering</a> for more information.</p></div>
<!-- @@@QSGClipNode -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QSGClipNode[overload1]$$$QSGClipNode -->
<h3 class="fn" id="QSGClipNode"><a name="QSGClipNode"></a>QSGClipNode::<span class="name">QSGClipNode</span>()</h3>
<p>Creates a new <a href="qsgclipnode.html">QSGClipNode</a> without a geometry.</p>
<p>The clip node must have a geometry before it can be added to the scene graph.</p>
<!-- @@@QSGClipNode -->
<!-- $$$~QSGClipNode[overload1]$$$~QSGClipNode -->
<h3 class="fn" id="dtor.QSGClipNode"><a name="dtor.QSGClipNode"></a>QSGClipNode::<span class="name">~QSGClipNode</span>()</h3>
<p>Deletes this <a href="qsgclipnode.html">QSGClipNode</a>.</p>
<p>If the flag <a href="qsgnode.html#Flag-enum">QSGNode::OwnsGeometry</a> is set, the geometry will also be deleted.</p>
<!-- @@@~QSGClipNode -->
<!-- $$$clipRect[overload1]$$$clipRect -->
<h3 class="fn" id="clipRect"><a name="clipRect"></a><span class="type">QRectF</span> QSGClipNode::<span class="name">clipRect</span>() const</h3>
<p>Returns the clip rect of this node.</p>
<p><b>See also </b><a href="qsgclipnode.html#setClipRect">setClipRect</a>().</p>
<!-- @@@clipRect -->
<!-- $$$isRectangular[overload1]$$$isRectangular -->
<h3 class="fn" id="isRectangular"><a name="isRectangular"></a><span class="type">bool</span> QSGClipNode::<span class="name">isRectangular</span>() const</h3>
<p>Returns if this clip node has a rectangular clip.</p>
<p><b>See also </b><a href="qsgclipnode.html#setIsRectangular">setIsRectangular</a>().</p>
<!-- @@@isRectangular -->
<!-- $$$setClipRect[overload1]$$$setClipRectconstQRectF& -->
<h3 class="fn" id="setClipRect"><a name="setClipRect"></a><span class="type">void</span> QSGClipNode::<span class="name">setClipRect</span>(const <span class="type">QRectF</span> &<i>rect</i>)</h3>
<p>Sets the clip rect of this clip node to <i>rect</i>.</p>
<p>When a rectangular clip is set in combination with <a href="qsgclipnode.html#setIsRectangular">setIsRectangular</a> the renderer may in some cases use a more optimal clip method.</p>
<p><b>See also </b><a href="qsgclipnode.html#clipRect">clipRect</a>().</p>
<!-- @@@setClipRect -->
<!-- $$$setIsRectangular[overload1]$$$setIsRectangularbool -->
<h3 class="fn" id="setIsRectangular"><a name="setIsRectangular"></a><span class="type">void</span> QSGClipNode::<span class="name">setIsRectangular</span>(<span class="type">bool</span> <i>rectHint</i>)</h3>
<p>Sets whether this clip node has a rectangular clip to <i>rectHint</i>.</p>
<p>This is an optimization hint which means that the renderer can use scissoring instead of stencil, which is significantly faster.</p>
<p>When this hint is set and it is applicable, the clip region will be generated from <a href="qsgclipnode.html#clipRect">clipRect</a>() rather than <a href="qsgbasicgeometrynode.html#geometry">geometry</a>().</p>
<p>By default this property is <code>false</code>.</p>
<p><b>See also </b><a href="qsgclipnode.html#isRectangular">isRectangular</a>().</p>
<!-- @@@setIsRectangular -->
</div>
</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>
