<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qskyboxentity.cpp --> <title>QSkyboxEntity Class | Qt 3D 5.11</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 ><a href="../qtdoc/index.html">Qt 5.11</a></td><td ><a href="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-cpp.html">C++ Classes</a></td><td >QSkyboxEntity</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right">Qt 5.11.2 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="#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">QSkyboxEntity Class</h1> <span class="small-subtitle">(<a href="qt3dextras-qskyboxentity.html">Qt3DExtras::QSkyboxEntity</a>)<br/></span> <!-- $$$QSkyboxEntity-brief --> <p><a href="qt3dextras-qskyboxentity.html">Qt3DExtras::QSkyboxEntity</a> is a convenience <a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a> subclass that can be used to insert a skybox in a 3D scene. <a href="#details">More...</a></p> <!-- @@@QSkyboxEntity --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <Qt3DExtras/QSkyboxEntity></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += 3dextras</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.5</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a></td></tr></table></div><ul> <li><a href="qt3dextras-qskyboxentity-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="qt3dextras-qskyboxentity.html#baseName-prop">baseName</a></b> : QString</li> <li class="fn"><b><a href="qt3dextras-qskyboxentity.html#extension-prop">extension</a></b> : QString</li> <li class="fn"><b><a href="qt3dextras-qskyboxentity.html#gammaCorrect-prop">gammaCorrect</a></b> : bool</li> </ul> <ul> <li class="fn">3 properties inherited from <a href="qt3dcore-qnode.html#properties">Qt3DCore::QNode</a></li> <li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</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="qt3dextras-qskyboxentity.html#QSkyboxEntity">QSkyboxEntity</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qskyboxentity.html#baseName">baseName</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qskyboxentity.html#extension">extension</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qskyboxentity.html#isGammaCorrectEnabled">isGammaCorrectEnabled</a></b>() const</td></tr> </table></div> <ul> <li class="fn">4 public functions inherited from <a href="qt3dcore-qentity.html#public-functions">Qt3DCore::QEntity</a></li> <li class="fn">13 public functions inherited from <a href="qt3dcore-qnode.html#public-functions">Qt3DCore::QNode</a></li> <li class="fn">34 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</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="qt3dextras-qskyboxentity.html#setBaseName">setBaseName</a></b>(const QString &<i>baseName</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qskyboxentity.html#setExtension">setExtension</a></b>(const QString &<i>extension</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qskyboxentity.html#setGammaCorrectEnabled">setGammaCorrectEnabled</a></b>(bool <i>enabled</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> <li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</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="qt3dextras-qskyboxentity.html#baseName-prop">baseNameChanged</a></b>(const QString &<i>path</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qskyboxentity.html#extension-prop">extensionChanged</a></b>(const QString &<i>extension</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qskyboxentity.html#gammaCorrect-prop">gammaCorrectEnabledChanged</a></b>(bool <i>enabled</i>)</td></tr> </table></div> <ul> <li class="fn">4 signals inherited from <a href="qt3dcore-qnode.html#signals">Qt3DCore::QNode</a></li> <li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li> </ul> <h3>Additional Inherited Members</h3> <ul> <li class="fn">1 public variable inherited from <a href="../qtcore/qobject.html#public-variables">QObject</a></li> <li class="fn">10 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li> <li class="fn">2 protected functions inherited from <a href="qt3dcore-qnode.html#protected-functions">Qt3DCore::QNode</a></li> <li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li> <li class="fn">2 protected variables inherited from <a href="../qtcore/qobject.html#protected-variables">QObject</a></li> </ul> <a name="details"></a> <!-- $$$QSkyboxEntity-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p><a href="qt3dextras-qskyboxentity.html">Qt3DExtras::QSkyboxEntity</a> is a convenience <a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a> subclass that can be used to insert a skybox in a 3D scene.</p> <p>By specifying a base name and an extension, <a href="qt3dextras-qskyboxentity.html">Qt3DExtras::QSkyboxEntity</a> will take care of building a TextureCubeMap to be rendered at runtime. The images in the source directory should match the pattern: <b>base</b> name + * "_posx|_posy|_posz|_negx|_negy|_negz" + extension</p> <p>By default the extension defaults to .png.</p> <p>Be sure to disable frustum culling in the FrameGraph through which the skybox rendering happens.</p> <p><b>Note: </b>Please note that you shouldn't try to render a skybox with an orthographic projection.</p></div> <!-- @@@QSkyboxEntity --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$baseName-prop$$$baseName$$$setBaseNameconstQString&$$$baseNameChangedconstQString& --> <h3 class="fn" id="baseName-prop"><a name="baseName-prop"></a><span class="name">baseName</span> : <span class="type"><a href="../qtcore/qstring.html">QString</a></span></h3> <p>Contains the base name of the Skybox.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3dextras-qskyboxentity.html#baseName">baseName</a></b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3dextras-qskyboxentity.html#setBaseName">setBaseName</a></b></span>(const QString &<i>baseName</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>baseNameChanged</b></span>(const QString &<i>path</i>)</td></tr> </table></div> <!-- @@@baseName --> <!-- $$$extension-prop$$$extension$$$setExtensionconstQString&$$$extensionChangedconstQString& --> <h3 class="fn" id="extension-prop"><a name="extension-prop"></a><span class="name">extension</span> : <span class="type"><a href="../qtcore/qstring.html">QString</a></span></h3> <p>Contains the extension of the Skybox.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3dextras-qskyboxentity.html#extension">extension</a></b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3dextras-qskyboxentity.html#setExtension">setExtension</a></b></span>(const QString &<i>extension</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>extensionChanged</b></span>(const QString &<i>extension</i>)</td></tr> </table></div> <!-- @@@extension --> <!-- $$$gammaCorrect-prop$$$isGammaCorrectEnabled$$$setGammaCorrectEnabledbool$$$gammaCorrectEnabledChangedbool --> <h3 class="fn" id="gammaCorrect-prop"><a name="gammaCorrect-prop"></a><span class="name">gammaCorrect</span> : <span class="type">bool</span></h3> <p>A boolean indicating whether gamma correction is enabled.</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><a href="qt3dextras-qskyboxentity.html#isGammaCorrectEnabled">isGammaCorrectEnabled</a></b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3dextras-qskyboxentity.html#setGammaCorrectEnabled">setGammaCorrectEnabled</a></b></span>(bool <i>enabled</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>gammaCorrectEnabledChanged</b></span>(bool <i>enabled</i>)</td></tr> </table></div> <!-- @@@gammaCorrect --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QSkyboxEntity[overload1]$$$QSkyboxEntityQt3DCore::QNode* --> <h3 class="fn" id="QSkyboxEntity"><a name="QSkyboxEntity"></a>QSkyboxEntity::<span class="name">QSkyboxEntity</span>(<span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3> <p>Constructs a new <a href="qt3dextras-qskyboxentity.html">Qt3DExtras::QSkyboxEntity</a> object with <i>parent</i> as parent.</p> <!-- @@@QSkyboxEntity --> <!-- $$$baseName --> <h3 class="fn" id="baseName"><a name="baseName"></a><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QSkyboxEntity::<span class="name">baseName</span>() const</h3> <p>Returns the base name of the Skybox.</p> <p><b>Note:</b> Getter function for property <a href="qt3dextras-qskyboxentity.html#baseName-prop">baseName</a>. </p><p><b>See also </b><a href="qt3dextras-qskyboxentity.html#setBaseName">setBaseName</a>().</p> <!-- @@@baseName --> <!-- $$$extension --> <h3 class="fn" id="extension"><a name="extension"></a><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QSkyboxEntity::<span class="name">extension</span>() const</h3> <p>Returns the extension</p> <p><b>Note:</b> Getter function for property <a href="qt3dextras-qskyboxentity.html#extension-prop">extension</a>. </p><p><b>See also </b><a href="qt3dextras-qskyboxentity.html#setExtension">setExtension</a>().</p> <!-- @@@extension --> <!-- $$$isGammaCorrectEnabled --> <h3 class="fn" id="isGammaCorrectEnabled"><a name="isGammaCorrectEnabled"></a><span class="type">bool</span> QSkyboxEntity::<span class="name">isGammaCorrectEnabled</span>() const</h3> <p>Returns true if gamma correction is enabled for this skybox.</p> <p>This function was introduced in Qt 5.9.</p> <p><b>Note:</b> Getter function for property <a href="qt3dextras-qskyboxentity.html#gammaCorrect-prop">gammaCorrect</a>. </p><!-- @@@isGammaCorrectEnabled --> <!-- $$$setBaseName --> <h3 class="fn" id="setBaseName"><a name="setBaseName"></a><code>[slot] </code><span class="type">void</span> QSkyboxEntity::<span class="name">setBaseName</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i>baseName</i>)</h3> <p>Sets the base name to <i>baseName</i>.</p> <p><b>Note:</b> Setter function for property <a href="qt3dextras-qskyboxentity.html#baseName-prop">baseName</a>. </p><p><b>See also </b><a href="qt3dextras-qskyboxentity.html#baseName">baseName</a>().</p> <!-- @@@setBaseName --> <!-- $$$setExtension --> <h3 class="fn" id="setExtension"><a name="setExtension"></a><code>[slot] </code><span class="type">void</span> QSkyboxEntity::<span class="name">setExtension</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i>extension</i>)</h3> <p>Sets the extension to <i>extension</i>.</p> <p><b>Note:</b> Setter function for property <a href="qt3dextras-qskyboxentity.html#extension-prop">extension</a>. </p><p><b>See also </b><a href="qt3dextras-qskyboxentity.html#extension">extension</a>().</p> <!-- @@@setExtension --> <!-- $$$setGammaCorrectEnabled --> <h3 class="fn" id="setGammaCorrectEnabled"><a name="setGammaCorrectEnabled"></a><code>[slot] </code><span class="type">void</span> QSkyboxEntity::<span class="name">setGammaCorrectEnabled</span>(<span class="type">bool</span> <i>enabled</i>)</h3> <p>Sets the gamma correction enable state to <i>enabled</i>.</p> <p>This function was introduced in Qt 5.9.</p> <p><b>Note:</b> Setter function for property <a href="qt3dextras-qskyboxentity.html#gammaCorrect-prop">gammaCorrect</a>. </p><p><b>See also </b><a href="qt3dextras-qskyboxentity.html#isGammaCorrectEnabled">isGammaCorrectEnabled</a>().</p> <!-- @@@setGammaCorrectEnabled --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2018 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>