<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qalphatest.cpp --> <title>QAlphaTest Class | Qt 3D 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="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-cpp.html">C++ Classes</a></td><td >QAlphaTest</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-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="#details">Detailed Description</a></li> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">QAlphaTest Class</h1> <span class="small-subtitle">(<a href="qt3drender-qalphatest.html">Qt3DRender::QAlphaTest</a>)<br/></span> <!-- $$$QAlphaTest-brief --> <p>The <a href="qt3drender-qalphatest.html">QAlphaTest</a> class specify alpha reference test <a href="#details">More...</a></p> <!-- @@@QAlphaTest --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QAlphaTest></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-alphatest.html">AlphaTest</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-qalphatest-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-qalphatest.html#AlphaFunction-enum">AlphaFunction</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-qalphatest.html#alphaFunction-prop">alphaFunction</a></b> : AlphaFunction</li> <li class="fn"><b><a href="qt3drender-qalphatest.html#referenceValue-prop">referenceValue</a></b> : float</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-qalphatest.html#QAlphaTest">QAlphaTest</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> AlphaFunction </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qalphatest.html#alphaFunction-prop">alphaFunction</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qalphatest.html#referenceValue-prop">referenceValue</a></b>() const</td></tr> </table></div> <ul> <li class="fn">11 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-qalphatest.html#alphaFunction-prop">setAlphaFunction</a></b>(AlphaFunction <i>alphaFunction</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qalphatest.html#referenceValue-prop">setReferenceValue</a></b>(float <i>referenceValue</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-qalphatest.html#alphaFunction-prop">alphaFunctionChanged</a></b>(AlphaFunction <i>alphaFunction</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qalphatest.html#referenceValue-prop">referenceValueChanged</a></b>(float <i>referenceValue</i>)</td></tr> </table></div> <ul> <li class="fn">4 signals inherited from <a href="qt3dcore-qnode.html#signals">Qt3DCore::QNode</a></li> </ul> <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> <!-- $$$QAlphaTest-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qt3drender-qalphatest.html">QAlphaTest</a> class specify alpha reference test</p> <p>As the OpenGL documentation explains; The alpha test discards a fragment conditional on the outcome of a comparison between the incoming fragment's alpha value and a constant reference value.</p> </div> <!-- @@@QAlphaTest --> <div class="types"> <h2>Member Type Documentation</h2> <!-- $$$AlphaFunction$$$Never$$$Always$$$Less$$$LessOrEqual$$$Equal$$$GreaterOrEqual$$$Greater$$$NotEqual --> <h3 class="fn" id="AlphaFunction-enum"><a name="AlphaFunction-enum"></a>enum QAlphaTest::<span class="name">AlphaFunction</span></h3> <p>Enumeration for the alpha 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::QAlphaTest::Never</code></td><td class="topAlign tblval"><code>0x0200</code></td><td class="topAlign">Never pass alpha test</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QAlphaTest::Always</code></td><td class="topAlign tblval"><code>0x0207</code></td><td class="topAlign">Always pass alpha test</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QAlphaTest::Less</code></td><td class="topAlign tblval"><code>0x0201</code></td><td class="topAlign">Pass alpha test if fragment alpha is less than reference value</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QAlphaTest::LessOrEqual</code></td><td class="topAlign tblval"><code>0x0203</code></td><td class="topAlign">Pass alpha test if fragment alpha is less than or equal to reference value</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QAlphaTest::Equal</code></td><td class="topAlign tblval"><code>0x0202</code></td><td class="topAlign">Pass alpha test if fragment alpha is equal to reference value</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QAlphaTest::GreaterOrEqual</code></td><td class="topAlign tblval"><code>0x0206</code></td><td class="topAlign">Pass alpha test if fragment alpha is greater than or equal to reference value</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QAlphaTest::Greater</code></td><td class="topAlign tblval"><code>0x0204</code></td><td class="topAlign">Pass alpha test if fragment alpha is greater than reference value</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QAlphaTest::NotEqual</code></td><td class="topAlign tblval"><code>0x0205</code></td><td class="topAlign">Pass alpha test if fragment alpha is not equal to reference value</td></tr> </table></div> <!-- @@@AlphaFunction --> </div> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$alphaFunction-prop$$$alphaFunction$$$setAlphaFunctionAlphaFunction$$$alphaFunctionChangedAlphaFunction --> <h3 class="fn" id="alphaFunction-prop"><a name="alphaFunction-prop"></a><span class="name">alphaFunction</span> : <span class="type"><a href="qt3drender-qalphatest.html#AlphaFunction-enum">AlphaFunction</a></span></h3> <p>Holds the alpha function used by the alpha test. Default is Never.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> AlphaFunction </td><td class="memItemRight bottomAlign"><span class="name"><b>alphaFunction</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setAlphaFunction</b></span>(AlphaFunction <i>alphaFunction</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>alphaFunctionChanged</b></span>(AlphaFunction <i>alphaFunction</i>)</td></tr> </table></div> <!-- @@@alphaFunction --> <!-- $$$referenceValue-prop$$$referenceValue$$$setReferenceValuefloat$$$referenceValueChangedfloat --> <h3 class="fn" id="referenceValue-prop"><a name="referenceValue-prop"></a><span class="name">referenceValue</span> : <span class="type">float</span></h3> <p>Holds the reference value used by the alpha test. Default is 0.0. When set, the value is clamped between 0 and 1.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> float </td><td class="memItemRight bottomAlign"><span class="name"><b>referenceValue</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setReferenceValue</b></span>(float <i>referenceValue</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>referenceValueChanged</b></span>(float <i>referenceValue</i>)</td></tr> </table></div> <!-- @@@referenceValue --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QAlphaTest[overload1]$$$QAlphaTestQt3DCore::QNode* --> <h3 class="fn" id="QAlphaTest"><a name="QAlphaTest"></a>QAlphaTest::<span class="name">QAlphaTest</span>(<span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3> <p>Default constructs an instance of QAlphaTest.</p><!-- @@@QAlphaTest --> </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>