<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qcolormask.cpp --> <title>QColorMask Class | Qt 3D 5.12.6</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 >QColorMask</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right"><a href="qt3d-index.html">Qt 5.12.6 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="#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">QColorMask Class</h1> <span class="small-subtitle">(<a href="qt3drender-qcolormask.html">Qt3DRender::QColorMask</a>)<br/></span> <!-- $$$QColorMask-brief --> <p>Allows specifying which color components should be written to the currently bound frame buffer. <a href="#details">More...</a></p> <!-- @@@QColorMask --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QColorMask></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-colormask.html">ColorMask</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-qcolormask-members.html">List of all members, including inherited members</a></li> </ul> <a name="properties"></a> <h2 id="properties">Properties</h2> <ul> <li class="fn"><b><a href="qt3drender-qcolormask.html#alphaMasked-prop">alphaMasked</a></b> : bool</li> <li class="fn"><b><a href="qt3drender-qcolormask.html#blueMasked-prop">blueMasked</a></b> : bool</li> <li class="fn"><b><a href="qt3drender-qcolormask.html#greenMasked-prop">greenMasked</a></b> : bool</li> <li class="fn"><b><a href="qt3drender-qcolormask.html#redMasked-prop">redMasked</a></b> : bool</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-qcolormask.html#QColorMask">QColorMask</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qcolormask.html#alphaMasked-prop">isAlphaMasked</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qcolormask.html#blueMasked-prop">isBlueMasked</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qcolormask.html#greenMasked-prop">isGreenMasked</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qcolormask.html#redMasked-prop">isRedMasked</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-qcolormask.html#alphaMasked-prop">setAlphaMasked</a></b>(bool <i>alphaMasked</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qcolormask.html#blueMasked-prop">setBlueMasked</a></b>(bool <i>blueMasked</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qcolormask.html#greenMasked-prop">setGreenMasked</a></b>(bool <i>greenMasked</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qcolormask.html#redMasked-prop">setRedMasked</a></b>(bool <i>redMasked</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-qcolormask.html#alphaMasked-prop">alphaMaskedChanged</a></b>(bool <i>alphaMasked</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qcolormask.html#blueMasked-prop">blueMaskedChanged</a></b>(bool <i>blueMasked</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qcolormask.html#greenMasked-prop">greenMaskedChanged</a></b>(bool <i>greenMasked</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qcolormask.html#redMasked-prop">redMaskedChanged</a></b>(bool <i>redMasked</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-qcolormask.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> <!-- $$$QColorMask-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>Allows specifying which color components should be written to the currently bound frame buffer.</p> <p>By default, the property for each color component (red, green, blue, alpha) is set to <code>true</code> which means they will be written to the frame buffer. Setting any of the color component to <code>false</code> will prevent it from being written into the frame buffer.</p> </div> <!-- @@@QColorMask --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$alphaMasked-prop$$$isAlphaMasked$$$setAlphaMaskedbool$$$alphaMaskedChangedbool --> <h3 class="fn" id="alphaMasked-prop"><a name="alphaMasked-prop"></a><span class="name">alphaMasked</span> : <span class="type">bool</span></h3> <p>Holds whether the alphaMasked component should be written to the frame buffer.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isAlphaMasked</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setAlphaMasked</b></span>(bool <i>alphaMasked</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>alphaMaskedChanged</b></span>(bool <i>alphaMasked</i>)</td></tr> </table></div> <!-- @@@alphaMasked --> <!-- $$$blueMasked-prop$$$isBlueMasked$$$setBlueMaskedbool$$$blueMaskedChangedbool --> <h3 class="fn" id="blueMasked-prop"><a name="blueMasked-prop"></a><span class="name">blueMasked</span> : <span class="type">bool</span></h3> <p>Holds whether the blue color component should be written to the frame buffer.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isBlueMasked</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setBlueMasked</b></span>(bool <i>blueMasked</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>blueMaskedChanged</b></span>(bool <i>blueMasked</i>)</td></tr> </table></div> <!-- @@@blueMasked --> <!-- $$$greenMasked-prop$$$isGreenMasked$$$setGreenMaskedbool$$$greenMaskedChangedbool --> <h3 class="fn" id="greenMasked-prop"><a name="greenMasked-prop"></a><span class="name">greenMasked</span> : <span class="type">bool</span></h3> <p>Holds whether the green color component should be written to the frame buffer.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isGreenMasked</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setGreenMasked</b></span>(bool <i>greenMasked</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>greenMaskedChanged</b></span>(bool <i>greenMasked</i>)</td></tr> </table></div> <!-- @@@greenMasked --> <!-- $$$redMasked-prop$$$isRedMasked$$$setRedMaskedbool$$$redMaskedChangedbool --> <h3 class="fn" id="redMasked-prop"><a name="redMasked-prop"></a><span class="name">redMasked</span> : <span class="type">bool</span></h3> <p>Holds whether the red color component should be written to the frame buffer.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isRedMasked</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setRedMasked</b></span>(bool <i>redMasked</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>redMaskedChanged</b></span>(bool <i>redMasked</i>)</td></tr> </table></div> <!-- @@@redMasked --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QColorMask[overload1]$$$QColorMaskQt3DCore::QNode* --> <h3 class="fn" id="QColorMask"><a name="QColorMask"></a>QColorMask::<span class="name">QColorMask</span>(<span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3> <p>Constructs a new Qt3DCore::QColorMask instance with <i>parent</i> as parent.</p> <!-- @@@QColorMask --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</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>