Sophie

Sophie

distrib > Mageia > 7 > i586 > by-pkgid > c936229ef0138f42857f36beadbeda30 > files > 977

qt3d5-doc-5.12.2-2.mga7.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdepthtest.cpp -->
  <title>QDepthTest Class | Qt 3D 5.12.2</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.12</td><td ><a href="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-cpp.html">C++ Classes</a></td><td >QDepthTest</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qt3d-index.html">Qt 5.12.2 Reference Documentation</a></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-types">Public Types</a></li>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</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">QDepthTest Class</h1>
<span class="small-subtitle">(<a href="qt3drender-qdepthtest.html">Qt3DRender::QDepthTest</a>)<br/></span>
<!-- $$$QDepthTest-brief -->
<p>The <a href="qt3drender-qdepthtest.html">QDepthTest</a> class tests the fragment shader's depth value against the depth of a sample being written to. <a href="#details">More...</a></p>
<!-- @@@QDepthTest -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QDepthTest&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += 3drender</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  Qt 5.7</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-render-depthtest.html">DepthTest</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3drender-qrenderstate.html">Qt3DRender::QRenderState</a></td></tr></table></div><ul>
<li><a href="qt3drender-qdepthtest-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qdepthtest.html#DepthFunction-enum">DepthFunction</a></b> { Never, Always, Less, LessOrEqual, ..., NotEqual }</td></tr>
</table></div>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qt3drender-qdepthtest.html#depthFunction-prop">depthFunction</a></b> : DepthFunction</li>
</ul>
<ul>
<li class="fn">3 properties inherited from <a href="qt3dcore-qnode.html#properties">Qt3DCore::QNode</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="qt3drender-qdepthtest.html#QDepthTest">QDepthTest</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DRender::QDepthTest::DepthFunction </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qdepthtest.html#depthFunction-prop">depthFunction</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">13 public functions inherited from <a href="qt3dcore-qnode.html#public-functions">Qt3DCore::QNode</a></li>
</ul>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qdepthtest.html#depthFunction-prop">setDepthFunction</a></b>(Qt3DRender::QDepthTest::DepthFunction <i>depthFunction</i>)</td></tr>
</table></div>
<ul>
<li class="fn">3 public slots inherited from <a href="qt3dcore-qnode.html#public-slots">Qt3DCore::QNode</a></li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qdepthtest.html#depthFunction-prop">depthFunctionChanged</a></b>(Qt3DRender::QDepthTest::DepthFunction <i>depthFunction</i>)</td></tr>
</table></div>
<ul>
<li class="fn">4 signals inherited from <a href="qt3dcore-qnode.html#signals">Qt3DCore::QNode</a></li>
</ul>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qdepthtest.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">2 protected functions inherited from <a href="qt3dcore-qnode.html#protected-functions">Qt3DCore::QNode</a></li>
</ul>
<a name="details"></a>
<!-- $$$QDepthTest-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qt3drender-qdepthtest.html">QDepthTest</a> class tests the fragment shader's depth value against the depth of a sample being written to.</p>
<p>A <a href="qt3drender-qdepthtest.html">QDepthTest</a> class is used to enable depth testing with a given depth test function. The depth test enables writing fragment color values when the depth test passes, and reject fragments which fail the test. The depth test uses the depth function to test the fragments depth value to the value against z-buffer. If the underlying surface does not have z-buffer, then <a href="qt3drender-qdepthtest.html">QDepthTest</a> does nothing.</p>
</div>
<p><b>See also </b><a href="qt3drender-qalphatest.html">QAlphaTest</a> and <a href="qt3drender-qstenciltest.html">QStencilTest</a>.</p>
<!-- @@@QDepthTest -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$DepthFunction$$$Never$$$Always$$$Less$$$LessOrEqual$$$Equal$$$GreaterOrEqual$$$Greater$$$NotEqual -->
<h3 class="fn" id="DepthFunction-enum"><a name="DepthFunction-enum"></a>enum QDepthTest::<span class="name">DepthFunction</span></h3>
<p>Enumeration for the depth function values</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>Qt3DRender::QDepthTest::Never</code></td><td class="topAlign tblval"><code>0x0200</code></td><td class="topAlign">Never pass depth test</td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QDepthTest::Always</code></td><td class="topAlign tblval"><code>0x0207</code></td><td class="topAlign">Always pass depth test</td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QDepthTest::Less</code></td><td class="topAlign tblval"><code>0x0201</code></td><td class="topAlign">Pass depth test if fragment depth is less than z-buffer value</td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QDepthTest::LessOrEqual</code></td><td class="topAlign tblval"><code>0x0203</code></td><td class="topAlign">Pass depth test if fragment depth is less than or equal to z-buffer value</td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QDepthTest::Equal</code></td><td class="topAlign tblval"><code>0x0202</code></td><td class="topAlign">Pass depth test if fragment depth is equal to z-buffer value</td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QDepthTest::GreaterOrEqual</code></td><td class="topAlign tblval"><code>0x0206</code></td><td class="topAlign">Pass depth test if fragment depth is greater than or equal to z-buffer value</td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QDepthTest::Greater</code></td><td class="topAlign tblval"><code>0x0204</code></td><td class="topAlign">Pass depth test if fragment depth is greater than z-buffer value</td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QDepthTest::NotEqual</code></td><td class="topAlign tblval"><code>0x0205</code></td><td class="topAlign">Pass depth test if fragment depth is not equal to z-buffer value</td></tr>
</table></div>
<!-- @@@DepthFunction -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$depthFunction-prop$$$depthFunction$$$setDepthFunctionQt3DRender::QDepthTest::DepthFunction$$$depthFunctionChangedQt3DRender::QDepthTest::DepthFunction -->
<h3 class="fn" id="depthFunction-prop"><a name="depthFunction-prop"></a><span class="name">depthFunction</span> : <span class="type"><a href="qt3drender-qdepthtest.html#DepthFunction-enum">DepthFunction</a></span></h3>
<p>Holds the current function used by depth test. The default is Never.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt3DRender::QDepthTest::DepthFunction </td><td class="memItemRight bottomAlign"><span class="name"><b>depthFunction</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setDepthFunction</b></span>(Qt3DRender::QDepthTest::DepthFunction <i>depthFunction</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>depthFunctionChanged</b></span>(Qt3DRender::QDepthTest::DepthFunction <i>depthFunction</i>)</td></tr>
</table></div>
<!-- @@@depthFunction -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QDepthTest[overload1]$$$QDepthTestQt3DCore::QNode* -->
<h3 class="fn" id="QDepthTest"><a name="QDepthTest"></a>QDepthTest::<span class="name">QDepthTest</span>(<span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3>
<p>The constructor creates a new <a href="qt3drender-qdepthtest.html">QDepthTest::QDepthTest</a> instance with the specified <i>parent</i>.</p>
<!-- @@@QDepthTest -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2019 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>