Sophie

Sophie

distrib > Mageia > 7 > armv7hl > media > core-release > by-pkgid > c936229ef0138f42857f36beadbeda30 > files > 1109

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" />
<!-- qstenciloperationarguments.cpp -->
  <title>QStencilOperationArguments 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 >QStencilOperationArguments</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">QStencilOperationArguments Class</h1>
<span class="small-subtitle">(<a href="qt3drender-qstenciloperationarguments.html">Qt3DRender::QStencilOperationArguments</a>)<br/></span>
<!-- $$$QStencilOperationArguments-brief -->
<p>The <a href="qt3drender-qstenciloperationarguments.html">QStencilOperationArguments</a> class sets the actions to be taken when stencil and depth tests fail. <a href="#details">More...</a></p>
<!-- @@@QStencilOperationArguments -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QStencilOperationArguments&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-stenciloperationarguments.html">StencilOperationArguments</a></td></tr></table></div><ul>
<li><a href="qt3drender-qstenciloperationarguments-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-qstenciloperationarguments.html#FaceMode-enum">FaceMode</a></b> { Front, Back, FrontAndBack }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciloperationarguments.html#Operation-enum">Operation</a></b> { Zero, Keep, Replace, Increment, ..., Invert }</td></tr>
</table></div>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qt3drender-qstenciloperationarguments.html#allTestsPassOperation-prop">allTestsPassOperation</a></b> : Operation</li>
<li class="fn"><b><a href="qt3drender-qstenciloperationarguments.html#depthTestFailureOperation-prop">depthTestFailureOperation</a></b> : Operation</li>
<li class="fn"><b><a href="qt3drender-qstenciloperationarguments.html#faceMode-prop">faceMode</a></b> : const FaceMode</li>
<li class="fn"><b><a href="qt3drender-qstenciloperationarguments.html#stencilTestFailureOperation-prop">stencilTestFailureOperation</a></b> : Operation</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"> Qt3DRender::QStencilOperationArguments::Operation </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciloperationarguments.html#allTestsPassOperation-prop">allTestsPassOperation</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DRender::QStencilOperationArguments::Operation </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciloperationarguments.html#depthTestFailureOperation-prop">depthTestFailureOperation</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DRender::QStencilOperationArguments::FaceMode </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciloperationarguments.html#faceMode-prop">faceMode</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DRender::QStencilOperationArguments::Operation </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciloperationarguments.html#stencilTestFailureOperation-prop">stencilTestFailureOperation</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-qstenciloperationarguments.html#allTestsPassOperation-prop">setAllTestsPassOperation</a></b>(Qt3DRender::QStencilOperationArguments::Operation <i>operation</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciloperationarguments.html#depthTestFailureOperation-prop">setDepthTestFailureOperation</a></b>(Qt3DRender::QStencilOperationArguments::Operation <i>operation</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciloperationarguments.html#stencilTestFailureOperation-prop">setStencilTestFailureOperation</a></b>(Qt3DRender::QStencilOperationArguments::Operation <i>operation</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-qstenciloperationarguments.html#allTestsPassOperation-prop">allTestsPassOperationChanged</a></b>(Qt3DRender::QStencilOperationArguments::Operation <i>stencilDepthPass</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciloperationarguments.html#depthTestFailureOperation-prop">depthTestFailureOperationChanged</a></b>(Qt3DRender::QStencilOperationArguments::Operation <i>depthFail</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciloperationarguments.html#faceMode-prop">faceModeChanged</a></b>(Qt3DRender::QStencilOperationArguments::FaceMode <i>faceMode</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qstenciloperationarguments.html#stencilTestFailureOperation-prop">stencilTestFailureOperationChanged</a></b>(Qt3DRender::QStencilOperationArguments::Operation <i>stencilFail</i>)</td></tr>
</table></div>
<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-qstenciloperationarguments.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QStencilOperationArguments-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qt3drender-qstenciloperationarguments.html">QStencilOperationArguments</a> class sets the actions to be taken when stencil and depth tests fail.</p>
<p>The <a href="qt3drender-qstenciloperationarguments.html">Qt3DRender::QStencilOperationArguments</a> class specifies the arguments for the stencil operations.</p>
</div>
<p><b>See also </b><a href="qt3drender-qstenciloperation.html">Qt3DRender::QStencilOperation</a>.</p>
<!-- @@@QStencilOperationArguments -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$FaceMode$$$Front$$$Back$$$FrontAndBack -->
<h3 class="fn" id="FaceMode-enum"><a name="FaceMode-enum"></a>enum QStencilOperationArguments::<span class="name">FaceMode</span></h3>
<p>This enumeration holds the values for stencil operation argument 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::QStencilOperationArguments::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::QStencilOperationArguments::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::QStencilOperationArguments::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>
<!-- @@@FaceMode -->
<!-- $$$Operation$$$Zero$$$Keep$$$Replace$$$Increment$$$Decrement$$$IncrementWrap$$$DecrementWrap$$$Invert -->
<h3 class="fn" id="Operation-enum"><a name="Operation-enum"></a>enum QStencilOperationArguments::<span class="name">Operation</span></h3>
<p>This enumeration holds the values for stencil operation.</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::QStencilOperationArguments::Zero</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">Set stencil value to zero.</td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QStencilOperationArguments::Keep</code></td><td class="topAlign tblval"><code>0x1E00</code></td><td class="topAlign">Keep current stencil value.</td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QStencilOperationArguments::Replace</code></td><td class="topAlign tblval"><code>0x1E01</code></td><td class="topAlign">Replace with the masked fragment stencil value.</td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QStencilOperationArguments::Increment</code></td><td class="topAlign tblval"><code>0x1E02</code></td><td class="topAlign">Increment current value with saturation.</td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QStencilOperationArguments::Decrement</code></td><td class="topAlign tblval"><code>0x1E03</code></td><td class="topAlign">Decrement current value with saturation.</td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QStencilOperationArguments::IncrementWrap</code></td><td class="topAlign tblval"><code>0x8507</code></td><td class="topAlign">Increment current value with wrap.</td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QStencilOperationArguments::DecrementWrap</code></td><td class="topAlign tblval"><code>0x8508</code></td><td class="topAlign">Decrement current value with wrap.</td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QStencilOperationArguments::Invert</code></td><td class="topAlign tblval"><code>0x150A</code></td><td class="topAlign">Invert the current value.</td></tr>
</table></div>
<!-- @@@Operation -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$allTestsPassOperation-prop$$$allTestsPassOperation$$$setAllTestsPassOperationQt3DRender::QStencilOperationArguments::Operation$$$allTestsPassOperationChangedQt3DRender::QStencilOperationArguments::Operation -->
<h3 class="fn" id="allTestsPassOperation-prop"><a name="allTestsPassOperation-prop"></a><span class="name">allTestsPassOperation</span> : <span class="type"><a href="qt3drender-qstenciloperationarguments.html#Operation-enum">Operation</a></span></h3>
<p>Holds the stencil test operation for when depth and stencil test pass. Default is <a href="qml-qt3d-render-stenciloperationarguments.html">StencilOperationArguments</a>.Keep.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt3DRender::QStencilOperationArguments::Operation </td><td class="memItemRight bottomAlign"><span class="name"><b>allTestsPassOperation</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setAllTestsPassOperation</b></span>(Qt3DRender::QStencilOperationArguments::Operation <i>operation</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>allTestsPassOperationChanged</b></span>(Qt3DRender::QStencilOperationArguments::Operation <i>stencilDepthPass</i>)</td></tr>
</table></div>
<!-- @@@allTestsPassOperation -->
<!-- $$$depthTestFailureOperation-prop$$$depthTestFailureOperation$$$setDepthTestFailureOperationQt3DRender::QStencilOperationArguments::Operation$$$depthTestFailureOperationChangedQt3DRender::QStencilOperationArguments::Operation -->
<h3 class="fn" id="depthTestFailureOperation-prop"><a name="depthTestFailureOperation-prop"></a><span class="name">depthTestFailureOperation</span> : <span class="type"><a href="qt3drender-qstenciloperationarguments.html#Operation-enum">Operation</a></span></h3>
<p>Holds the stencil test operation for when the stencil test passes, but depth test fails. Default is <a href="qml-qt3d-render-stenciloperationarguments.html">StencilOperationArguments</a>.Keep.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt3DRender::QStencilOperationArguments::Operation </td><td class="memItemRight bottomAlign"><span class="name"><b>depthTestFailureOperation</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setDepthTestFailureOperation</b></span>(Qt3DRender::QStencilOperationArguments::Operation <i>operation</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>depthTestFailureOperationChanged</b></span>(Qt3DRender::QStencilOperationArguments::Operation <i>depthFail</i>)</td></tr>
</table></div>
<!-- @@@depthTestFailureOperation -->
<!-- $$$faceMode-prop$$$faceMode$$$faceModeChangedQt3DRender::QStencilOperationArguments::FaceMode -->
<h3 class="fn" id="faceMode-prop"><a name="faceMode-prop"></a><span class="name">faceMode</span> : const <span class="type"><a href="qt3drender-qstenciloperationarguments.html#FaceMode-enum">FaceMode</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"> Qt3DRender::QStencilOperationArguments::FaceMode </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>(Qt3DRender::QStencilOperationArguments::FaceMode <i>faceMode</i>)</td></tr>
</table></div>
<!-- @@@faceMode -->
<!-- $$$stencilTestFailureOperation-prop$$$stencilTestFailureOperation$$$setStencilTestFailureOperationQt3DRender::QStencilOperationArguments::Operation$$$stencilTestFailureOperationChangedQt3DRender::QStencilOperationArguments::Operation -->
<h3 class="fn" id="stencilTestFailureOperation-prop"><a name="stencilTestFailureOperation-prop"></a><span class="name">stencilTestFailureOperation</span> : <span class="type"><a href="qt3drender-qstenciloperationarguments.html#Operation-enum">Operation</a></span></h3>
<p>Holds the stencil test operation for when the stencil test fails. Default is <a href="qml-qt3d-render-stenciloperationarguments.html">StencilOperationArguments</a>.Keep.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt3DRender::QStencilOperationArguments::Operation </td><td class="memItemRight bottomAlign"><span class="name"><b>stencilTestFailureOperation</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setStencilTestFailureOperation</b></span>(Qt3DRender::QStencilOperationArguments::Operation <i>operation</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>stencilTestFailureOperationChanged</b></span>(Qt3DRender::QStencilOperationArguments::Operation <i>stencilFail</i>)</td></tr>
</table></div>
<!-- @@@stencilTestFailureOperation -->
</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>