<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qrenderpassfilter.cpp --> <title>QRenderPassFilter 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 >QRenderPassFilter</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-functions">Public Functions</a></li> <li class="level1"><a href="#protected-functions">Protected Functions</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">QRenderPassFilter Class</h1> <span class="small-subtitle">(<a href="qt3drender-qrenderpassfilter.html">Qt3DRender::QRenderPassFilter</a>)<br/></span> <!-- $$$QRenderPassFilter-brief --> <p>Provides storage for vectors of Filter Keys and Parameters <a href="#details">More...</a></p> <!-- @@@QRenderPassFilter --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QRenderPassFilter></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-renderpassfilter.html">RenderPassFilter</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3drender-qframegraphnode.html">Qt3DRender::QFrameGraphNode</a></td></tr></table></div><ul> <li><a href="qt3drender-qrenderpassfilter-members.html">List of all members, including inherited members</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-qrenderpassfilter.html#QRenderPassFilter">QRenderPassFilter</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrenderpassfilter.html#addMatch">addMatch</a></b>(QFilterKey *<i>filterKey</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrenderpassfilter.html#addParameter">addParameter</a></b>(QParameter *<i>parameter</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QVector<QFilterKey *> </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrenderpassfilter.html#matchAny">matchAny</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QVector<QParameter *> </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrenderpassfilter.html#parameters">parameters</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrenderpassfilter.html#removeMatch">removeMatch</a></b>(QFilterKey *<i>filterKey</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrenderpassfilter.html#removeParameter">removeParameter</a></b>(QParameter *<i>parameter</i>)</td></tr> </table></div> <ul> <li class="fn">1 public function inherited from <a href="qt3drender-qframegraphnode.html#public-functions">Qt3DRender::QFrameGraphNode</a></li> <li class="fn">11 public functions inherited from <a href="qt3dcore-qnode.html#public-functions">Qt3DCore::QNode</a></li> </ul> <a name="protected-functions"></a> <h2 id="protected-functions">Protected Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrenderpassfilter.html#QRenderPassFilter-1">QRenderPassFilter</a></b>(QRenderPassFilterPrivate &<i>dd</i>, Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> </table></div> <ul> <li class="fn">1 protected function inherited from <a href="qt3drender-qframegraphnode.html#protected-functions">Qt3DRender::QFrameGraphNode</a></li> <li class="fn">2 protected functions inherited from <a href="qt3dcore-qnode.html#protected-functions">Qt3DCore::QNode</a></li> </ul> <h3>Additional Inherited Members</h3> <ul> <li class="fn">3 properties inherited from <a href="qt3dcore-qnode.html#properties">Qt3DCore::QNode</a></li> <li class="fn">3 public slots inherited from <a href="qt3dcore-qnode.html#public-slots">Qt3DCore::QNode</a></li> <li class="fn">4 signals inherited from <a href="qt3dcore-qnode.html#signals">Qt3DCore::QNode</a></li> </ul> <a name="details"></a> <!-- $$$QRenderPassFilter-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>Provides storage for vectors of Filter Keys and Parameters</p> <p>A <a href="qt3drender-qrenderpassfilter.html">Qt3DRender::QRenderPassFilter</a> FrameGraph node is used to select which <a href="qt3drender-qrenderpass.html">Qt3DRender::QRenderPass</a> objects are selected for drawing. <a href="qt3drender-qrenderpassfilter.html">QRenderPassFilter</a> specifies a list of <a href="qt3drender-qfilterkey.html">Qt3DRender::QFilterKey</a> objects and <a href="qt3drender-qparameter.html">Qt3DRender::QParameter</a> objects. When <a href="qt3drender-qrenderpassfilter.html">QRenderPassFilter</a> is present in the FrameGraph, only the <a href="qt3drender-qrenderpass.html">QRenderPass</a> objects, whose <a href="qt3drender-qfilterkey.html">Qt3DRender::QFilterKey</a> objects match the keys in <a href="qt3drender-qrenderpassfilter.html">QRenderPassFilter</a> are selected for rendering. If no <a href="qt3drender-qrenderpassfilter.html">QRenderPassFilter</a> is present, then all <a href="qt3drender-qrenderpass.html">QRenderPass</a> objects are selected for rendering. The parameters in the list can be used to set values for shader parameters. The parameters in <a href="qt3drender-qrenderpassfilter.html">QRenderPassFilter</a> are overridden by parameters in <a href="qt3drender-qtechniquefilter.html">QTechniqueFilter</a>, <a href="qt3drender-qtechnique.html">QTechnique</a> and <a href="qt3drender-qrenderpass.html">QRenderPass</a>.</p> </div> <!-- @@@QRenderPassFilter --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QRenderPassFilter[overload1]$$$QRenderPassFilterQt3DCore::QNode* --> <h3 class="fn" id="QRenderPassFilter"><a name="QRenderPassFilter"></a>QRenderPassFilter::<span class="name">QRenderPassFilter</span>(<span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3> <p>Default constructs an instance of QRenderPassFilter.</p><!-- @@@QRenderPassFilter --> <!-- $$$QRenderPassFilter$$$QRenderPassFilterQRenderPassFilterPrivate&Qt3DCore::QNode* --> <h3 class="fn" id="QRenderPassFilter-1"><a name="QRenderPassFilter-1"></a><code>[protected] </code>QRenderPassFilter::<span class="name">QRenderPassFilter</span>(<span class="type">QRenderPassFilterPrivate</span> &<i>dd</i>, <span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3> <p>Copy constructor.</p><!-- @@@QRenderPassFilter --> <!-- $$$addMatch[overload1]$$$addMatchQFilterKey* --> <h3 class="fn" id="addMatch"><a name="addMatch"></a><span class="type">void</span> QRenderPassFilter::<span class="name">addMatch</span>(<span class="type"><a href="qt3drender-qfilterkey.html">QFilterKey</a></span> *<i>filterKey</i>)</h3> <p>Add the <i>filterKey</i> to the match vector.</p> <!-- @@@addMatch --> <!-- $$$addParameter[overload1]$$$addParameterQParameter* --> <h3 class="fn" id="addParameter"><a name="addParameter"></a><span class="type">void</span> QRenderPassFilter::<span class="name">addParameter</span>(<span class="type"><a href="qt3drender-qparameter.html">QParameter</a></span> *<i>parameter</i>)</h3> <p>Add the given <i>parameter</i> to the parameter vector.</p> <!-- @@@addParameter --> <!-- $$$matchAny[overload1]$$$matchAny --> <h3 class="fn" id="matchAny"><a name="matchAny"></a><span class="type">QVector</span><<span class="type"><a href="qt3drender-qfilterkey.html">QFilterKey</a></span> *> QRenderPassFilter::<span class="name">matchAny</span>() const</h3> <p>Returns a vector of the current keys for the filter.</p> <!-- @@@matchAny --> <!-- $$$parameters[overload1]$$$parameters --> <h3 class="fn" id="parameters"><a name="parameters"></a><span class="type">QVector</span><<span class="type"><a href="qt3drender-qparameter.html">QParameter</a></span> *> QRenderPassFilter::<span class="name">parameters</span>() const</h3> <p>Returns the current vector of parameters.</p> <!-- @@@parameters --> <!-- $$$removeMatch[overload1]$$$removeMatchQFilterKey* --> <h3 class="fn" id="removeMatch"><a name="removeMatch"></a><span class="type">void</span> QRenderPassFilter::<span class="name">removeMatch</span>(<span class="type"><a href="qt3drender-qfilterkey.html">QFilterKey</a></span> *<i>filterKey</i>)</h3> <p>Remove the <i>filterKey</i> from the match vector.</p> <!-- @@@removeMatch --> <!-- $$$removeParameter[overload1]$$$removeParameterQParameter* --> <h3 class="fn" id="removeParameter"><a name="removeParameter"></a><span class="type">void</span> QRenderPassFilter::<span class="name">removeParameter</span>(<span class="type"><a href="qt3drender-qparameter.html">QParameter</a></span> *<i>parameter</i>)</h3> <p>Remove the given <i>parameter</i> from the parameter vector.</p> <!-- @@@removeParameter --> </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>