qquicktexturefactory.html 10.5 KB
Newer Older
xuebingbing's avatar
xuebingbing committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickimageprovider.cpp -->
  <title>QQuickTextureFactory Class | Qt Quick 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="qtquick-index.html">Qt Quick</a></td><td ><a href="qtquick-module.html">C++ Classes</a></td><td >QQuickTextureFactory</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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</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">QQuickTextureFactory Class</h1>
<!-- $$$QQuickTextureFactory-brief -->
<p>The <a href="qquicktexturefactory.html">QQuickTextureFactory</a> class provides an interface for loading custom textures from QML. <a href="#details">More...</a></p>
<!-- @@@QQuickTextureFactory -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QQuickTextureFactory&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += quick</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  Qt 5.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="../qtcore/qobject.html">QObject</a></td></tr></table></div><ul>
<li><a href="qquicktexturefactory-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="qquicktexturefactory.html#QQuickTextureFactory">QQuickTextureFactory</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qquicktexturefactory.html#dtor.QQuickTextureFactory">~QQuickTextureFactory</a></b>() override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QSGTexture *</td><td class="memItemRight bottomAlign"><b><a href="qquicktexturefactory.html#createTexture">createTexture</a></b>(QQuickWindow *<i>window</i>) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QImage </td><td class="memItemRight bottomAlign"><b><a href="qquicktexturefactory.html#image">image</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qquicktexturefactory.html#textureByteCount">textureByteCount</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QSize </td><td class="memItemRight bottomAlign"><b><a href="qquicktexturefactory.html#textureSize">textureSize</a></b>() const = 0</td></tr>
</table></div>
<ul>
<li class="fn">34 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</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"> QQuickTextureFactory *</td><td class="memItemRight bottomAlign"><b><a href="qquicktexturefactory.html#textureFactoryForImage">textureFactoryForImage</a></b>(const QImage &amp;<i>image</i>)</td></tr>
</table></div>
<ul>
<li class="fn">10 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</a></li>
<li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li>
<li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="../qtcore/qobject.html#public-variables">QObject</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>
<!-- $$$QQuickTextureFactory-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qquicktexturefactory.html">QQuickTextureFactory</a> class provides an interface for loading custom textures from QML.</p>
<p>The purpose of the texture factory is to provide a placeholder for a image data that can be converted into an OpenGL texture.</p>
<p>Creating a texture directly is not possible as there is rarely an OpenGL context available in the thread that is responsible for loading the image data.</p>
</div>
<!-- @@@QQuickTextureFactory -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QQuickTextureFactory[overload1]$$$QQuickTextureFactory -->
<h3 class="fn" id="QQuickTextureFactory"><a name="QQuickTextureFactory"></a>QQuickTextureFactory::<span class="name">QQuickTextureFactory</span>()</h3>
<p>Constructs a texture factory. Since <a href="qquicktexturefactory.html">QQuickTextureFactory</a> is abstract, it cannot be instantiated directly.</p>
<!-- @@@QQuickTextureFactory -->
<!-- $$$~QQuickTextureFactory[overload1]$$$~QQuickTextureFactory -->
<h3 class="fn" id="dtor.QQuickTextureFactory"><a name="dtor.QQuickTextureFactory"></a><code>[override virtual] </code>QQuickTextureFactory::<span class="name">~QQuickTextureFactory</span>()</h3>
<p>Destroys the texture factory.</p>
<!-- @@@~QQuickTextureFactory -->
<!-- $$$createTexture[overload1]$$$createTextureQQuickWindow* -->
<h3 class="fn" id="createTexture"><a name="createTexture"></a><code>[pure virtual] </code><span class="type"><a href="qsgtexture.html">QSGTexture</a></span> *QQuickTextureFactory::<span class="name">createTexture</span>(<span class="type"><a href="qquickwindow.html">QQuickWindow</a></span> *<i>window</i>) const</h3>
<p>This function is called on the scene graph rendering thread to create a <a href="qsgtexture.html">QSGTexture</a> instance from the factory. <i>window</i> provides the context which this texture is created in.</p>
<p>QML will internally cache the returned texture as needed. Each call to this function should return a unique instance.</p>
<p>The OpenGL context used for rendering is bound when this function is called.</p>
<!-- @@@createTexture -->
<!-- $$$image[overload1]$$$image -->
<h3 class="fn" id="image"><a name="image"></a><code>[virtual] </code><span class="type"><a href="../qtgui/qimage.html">QImage</a></span> QQuickTextureFactory::<span class="name">image</span>() const</h3>
<p>Returns an image version of this texture.</p>
<p>The lifespan of the returned image is unknown, so the implementation should return a self contained <a href="../qtgui/qimage.html">QImage</a>, not make use of the <a href="../qtgui/qimage.html">QImage</a>(uchar *, ..&#x2e;) constructor.</p>
<p>This function is not commonly used and is expected to be slow.</p>
<!-- @@@image -->
<!-- $$$textureByteCount[overload1]$$$textureByteCount -->
<h3 class="fn" id="textureByteCount"><a name="textureByteCount"></a><code>[pure virtual] </code><span class="type">int</span> QQuickTextureFactory::<span class="name">textureByteCount</span>() const</h3>
<p>Returns the number of bytes of memory the texture consumes.</p>
<!-- @@@textureByteCount -->
<!-- $$$textureFactoryForImage[overload1]$$$textureFactoryForImageconstQImage& -->
<h3 class="fn" id="textureFactoryForImage"><a name="textureFactoryForImage"></a><code>[static] </code><span class="type"><a href="qquicktexturefactory.html#QQuickTextureFactory">QQuickTextureFactory</a></span> *QQuickTextureFactory::<span class="name">textureFactoryForImage</span>(const <span class="type"><a href="../qtgui/qimage.html">QImage</a></span> &amp;<i>image</i>)</h3>
<p>Returns a <a href="qquicktexturefactory.html">QQuickTextureFactory</a> holding the given <i>image</i>.</p>
<p>This is typically used as a helper in <a href="qquickimageresponse.html#textureFactory">QQuickImageResponse::textureFactory</a>.</p>
<p>This function was introduced in  Qt 5.6.</p>
<!-- @@@textureFactoryForImage -->
<!-- $$$textureSize[overload1]$$$textureSize -->
<h3 class="fn" id="textureSize"><a name="textureSize"></a><code>[pure virtual] </code><span class="type"><a href="../qtcore/qsize.html">QSize</a></span> QQuickTextureFactory::<span class="name">textureSize</span>() const</h3>
<p>Returns the size of the texture. This function will be called from arbitrary threads and should not rely on an OpenGL context bound.</p>
<!-- @@@textureSize -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</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>