<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qtextureimage.cpp -->
<title>QTextureImage Class | Qt 3D 5.12.2</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 >QTextureImage</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qt3d-index.html">Qt 5.12.2 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="#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="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#reimplemented-protected-functions">Reimplemented 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">QTextureImage Class</h1>
<span class="small-subtitle">(<a href="qt3drender-qtextureimage.html">Qt3DRender::QTextureImage</a>)<br/></span>
<!-- $$$QTextureImage-brief -->
<p>Encapsulates the necessary information to create an OpenGL texture image from an image source. <a href="#details">More...</a></p>
<!-- @@@QTextureImage -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QTextureImage></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-textureimage.html">TextureImage</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3drender-qabstracttextureimage.html">Qt3DRender::QAbstractTextureImage</a></td></tr></table></div><ul>
<li><a href="qt3drender-qtextureimage-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-qtextureimage.html#Status-enum">Status</a></b> { None, Loading, Ready, Error }</td></tr>
</table></div>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qt3drender-qtextureimage.html#mirrored-prop">mirrored</a></b> : bool</li>
<li class="fn"><b><a href="qt3drender-qtextureimage.html#source-prop">source</a></b> : QUrl</li>
<li class="fn"><b><a href="qt3drender-qtextureimage.html#status-prop">status</a></b> : const Status</li>
</ul>
<ul>
<li class="fn">3 properties inherited from <a href="qt3drender-qabstracttextureimage.html#properties">Qt3DRender::QAbstractTextureImage</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-qtextureimage.html#QTextureImage">QTextureImage</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-qtextureimage.html#isMirrored">isMirrored</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QUrl </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qtextureimage.html#source">source</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DRender::QTextureImage::Status </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qtextureimage.html#status">status</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">3 public functions inherited from <a href="qt3drender-qabstracttextureimage.html#public-functions">Qt3DRender::QAbstractTextureImage</a></li>
<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-qtextureimage.html#setMirrored">setMirrored</a></b>(bool <i>mirrored</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qtextureimage.html#setSource">setSource</a></b>(const QUrl &<i>source</i>)</td></tr>
</table></div>
<ul>
<li class="fn">3 public slots inherited from <a href="qt3drender-qabstracttextureimage.html#public-slots">Qt3DRender::QAbstractTextureImage</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-qtextureimage.html#mirrored-prop">mirroredChanged</a></b>(bool <i>mirrored</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qtextureimage.html#source-prop">sourceChanged</a></b>(const QUrl &<i>source</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qtextureimage.html#status-prop">statusChanged</a></b>(Qt3DRender::QTextureImage::Status <i>status</i>)</td></tr>
</table></div>
<ul>
<li class="fn">3 signals inherited from <a href="qt3drender-qabstracttextureimage.html#signals">Qt3DRender::QAbstractTextureImage</a></li>
<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-qtextureimage.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<a name="protected-functions"></a>
<h2 id="protected-functions">Protected Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qtextureimage.html#setStatus">setStatus</a></b>(Qt3DRender::QTextureImage::Status <i>status</i>)</td></tr>
</table></div>
<a name="reimplemented-protected-functions"></a>
<h2 id="reimplemented-protected-functions">Reimplemented Protected Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qtextureimage.html#sceneChangeEvent">sceneChangeEvent</a></b>(const Qt3DCore::QSceneChangePtr &<i>change</i>) override</td></tr>
</table></div>
<ul>
<li class="fn">2 protected functions inherited from <a href="qt3drender-qabstracttextureimage.html#protected-functions">Qt3DRender::QAbstractTextureImage</a></li>
<li class="fn">2 protected functions inherited from <a href="qt3dcore-qnode.html#protected-functions">Qt3DCore::QNode</a></li>
</ul>
<a name="details"></a>
<!-- $$$QTextureImage-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>Encapsulates the necessary information to create an OpenGL texture image from an image source.</p>
<p>It contains the necessary information mipmap level, layer, cube face and source URL to load at the proper place data into an OpenGL texture.</p>
</div>
<!-- @@@QTextureImage -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Status$$$None$$$Loading$$$Ready$$$Error -->
<h3 class="fn" id="Status-enum"><a name="Status-enum"></a>enum QTextureImage::<span class="name">Status</span></h3>
<p>This enumeration specifies the status values for texture image loading.</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::QTextureImage::None</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The texture image loading has not been started yet.</td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QTextureImage::Loading</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The texture image loading has started, but not finised.</td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QTextureImage::Ready</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">The texture image loading has finished.</td></tr>
<tr><td class="topAlign"><code>Qt3DRender::QTextureImage::Error</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">The texture image loading confronted an error.</td></tr>
</table></div>
<!-- @@@Status -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$mirrored-prop$$$isMirrored$$$setMirroredbool$$$mirroredChangedbool -->
<h3 class="fn" id="mirrored-prop"><a name="mirrored-prop"></a><span class="name">mirrored</span> : <span class="type">bool</span></h3>
<p>This property specifies whether the image should be mirrored when loaded. This is a convenience to avoid having to manipulate images to match the origin of the texture coordinates used by the rendering API. By default this property is set to true. This has no effect when using GPU compressed texture formats.</p>
<p><b>Warning:</b> This property results in a performance price payed at runtime when loading uncompressed or CPU compressed image formats such as PNG. To avoid this performance price it is better to set this property to false and load texture assets that have been pre-mirrored.</p>
<p><b>Note: </b>OpenGL specifies the origin of texture coordinates from the lower left hand corner whereas DirectX uses the the upper left hand corner.</p><p><b>Note: </b>When using cube map texture you'll probably want mirroring disabled as the cube map sampler takes a direction rather than regular texture coordinates.</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="qt3drender-qtextureimage.html#isMirrored">isMirrored</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3drender-qtextureimage.html#setMirrored">setMirrored</a></b></span>(bool <i>mirrored</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>mirroredChanged</b></span>(bool <i>mirrored</i>)</td></tr>
</table></div>
<!-- @@@mirrored -->
<!-- $$$source-prop$$$source$$$setSourceconstQUrl&$$$sourceChangedconstQUrl& -->
<h3 class="fn" id="source-prop"><a name="source-prop"></a><span class="name">source</span> : <span class="type">QUrl</span></h3>
<p>This property holds the source url from which data for the texture image will be loaded.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QUrl </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3drender-qtextureimage.html#source">source</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3drender-qtextureimage.html#setSource">setSource</a></b></span>(const QUrl &<i>source</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>sourceChanged</b></span>(const QUrl &<i>source</i>)</td></tr>
</table></div>
<!-- @@@source -->
<!-- $$$status-prop$$$status$$$statusChangedQt3DRender::QTextureImage::Status -->
<h3 class="fn" id="status-prop"><a name="status-prop"></a><span class="name">status</span> : const <span class="type"><a href="qt3drender-qtextureimage.html#Status-enum">Status</a></span></h3>
<p>This property holds the status of the texture image loading.</p>
<ul>
<li><a href="qml-qt3d-render-textureimage.html">TextureImage</a>.None</li>
<li><a href="qml-qt3d-render-textureimage.html">TextureImage</a>.Loading</li>
<li><a href="qml-qt3d-render-textureimage.html">TextureImage</a>.Ready</li>
<li><a href="qml-qt3d-render-textureimage.html">TextureImage</a>.Error</li>
</ul>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt3DRender::QTextureImage::Status </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3drender-qtextureimage.html#status">status</a></b></span>() const</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>statusChanged</b></span>(Qt3DRender::QTextureImage::Status <i>status</i>)</td></tr>
</table></div>
<!-- @@@status -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QTextureImage[overload1]$$$QTextureImageQt3DCore::QNode* -->
<h3 class="fn" id="QTextureImage"><a name="QTextureImage"></a>QTextureImage::<span class="name">QTextureImage</span>(<span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a new <a href="qt3drender-qtextureimage.html">Qt3DRender::QTextureImage</a> instance with <i>parent</i> as parent.</p>
<!-- @@@QTextureImage -->
<!-- $$$isMirrored -->
<h3 class="fn" id="isMirrored"><a name="isMirrored"></a><span class="type">bool</span> QTextureImage::<span class="name">isMirrored</span>() const</h3>
<p>Returns whether mirroring is enabled or not.</p>
<p><b>Note:</b> Getter function for property <a href="qt3drender-qtextureimage.html#mirrored-prop">mirrored</a>. </p><!-- @@@isMirrored -->
<!-- $$$sceneChangeEvent[overload1]$$$sceneChangeEventconstQt3DCore::QSceneChangePtr& -->
<h3 class="fn" id="sceneChangeEvent"><a name="sceneChangeEvent"></a><code>[override virtual protected] </code><span class="type">void</span> QTextureImage::<span class="name">sceneChangeEvent</span>(const <span class="type"><a href="qt3dcore-qscenechange.html#QSceneChangePtr-typedef">Qt3DCore::QSceneChangePtr</a></span> &<i>change</i>)</h3>
<p>Reimplemented from <a href="qt3dcore-qnode.html#sceneChangeEvent">QNode::sceneChangeEvent</a>().</p>
<p>Sets the scene change event to <i>change</i>. <i>change</i></p>
<!-- @@@sceneChangeEvent -->
<!-- $$$setMirrored -->
<h3 class="fn" id="setMirrored"><a name="setMirrored"></a><code>[slot] </code><span class="type">void</span> QTextureImage::<span class="name">setMirrored</span>(<span class="type">bool</span> <i>mirrored</i>)</h3>
<p>Sets mirroring to <i>mirrored</i>.</p>
<p><b>Note: </b>This internally triggers a call to update the data generator.</p><p><b>Note:</b> Setter function for property <a href="qt3drender-qtextureimage.html#mirrored-prop">mirrored</a>. </p><p><b>See also </b><a href="qt3drender-qtextureimage.html#isMirrored">isMirrored</a>().</p>
<!-- @@@setMirrored -->
<!-- $$$setSource -->
<h3 class="fn" id="setSource"><a name="setSource"></a><code>[slot] </code><span class="type">void</span> QTextureImage::<span class="name">setSource</span>(const <span class="type">QUrl</span> &<i>source</i>)</h3>
<p>Sets the source url of the texture image to <i>source</i>.</p>
<p><b>Note: </b>This internally triggers a call to update the data generator.</p><p><b>Note:</b> Setter function for property <a href="qt3drender-qtextureimage.html#source-prop">source</a>. </p><p><b>See also </b><a href="qt3drender-qtextureimage.html#source">source</a>().</p>
<!-- @@@setSource -->
<!-- $$$setStatus[overload1]$$$setStatusQt3DRender::QTextureImage::Status -->
<h3 class="fn" id="setStatus"><a name="setStatus"></a><code>[protected] </code><span class="type">void</span> QTextureImage::<span class="name">setStatus</span>(<span class="type"><a href="qt3drender-qtextureimage.html#Status-enum">Qt3DRender::QTextureImage::Status</a></span> <i>status</i>)</h3>
<p>Sets the status to <i>status</i>. <i>status</i></p>
<p><b>See also </b><a href="qt3drender-qtextureimage.html#status">status</a>().</p>
<!-- @@@setStatus -->
<!-- $$$source -->
<h3 class="fn" id="source"><a name="source"></a><span class="type">QUrl</span> QTextureImage::<span class="name">source</span>() const</h3>
<p>Returns the source url from which data for the texture image will be loaded.</p>
<p><b>Note:</b> Getter function for property <a href="qt3drender-qtextureimage.html#source-prop">source</a>. </p><p><b>See also </b><a href="qt3drender-qtextureimage.html#setSource">setSource</a>().</p>
<!-- @@@source -->
<!-- $$$status -->
<h3 class="fn" id="status"><a name="status"></a><span class="type"><a href="qt3drender-qtextureimage.html#Status-enum">Qt3DRender::QTextureImage::Status</a></span> QTextureImage::<span class="name">status</span>() const</h3>
<p>Returns the current status.</p>
<p><b>Note:</b> Getter function for property <a href="qt3drender-qtextureimage.html#status-prop">status</a>. </p><p><b>See also </b><a href="qt3drender-qtextureimage.html#setStatus">setStatus</a>().</p>
<!-- @@@status -->
</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>
