<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qstenciltestarguments.cpp --> <title>QStencilTestArguments 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 >QStencilTestArguments</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">QStencilTestArguments Class</h1> <span class="small-subtitle">(<a href="qt3drender-qstenciltestarguments.html">Qt3DRender::QStencilTestArguments</a>)<br/></span> <!-- $$$QStencilTestArguments-brief --> <p>The <a href="qt3drender-qstenciltestarguments.html">QStencilTestArguments</a> class specifies arguments for stencil test <a href="#details">More...</a></p> <!-- @@@QStencilTestArguments --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QStencilTestArguments></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-stenciltestarguments.html">StencilTestArguments</a></td></tr></table></div><ul> <li><a href="qt3drender-qstenciltestarguments-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-qstenciltestarguments.html#StencilFaceMode-enum">StencilFaceMode</a></b> { Front, Back, FrontAndBack }</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciltestarguments.html#StencilFunction-enum">StencilFunction</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-qstenciltestarguments.html#comparisonMask-prop">comparisonMask</a></b> : uint</li> <li class="fn"><b><a href="qt3drender-qstenciltestarguments.html#faceMode-prop">faceMode</a></b> : const StencilFaceMode</li> <li class="fn"><b><a href="qt3drender-qstenciltestarguments.html#referenceValue-prop">referenceValue</a></b> : int</li> <li class="fn"><b><a href="qt3drender-qstenciltestarguments.html#stencilFunction-prop">stencilFunction</a></b> : StencilFunction</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"> uint </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciltestarguments.html#comparisonMask-prop">comparisonMask</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> StencilFaceMode </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciltestarguments.html#faceMode-prop">faceMode</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciltestarguments.html#referenceValue-prop">referenceValue</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> StencilFunction </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciltestarguments.html#stencilFunction-prop">stencilFunction</a></b>() const</td></tr> </table></div> <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-qstenciltestarguments.html#comparisonMask-prop">setComparisonMask</a></b>(uint <i>comparisonMask</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciltestarguments.html#referenceValue-prop">setReferenceValue</a></b>(int <i>referenceValue</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciltestarguments.html#stencilFunction-prop">setStencilFunction</a></b>(StencilFunction <i>stencilFunction</i>)</td></tr> </table></div> <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-qstenciltestarguments.html#comparisonMask-prop">comparisonMaskChanged</a></b>(uint <i>comparisonMask</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciltestarguments.html#faceMode-prop">faceModeChanged</a></b>(StencilFaceMode <i>faceMode</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciltestarguments.html#referenceValue-prop">referenceValueChanged</a></b>(int <i>referenceValue</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciltestarguments.html#stencilFunction-prop">stencilFunctionChanged</a></b>(StencilFunction <i>stencilFunction</i>)</td></tr> </table></div> <a name="details"></a> <!-- $$$QStencilTestArguments-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qt3drender-qstenciltestarguments.html">QStencilTestArguments</a> class specifies arguments for stencil test</p> <p>The <a href="qt3drender-qstenciltestarguments.html">Qt3DRender::QStencilTestArguments</a> class specifies the arguments for the stencil test.</p> </div> <!-- @@@QStencilTestArguments --> <div class="types"> <h2>Member Type Documentation</h2> <!-- $$$StencilFaceMode$$$Front$$$Back$$$FrontAndBack --> <h3 class="fn" id="StencilFaceMode-enum"><a name="StencilFaceMode-enum"></a>enum QStencilTestArguments::<span class="name">StencilFaceMode</span></h3> <p>This enumeration holds the values for stencil test arguments face modes</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::QStencilTestArguments::Front</code></td><td class="topAlign tblval"><code>0x0404</code></td><td class="topAlign">Arguments are applied to front-facing polygons.</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QStencilTestArguments::Back</code></td><td class="topAlign tblval"><code>0x0405</code></td><td class="topAlign">Arguments are applied to back-facing polygons.</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QStencilTestArguments::FrontAndBack</code></td><td class="topAlign tblval"><code>0x0408</code></td><td class="topAlign">Arguments are applied to both front- and back-facing polygons.</td></tr> </table></div> <!-- @@@StencilFaceMode --> <!-- $$$StencilFunction$$$Never$$$Always$$$Less$$$LessOrEqual$$$Equal$$$GreaterOrEqual$$$Greater$$$NotEqual --> <h3 class="fn" id="StencilFunction-enum"><a name="StencilFunction-enum"></a>enum QStencilTestArguments::<span class="name">StencilFunction</span></h3> <p>Enumeration for the stencil 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::QStencilTestArguments::Never</code></td><td class="topAlign tblval"><code>0x0200</code></td><td class="topAlign">Never pass stencil test</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QStencilTestArguments::Always</code></td><td class="topAlign tblval"><code>0x0207</code></td><td class="topAlign">Always pass stencil test</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QStencilTestArguments::Less</code></td><td class="topAlign tblval"><code>0x0201</code></td><td class="topAlign">Pass stencil test if fragment stencil is less than reference value</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QStencilTestArguments::LessOrEqual</code></td><td class="topAlign tblval"><code>0x0203</code></td><td class="topAlign">Pass stencil test if fragment stencil is less than or equal to reference value</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QStencilTestArguments::Equal</code></td><td class="topAlign tblval"><code>0x0202</code></td><td class="topAlign">Pass stencil test if fragment stencil is equal to reference value</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QStencilTestArguments::GreaterOrEqual</code></td><td class="topAlign tblval"><code>0x0206</code></td><td class="topAlign">Pass stencil test if fragment stencil is greater than or equal to reference value</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QStencilTestArguments::Greater</code></td><td class="topAlign tblval"><code>0x0204</code></td><td class="topAlign">Pass stencil test if fragment stencil is greater than reference value</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QStencilTestArguments::NotEqual</code></td><td class="topAlign tblval"><code>0x0205</code></td><td class="topAlign">Pass stencil test if fragment stencil is not equal to reference value</td></tr> </table></div> <!-- @@@StencilFunction --> </div> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$comparisonMask-prop$$$comparisonMask$$$setComparisonMaskuint$$$comparisonMaskChangeduint --> <h3 class="fn" id="comparisonMask-prop"><a name="comparisonMask-prop"></a><span class="name">comparisonMask</span> : <span class="type">uint</span></h3> <p>Holds the stencil test comparison mask. Default is all zeroes.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> uint </td><td class="memItemRight bottomAlign"><span class="name"><b>comparisonMask</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setComparisonMask</b></span>(uint <i>comparisonMask</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>comparisonMaskChanged</b></span>(uint <i>comparisonMask</i>)</td></tr> </table></div> <!-- @@@comparisonMask --> <!-- $$$faceMode-prop$$$faceMode$$$faceModeChangedStencilFaceMode --> <h3 class="fn" id="faceMode-prop"><a name="faceMode-prop"></a><span class="name">faceMode</span> : const <span class="type"><a href="qt3drender-qstenciltestarguments.html#StencilFaceMode-enum">StencilFaceMode</a></span></h3> <p>Holds the faces the arguments are applied to.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> StencilFaceMode </td><td class="memItemRight bottomAlign"><span class="name"><b>faceMode</b></span>() const</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>faceModeChanged</b></span>(StencilFaceMode <i>faceMode</i>)</td></tr> </table></div> <!-- @@@faceMode --> <!-- $$$referenceValue-prop$$$referenceValue$$$setReferenceValueint$$$referenceValueChangedint --> <h3 class="fn" id="referenceValue-prop"><a name="referenceValue-prop"></a><span class="name">referenceValue</span> : <span class="type">int</span></h3> <p>Holds the stencil test reference value. Default is zero.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> int </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>(int <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>(int <i>referenceValue</i>)</td></tr> </table></div> <!-- @@@referenceValue --> <!-- $$$stencilFunction-prop$$$stencilFunction$$$setStencilFunctionStencilFunction$$$stencilFunctionChangedStencilFunction --> <h3 class="fn" id="stencilFunction-prop"><a name="stencilFunction-prop"></a><span class="name">stencilFunction</span> : <span class="type"><a href="qt3drender-qstenciltestarguments.html#StencilFunction-enum">StencilFunction</a></span></h3> <p>Holds the stencil test function. Default is Never.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> StencilFunction </td><td class="memItemRight bottomAlign"><span class="name"><b>stencilFunction</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setStencilFunction</b></span>(StencilFunction <i>stencilFunction</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>stencilFunctionChanged</b></span>(StencilFunction <i>stencilFunction</i>)</td></tr> </table></div> <p><b>See also </b><a href="qt3drender-qstenciltestarguments.html#StencilFunction-enum">Qt3DRender::QStencilTestArguments::StencilFunction</a>.</p> <!-- @@@stencilFunction --> </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>