<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qabstracttextureimage.cpp --> <title>QAbstractTextureImage 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 >QAbstractTextureImage</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="#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">QAbstractTextureImage Class</h1> <span class="small-subtitle">(<a href="qt3drender-qabstracttextureimage.html">Qt3DRender::QAbstractTextureImage</a>)<br/></span> <!-- $$$QAbstractTextureImage-brief --> <p>Encapsulates the necessary information to create an OpenGL texture image. <a href="#details">More...</a></p> <!-- @@@QAbstractTextureImage --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QAbstractTextureImage></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.5</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-render-abstracttextureimage.html">AbstractTextureImage</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qt3drender-qpaintedtextureimage.html">Qt3DRender::QPaintedTextureImage</a> and <a href="qt3drender-qtextureimage.html">Qt3DRender::QTextureImage</a></p> </td></tr></table></div><ul> <li><a href="qt3drender-qabstracttextureimage-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-qabstracttextureimage.html#face-prop">face</a></b> : Qt3DRender::QAbstractTexture::CubeMapFace</li> <li class="fn"><b><a href="qt3drender-qabstracttextureimage.html#layer-prop">layer</a></b> : int</li> <li class="fn"><b><a href="qt3drender-qabstracttextureimage.html#mipLevel-prop">mipLevel</a></b> : int</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="qt3drender-qabstracttextureimage.html#QAbstractTextureImage">QAbstractTextureImage</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QAbstractTexture::CubeMapFace </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qabstracttextureimage.html#face-prop">face</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qabstracttextureimage.html#layer-prop">layer</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qabstracttextureimage.html#mipLevel-prop">mipLevel</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> <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="qt3drender-qabstracttextureimage.html#setFace">setFace</a></b>(QAbstractTexture::CubeMapFace <i>face</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qabstracttextureimage.html#setLayer">setLayer</a></b>(int <i>layer</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qabstracttextureimage.html#setMipLevel">setMipLevel</a></b>(int <i>level</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="qt3drender-qabstracttextureimage.html#face-prop">faceChanged</a></b>(QAbstractTexture::CubeMapFace <i>face</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qabstracttextureimage.html#layer-prop">layerChanged</a></b>(int <i>layer</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qabstracttextureimage.html#mipLevel-prop">mipLevelChanged</a></b>(int <i>mipLevel</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> <a name="protected-functions"></a> <h2 id="protected-functions">Protected Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> virtual Qt3DRender::QTextureImageDataGeneratorPtr </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qabstracttextureimage.html#dataGenerator">dataGenerator</a></b>() const = 0</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qabstracttextureimage.html#notifyDataGeneratorChanged">notifyDataGeneratorChanged</a></b>()</td></tr> </table></div> <ul> <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> </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 variables inherited from <a href="../qtcore/qobject.html#protected-variables">QObject</a></li> </ul> <a name="details"></a> <!-- $$$QAbstractTextureImage-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>Encapsulates the necessary information to create an OpenGL texture image.</p> <p><a href="qt3drender-qabstracttextureimage.html">QAbstractTextureImage</a> should be used as the means of providing image data to a <a href="qt3drender-qabstracttexture.html">QAbstractTexture</a>. It contains the necessary information: mipmap level, layer, cube face load at the proper place data into an OpenGL texture.</p> <p>The actual data is provided through a <a href="qt3drender-qtextureimagedatagenerator.html">QTextureImageDataGenerator</a> that will be executed by Aspect jobs in the backend. <a href="qt3drender-qabstracttextureimage.html">QAbstractTextureImage</a> should be subclassed to provide a functor and eventual additional properties needed by the functor to load actual data.</p> <p><b>Note: </b>: <a href="qt3drender-qabstracttextureimage.html">QAbstractTextureImage</a> should never be shared. Expect crashes, undefined behavior at best if this rule is not respected.</p></div> <!-- @@@QAbstractTextureImage --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$face-prop$$$face$$$setFaceQAbstractTexture::CubeMapFace$$$faceChangedQAbstractTexture::CubeMapFace --> <h3 class="fn" id="face-prop"><a name="face-prop"></a><span class="name">face</span> : <span class="type">Qt3DRender::QAbstractTexture::CubeMapFace</span></h3> <p>Holds the cube map face of the texture image.</p> <p><b>Note: </b>The cube map face has a meaning only for <a href="qt3drender-qabstracttexture.html#Target-enum">TargetCubeMap</a> and <a href="qt3drender-qabstracttexture.html#Target-enum">TargetCubeMapArray</a>.</p><p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QAbstractTexture::CubeMapFace </td><td class="memItemRight bottomAlign"><span class="name"><b>face</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3drender-qabstracttextureimage.html#setFace">setFace</a></b></span>(QAbstractTexture::CubeMapFace <i>face</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>faceChanged</b></span>(QAbstractTexture::CubeMapFace <i>face</i>)</td></tr> </table></div> <!-- @@@face --> <!-- $$$layer-prop$$$layer$$$setLayerint$$$layerChangedint --> <h3 class="fn" id="layer-prop"><a name="layer-prop"></a><span class="name">layer</span> : <span class="type">int</span></h3> <p>Returns the layer of the texture image.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>layer</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3drender-qabstracttextureimage.html#setLayer">setLayer</a></b></span>(int <i>layer</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>layerChanged</b></span>(int <i>layer</i>)</td></tr> </table></div> <!-- @@@layer --> <!-- $$$mipLevel-prop$$$mipLevel$$$setMipLevelint$$$mipLevelChangedint --> <h3 class="fn" id="mipLevel-prop"><a name="mipLevel-prop"></a><span class="name">mipLevel</span> : <span class="type">int</span></h3> <p>Holds the mipmap level of the texture image.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>mipLevel</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3drender-qabstracttextureimage.html#setMipLevel">setMipLevel</a></b></span>(int <i>level</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>mipLevelChanged</b></span>(int <i>mipLevel</i>)</td></tr> </table></div> <!-- @@@mipLevel --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QAbstractTextureImage[overload1]$$$QAbstractTextureImageQt3DCore::QNode* --> <h3 class="fn" id="QAbstractTextureImage"><a name="QAbstractTextureImage"></a>QAbstractTextureImage::<span class="name">QAbstractTextureImage</span>(<span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3> <p>Constructs a new <a href="qt3drender-qabstracttextureimage.html">QAbstractTextureImage</a> instance with <i>parent</i> as parent.</p> <!-- @@@QAbstractTextureImage --> <!-- $$$dataGenerator[overload1]$$$dataGenerator --> <h3 class="fn" id="dataGenerator"><a name="dataGenerator"></a><code>[pure virtual protected] </code><span class="type">Qt3DRender::QTextureImageDataGeneratorPtr</span> QAbstractTextureImage::<span class="name">dataGenerator</span>() const</h3> <p>Implement this method to return the <a href="qt3drender.html#QTextureImageDataGeneratorPtr-typedef">QTextureImageDataGeneratorPtr</a>, which will provide the data for the texture image.</p> <!-- @@@dataGenerator --> <!-- $$$notifyDataGeneratorChanged[overload1]$$$notifyDataGeneratorChanged --> <h3 class="fn" id="notifyDataGeneratorChanged"><a name="notifyDataGeneratorChanged"></a><code>[protected] </code><span class="type">void</span> QAbstractTextureImage::<span class="name">notifyDataGeneratorChanged</span>()</h3> <p>Triggers an update of the data generator that is sent to the backend.</p> <!-- @@@notifyDataGeneratorChanged --> <!-- $$$setFace --> <h3 class="fn" id="setFace"><a name="setFace"></a><code>[slot] </code><span class="type">void</span> QAbstractTextureImage::<span class="name">setFace</span>(<span class="type"><a href="qt3drender-qabstracttexture.html#CubeMapFace-enum">QAbstractTexture::CubeMapFace</a></span> <i>face</i>)</h3> <p>Sets the texture image face to <i>face</i>. <i>face</i></p> <p><b>Note:</b> Setter function for property <a href="qt3drender-qabstracttextureimage.html#face-prop">face</a>. </p><p><b>See also </b><a href="qt3drender-qabstracttextureimage.html#face-prop">face</a>().</p> <!-- @@@setFace --> <!-- $$$setLayer --> <h3 class="fn" id="setLayer"><a name="setLayer"></a><code>[slot] </code><span class="type">void</span> QAbstractTextureImage::<span class="name">setLayer</span>(<span class="type">int</span> <i>layer</i>)</h3> <p>Sets the layer of a texture to <i>layer</i>. <i>layer</i></p> <p><b>Note:</b> Setter function for property <a href="qt3drender-qabstracttextureimage.html#layer-prop">layer</a>. </p><p><b>See also </b><a href="qt3drender-qabstracttextureimage.html#layer-prop">layer</a>().</p> <!-- @@@setLayer --> <!-- $$$setMipLevel --> <h3 class="fn" id="setMipLevel"><a name="setMipLevel"></a><code>[slot] </code><span class="type">void</span> QAbstractTextureImage::<span class="name">setMipLevel</span>(<span class="type">int</span> <i>level</i>)</h3> <p>Sets the mip level of a texture to <i>level</i>. <i>level</i></p> <p><b>Note:</b> Setter function for property <a href="qt3drender-qabstracttextureimage.html#mipLevel-prop">mipLevel</a>. </p><p><b>See also </b><a href="qt3drender-qabstracttextureimage.html#mipLevel-prop">mipLevel</a>().</p> <!-- @@@setMipLevel --> </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>