<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qrendersettings.cpp --> <title>QRenderSettings 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 >QRenderSettings</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">QRenderSettings Class</h1> <span class="small-subtitle">(<a href="qt3drender-qrendersettings.html">Qt3DRender::QRenderSettings</a>)<br/></span> <!-- $$$QRenderSettings-brief --> <p>The <a href="qt3drender-qrendersettings.html">QRenderSettings</a> class holds settings related to rendering process and host the active <a href="qt3drender-framegraph.html">FrameGraph</a>. <a href="#details">More...</a></p> <!-- @@@QRenderSettings --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QRenderSettings></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-rendersettings.html">RenderSettings</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3dcore-qcomponent.html">Qt3DCore::QComponent</a></td></tr></table></div><ul> <li><a href="qt3drender-qrendersettings-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-qrendersettings.html#RenderPolicy-enum">RenderPolicy</a></b> { OnDemand, Always }</td></tr> </table></div> <a name="properties"></a> <h2 id="properties">Properties</h2> <ul> <li class="fn"><b><a href="qt3drender-qrendersettings.html#activeFrameGraph-prop">activeFrameGraph</a></b> : Qt3DRender::QFrameGraphNode *</li> <li class="fn"><b><a href="qt3drender-qrendersettings.html#pickingSettings-prop">pickingSettings</a></b> : Qt3DRender::QPickingSettings * const</li> <li class="fn"><b><a href="qt3drender-qrendersettings.html#renderPolicy-prop">renderPolicy</a></b> : RenderPolicy</li> </ul> <ul> <li class="fn">1 property inherited from <a href="qt3dcore-qcomponent.html#properties">Qt3DCore::QComponent</a></li> <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-qrendersettings.html#QRenderSettings">QRenderSettings</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QFrameGraphNode *</td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrendersettings.html#activeFrameGraph-prop">activeFrameGraph</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QPickingSettings *</td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrendersettings.html#pickingSettings-prop">pickingSettings</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> RenderPolicy </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrendersettings.html#renderPolicy-prop">renderPolicy</a></b>() const</td></tr> </table></div> <ul> <li class="fn">2 public functions inherited from <a href="qt3dcore-qcomponent.html#public-functions">Qt3DCore::QComponent</a></li> <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-qrendersettings.html#activeFrameGraph-prop">setActiveFrameGraph</a></b>(QFrameGraphNode *<i>activeFrameGraph</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrendersettings.html#renderPolicy-prop">setRenderPolicy</a></b>(RenderPolicy <i>renderPolicy</i>)</td></tr> </table></div> <ul> <li class="fn">1 public slot inherited from <a href="qt3dcore-qcomponent.html#public-slots">Qt3DCore::QComponent</a></li> <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-qrendersettings.html#activeFrameGraph-prop">activeFrameGraphChanged</a></b>(QFrameGraphNode *<i>activeFrameGraph</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qrendersettings.html#renderPolicy-prop">renderPolicyChanged</a></b>(RenderPolicy <i>renderPolicy</i>)</td></tr> </table></div> <ul> <li class="fn">3 signals inherited from <a href="qt3dcore-qcomponent.html#signals">Qt3DCore::QComponent</a></li> <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> <!-- $$$QRenderSettings-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qt3drender-qrendersettings.html">QRenderSettings</a> class holds settings related to rendering process and host the active <a href="qt3drender-framegraph.html">FrameGraph</a>.</p> <p>The <a href="qt3drender-qrendersettings.html">QRenderSettings</a> component must be set as a component of the scene root entity. It specifies render policy and picking settings, as well as hosts the active <a href="qt3drender-framegraph.html">FrameGraph</a>.</p> </div> <!-- @@@QRenderSettings --> <div class="types"> <h2>Member Type Documentation</h2> <!-- $$$RenderPolicy$$$OnDemand$$$Always --> <h3 class="fn" id="RenderPolicy-enum"><a name="RenderPolicy-enum"></a>enum QRenderSettings::<span class="name">RenderPolicy</span></h3> <p>The render policy.</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::QRenderSettings::OnDemand</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The <a href="qt3drender-framegraph.html">FrameGraph</a> is rendered only when something changes.</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QRenderSettings::Always</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The <a href="qt3drender-framegraph.html">FrameGraph</a> is rendered continuously, even if nothing has changed.</td></tr> </table></div> <!-- @@@RenderPolicy --> </div> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$activeFrameGraph-prop$$$activeFrameGraph$$$setActiveFrameGraphQFrameGraphNode*$$$activeFrameGraphChangedQFrameGraphNode* --> <h3 class="fn" id="activeFrameGraph-prop"><a name="activeFrameGraph-prop"></a><span class="name">activeFrameGraph</span> : <span class="type">Qt3DRender::QFrameGraphNode</span> *</h3> <p>Holds the currently active <a href="qt3drender-framegraph.html">FrameGraph</a>.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QFrameGraphNode *</td><td class="memItemRight bottomAlign"><span class="name"><b>activeFrameGraph</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setActiveFrameGraph</b></span>(QFrameGraphNode *<i>activeFrameGraph</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>activeFrameGraphChanged</b></span>(QFrameGraphNode *<i>activeFrameGraph</i>)</td></tr> </table></div> <!-- @@@activeFrameGraph --> <!-- $$$pickingSettings-prop$$$pickingSettings --> <h3 class="fn" id="pickingSettings-prop"><a name="pickingSettings-prop"></a><span class="name">pickingSettings</span> : <span class="type">Qt3DRender::QPickingSettings</span> * const</h3> <p>Holds the current pick settings for the <a href="qt3drender-framegraph.html">FrameGraph</a>.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QPickingSettings *</td><td class="memItemRight bottomAlign"><span class="name"><b>pickingSettings</b></span>()</td></tr> </table></div> <!-- @@@pickingSettings --> <!-- $$$renderPolicy-prop$$$renderPolicy$$$setRenderPolicyRenderPolicy$$$renderPolicyChangedRenderPolicy --> <h3 class="fn" id="renderPolicy-prop"><a name="renderPolicy-prop"></a><span class="name">renderPolicy</span> : <span class="type"><a href="qt3drender-qrendersettings.html#RenderPolicy-enum">RenderPolicy</a></span></h3> <p>Holds the current render policy.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> RenderPolicy </td><td class="memItemRight bottomAlign"><span class="name"><b>renderPolicy</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setRenderPolicy</b></span>(RenderPolicy <i>renderPolicy</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>renderPolicyChanged</b></span>(RenderPolicy <i>renderPolicy</i>)</td></tr> </table></div> <!-- @@@renderPolicy --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QRenderSettings[overload1]$$$QRenderSettingsQt3DCore::QNode* --> <h3 class="fn" id="QRenderSettings"><a name="QRenderSettings"></a>QRenderSettings::<span class="name">QRenderSettings</span>(<span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3> <p>Default constructs an instance of QRenderSettings.</p><!-- @@@QRenderSettings --> </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>