/usr/share/qt5/doc/qtquick/qsgabstractrenderer.html is in qtdeclarative5-doc-html 5.5.1-2ubuntu6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qsgabstractrenderer.cpp -->
<title>QSGAbstractRenderer Class | Qt Quick 5.5</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.5</li>
<li><a href="qtquick-index.html">Qt Quick</a></li>
<li><a href="qtquick-module.html">C++ Classes</a></li>
<li>QSGAbstractRenderer</li>
<li id="buildversion">Qt 5.5.1 Reference Documentation</li>
</ul>
</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="#public-functions">Public Functions</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">QSGAbstractRenderer Class</h1>
<!-- $$$QSGAbstractRenderer-brief -->
<p><a href="qsgabstractrenderer.html">QSGAbstractRenderer</a> gives access to the scene graph nodes and rendering of a <a href="qsgengine.html">QSGEngine</a>. <a href="#details">More...</a></p>
<!-- @@@QSGAbstractRenderer -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QSGAbstractRenderer></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.4</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p></p>
</td></tr></table></div><ul>
<li><a href="qsgabstractrenderer-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"> flags </td><td class="memItemRight bottomAlign"><b><a href="qsgabstractrenderer.html#ClearModeBit-enum">ClearMode</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qsgabstractrenderer.html#ClearModeBit-enum">ClearModeBit</a></b> { ClearColorBuffer, ClearDepthBuffer, ClearStencilBuffer }</td></tr>
</table></div>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QColor </td><td class="memItemRight bottomAlign"><b><a href="qsgabstractrenderer.html#clearColor">clearColor</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> ClearMode </td><td class="memItemRight bottomAlign"><b><a href="qsgabstractrenderer.html#clearMode">clearMode</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRect </td><td class="memItemRight bottomAlign"><b><a href="qsgabstractrenderer.html#deviceRect">deviceRect</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMatrix4x4 </td><td class="memItemRight bottomAlign"><b><a href="qsgabstractrenderer.html#projectionMatrix">projectionMatrix</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qsgabstractrenderer.html#renderScene">renderScene</a></b>(GLuint<i> fboId</i> = 0) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSGRootNode * </td><td class="memItemRight bottomAlign"><b><a href="qsgabstractrenderer.html#rootNode">rootNode</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsgabstractrenderer.html#setClearColor">setClearColor</a></b>(const QColor &<i> color</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsgabstractrenderer.html#setClearMode">setClearMode</a></b>(ClearMode<i> mode</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsgabstractrenderer.html#setDeviceRect">setDeviceRect</a></b>(const QRect &<i> rect</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsgabstractrenderer.html#setDeviceRect-2">setDeviceRect</a></b>(const QSize &<i> size</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsgabstractrenderer.html#setProjectionMatrix">setProjectionMatrix</a></b>(const QMatrix4x4 &<i> matrix</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsgabstractrenderer.html#setProjectionMatrixToRect">setProjectionMatrixToRect</a></b>(const QRectF &<i> rect</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsgabstractrenderer.html#setRootNode">setRootNode</a></b>(QSGRootNode *<i> node</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsgabstractrenderer.html#setViewportRect">setViewportRect</a></b>(const QRect &<i> rect</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsgabstractrenderer.html#setViewportRect-2">setViewportRect</a></b>(const QSize &<i> size</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRect </td><td class="memItemRight bottomAlign"><b><a href="qsgabstractrenderer.html#viewportRect">viewportRect</a></b>() const</td></tr>
</table></div>
<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="qsgabstractrenderer.html#sceneGraphChanged">sceneGraphChanged</a></b>()</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QSGAbstractRenderer-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p><a href="qsgabstractrenderer.html">QSGAbstractRenderer</a> gives access to the scene graph nodes and rendering of a <a href="qsgengine.html">QSGEngine</a>.</p>
<p>A <a href="qsgabstractrenderer.html">QSGAbstractRenderer</a> created by a <a href="qsgengine.html">QSGEngine</a> allows you to set your <a href="qsgnode.html">QSGNode</a> tree through <a href="qsgabstractrenderer.html#setRootNode">setRootNode</a>() and control the rendering viewport through <a href="qsgabstractrenderer.html#setDeviceRect">setDeviceRect</a>(), <a href="qsgabstractrenderer.html#setViewportRect">setViewportRect</a>() and <a href="qsgabstractrenderer.html#setProjectionMatrixToRect">setProjectionMatrixToRect</a>(). You can finally trigger the rendering to the desired framebuffer through <a href="qsgabstractrenderer.html#renderScene">renderScene</a>().</p>
<p>The <a href="qsgabstractrenderer.html">QSGAbstractRenderer</a> is only available when used with a <a href="qsgengine.html">QSGEngine</a> and isn't exposed when used internally by <a href="qquickwindow.html">QQuickWindow</a>.</p>
</div>
<p><b>See also </b><a href="qsgengine.html">QSGEngine</a> and <a href="qsgnode.html">QSGNode</a>.</p>
<!-- @@@QSGAbstractRenderer -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$ClearModeBit$$$ClearColorBuffer$$$ClearDepthBuffer$$$ClearStencilBuffer -->
<h3 class="flags" id="ClearModeBit-enum"><a name="ClearModeBit-enum"></a>enum QSGAbstractRenderer::<span class="name">ClearModeBit</span><br/>flags QSGAbstractRenderer::<span class="name">ClearMode</span></h3>
<p>Used with <a href="qsgabstractrenderer.html#setClearMode">setClearMode</a>() to indicate which buffer should be cleared before the scene render.</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>QSGAbstractRenderer::ClearColorBuffer</code></td><td class="topAlign"><code>0x0001</code></td><td class="topAlign">Clear the color buffer using <a href="qsgabstractrenderer.html#clearColor">clearColor</a>().</td></tr>
<tr><td class="topAlign"><code>QSGAbstractRenderer::ClearDepthBuffer</code></td><td class="topAlign"><code>0x0002</code></td><td class="topAlign">Clear the depth buffer.</td></tr>
<tr><td class="topAlign"><code>QSGAbstractRenderer::ClearStencilBuffer</code></td><td class="topAlign"><code>0x0004</code></td><td class="topAlign">Clear the stencil buffer.</td></tr>
</table></div>
<p>The ClearMode type is a typedef for <a href="">QFlags</a><ClearModeBit>. It stores an OR combination of ClearModeBit values.</p>
<p><b>See also </b><a href="qsgabstractrenderer.html#setClearMode">setClearMode</a>() and <a href="qsgabstractrenderer.html#setClearColor">setClearColor</a>().</p>
<!-- @@@ClearModeBit -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$clearColor[overload1]$$$clearColor -->
<h3 class="fn" id="clearColor"><a name="clearColor"></a><span class="type">QColor</span> QSGAbstractRenderer::<span class="name">clearColor</span>() const</h3>
<p>Returns the color that clears the framebuffer at the beginning of the rendering.</p>
<p><b>See also </b><a href="qsgabstractrenderer.html#setClearColor">setClearColor</a>() and <a href="qsgabstractrenderer.html#clearMode">clearMode</a>().</p>
<!-- @@@clearColor -->
<!-- $$$clearMode[overload1]$$$clearMode -->
<h3 class="fn" id="clearMode"><a name="clearMode"></a><span class="type"><a href="qsgabstractrenderer.html#ClearModeBit-enum">ClearMode</a></span> QSGAbstractRenderer::<span class="name">clearMode</span>() const</h3>
<p>Flags defining which attachment of the framebuffer will be cleared before each scene render.</p>
<p><b>See also </b><a href="qsgabstractrenderer.html#setClearMode">setClearMode</a>() and <a href="qsgabstractrenderer.html#clearColor">clearColor</a>().</p>
<!-- @@@clearMode -->
<!-- $$$deviceRect[overload1]$$$deviceRect -->
<h3 class="fn" id="deviceRect"><a name="deviceRect"></a><span class="type">QRect</span> QSGAbstractRenderer::<span class="name">deviceRect</span>() const</h3>
<p>Returns the device rect of the surface being rendered to.</p>
<p><b>See also </b><a href="qsgabstractrenderer.html#setDeviceRect">setDeviceRect</a>().</p>
<!-- @@@deviceRect -->
<!-- $$$projectionMatrix[overload1]$$$projectionMatrix -->
<h3 class="fn" id="projectionMatrix"><a name="projectionMatrix"></a><span class="type">QMatrix4x4</span> QSGAbstractRenderer::<span class="name">projectionMatrix</span>() const</h3>
<p>Returns the projection matrix</p>
<p><b>See also </b><a href="qsgabstractrenderer.html#setProjectionMatrix">setProjectionMatrix</a>() and <a href="qsgabstractrenderer.html#setProjectionMatrixToRect">setProjectionMatrixToRect</a>().</p>
<!-- @@@projectionMatrix -->
<!-- $$$renderScene[overload1]$$$renderSceneGLuint -->
<h3 class="fn" id="renderScene"><a name="renderScene"></a><code>[pure virtual] </code><span class="type">void</span> QSGAbstractRenderer::<span class="name">renderScene</span>(<span class="type">GLuint</span><i> fboId</i> = 0)</h3>
<p>Render the scene to the specified <i>fboId</i></p>
<p>If <i>fboId</i> isn't specified, the scene graph will be rendered to the default framebuffer. You will have to call QOpenGLContext::swapBuffers() yourself afterward.</p>
<p>The framebuffer specified by <i>fboId</i> will be bound automatically.</p>
<p><b>See also </b>QOpenGLContext::swapBuffers() and QOpenGLFramebufferObject::handle().</p>
<!-- @@@renderScene -->
<!-- $$$rootNode[overload1]$$$rootNode -->
<h3 class="fn" id="rootNode"><a name="rootNode"></a><span class="type">QSGRootNode</span> * QSGAbstractRenderer::<span class="name">rootNode</span>() const</h3>
<p>Returns the root of the <a href="qsgnode.html">QSGNode</a> scene.</p>
<p><b>See also </b><a href="qsgabstractrenderer.html#setRootNode">setRootNode</a>().</p>
<!-- @@@rootNode -->
<!-- $$$sceneGraphChanged[overload1]$$$sceneGraphChanged -->
<h3 class="fn" id="sceneGraphChanged"><a name="sceneGraphChanged"></a><code>[signal] </code><span class="type">void</span> QSGAbstractRenderer::<span class="name">sceneGraphChanged</span>()</h3>
<p>This signal is emitted on the first modification of a node in the tree after the last scene render.</p>
<!-- @@@sceneGraphChanged -->
<!-- $$$setClearColor[overload1]$$$setClearColorconstQColor& -->
<h3 class="fn" id="setClearColor"><a name="setClearColor"></a><span class="type">void</span> QSGAbstractRenderer::<span class="name">setClearColor</span>(const <span class="type">QColor</span> &<i> color</i>)</h3>
<p>Use <i>color</i> to clear the framebuffer when <a href="qsgabstractrenderer.html#clearMode">clearMode</a>() is set to <a href="qsgabstractrenderer.html#ClearModeBit-enum">QSGAbstractRenderer::ClearColorBuffer</a>.</p>
<p><b>See also </b><a href="qsgabstractrenderer.html#clearColor">clearColor</a>() and <a href="qsgabstractrenderer.html#setClearMode">setClearMode</a>().</p>
<!-- @@@setClearColor -->
<!-- $$$setClearMode[overload1]$$$setClearModeClearMode -->
<h3 class="fn" id="setClearMode"><a name="setClearMode"></a><span class="type">void</span> QSGAbstractRenderer::<span class="name">setClearMode</span>(<span class="type"><a href="qsgabstractrenderer.html#ClearModeBit-enum">ClearMode</a></span><i> mode</i>)</h3>
<p>Defines which attachment of the framebuffer should be cleared before each scene render with the <i>mode</i> flag.</p>
<p><b>See also </b><a href="qsgabstractrenderer.html#clearMode">clearMode</a>() and <a href="qsgabstractrenderer.html#setClearColor">setClearColor</a>().</p>
<!-- @@@setClearMode -->
<!-- $$$setDeviceRect[overload1]$$$setDeviceRectconstQRect& -->
<h3 class="fn" id="setDeviceRect"><a name="setDeviceRect"></a><span class="type">void</span> QSGAbstractRenderer::<span class="name">setDeviceRect</span>(const <span class="type">QRect</span> &<i> rect</i>)</h3>
<p>Sets <i>rect</i> as the geometry of the surface being rendered to.</p>
<p><b>See also </b><a href="qsgabstractrenderer.html#deviceRect">deviceRect</a>().</p>
<!-- @@@setDeviceRect -->
<!-- $$$setDeviceRect$$$setDeviceRectconstQSize& -->
<h3 class="fn" id="setDeviceRect-2"><a name="setDeviceRect-2"></a><span class="type">void</span> QSGAbstractRenderer::<span class="name">setDeviceRect</span>(const <span class="type">QSize</span> &<i> size</i>)</h3>
<p>This is an overloaded function.</p>
<p>Sets the <i>size</i> of the surface being rendered to.</p>
<p><b>See also </b><a href="qsgabstractrenderer.html#deviceRect">deviceRect</a>().</p>
<!-- @@@setDeviceRect -->
<!-- $$$setProjectionMatrix[overload1]$$$setProjectionMatrixconstQMatrix4x4& -->
<h3 class="fn" id="setProjectionMatrix"><a name="setProjectionMatrix"></a><span class="type">void</span> QSGAbstractRenderer::<span class="name">setProjectionMatrix</span>(const <span class="type">QMatrix4x4</span> &<i> matrix</i>)</h3>
<p>Use <i>matrix</i> to project the <a href="qsgnode.html">QSGNode</a> coordinates onto surface pixels.</p>
<p><b>See also </b><a href="qsgabstractrenderer.html#projectionMatrix">projectionMatrix</a>() and <a href="qsgabstractrenderer.html#setProjectionMatrixToRect">setProjectionMatrixToRect</a>().</p>
<!-- @@@setProjectionMatrix -->
<!-- $$$setProjectionMatrixToRect[overload1]$$$setProjectionMatrixToRectconstQRectF& -->
<h3 class="fn" id="setProjectionMatrixToRect"><a name="setProjectionMatrixToRect"></a><span class="type">void</span> QSGAbstractRenderer::<span class="name">setProjectionMatrixToRect</span>(const <span class="type">QRectF</span> &<i> rect</i>)</h3>
<p>Convenience method that calls <a href="qsgabstractrenderer.html#setProjectionMatrix">setProjectionMatrix</a>() with an orthographic matrix generated from <i>rect</i>.</p>
<p><b>See also </b><a href="qsgabstractrenderer.html#setProjectionMatrix">setProjectionMatrix</a>() and <a href="qsgabstractrenderer.html#projectionMatrix">projectionMatrix</a>().</p>
<!-- @@@setProjectionMatrixToRect -->
<!-- $$$setRootNode[overload1]$$$setRootNodeQSGRootNode* -->
<h3 class="fn" id="setRootNode"><a name="setRootNode"></a><span class="type">void</span> QSGAbstractRenderer::<span class="name">setRootNode</span>(<span class="type">QSGRootNode</span> *<i> node</i>)</h3>
<p>Sets the <i>node</i> as the root of the <a href="qsgnode.html">QSGNode</a> scene that you want to render. You need to provide a <i>node</i> before trying to render the scene.</p>
<p><b>Note: </b>This doesn't take ownership of <i>node</i>.</p><p><b>See also </b><a href="qsgabstractrenderer.html#rootNode">rootNode</a>().</p>
<!-- @@@setRootNode -->
<!-- $$$setViewportRect[overload1]$$$setViewportRectconstQRect& -->
<h3 class="fn" id="setViewportRect"><a name="setViewportRect"></a><span class="type">void</span> QSGAbstractRenderer::<span class="name">setViewportRect</span>(const <span class="type">QRect</span> &<i> rect</i>)</h3>
<p>Sets <i>rect</i> as the geometry of the viewport to render on the surface.</p>
<p><b>See also </b><a href="qsgabstractrenderer.html#viewportRect">viewportRect</a>().</p>
<!-- @@@setViewportRect -->
<!-- $$$setViewportRect$$$setViewportRectconstQSize& -->
<h3 class="fn" id="setViewportRect-2"><a name="setViewportRect-2"></a><span class="type">void</span> QSGAbstractRenderer::<span class="name">setViewportRect</span>(const <span class="type">QSize</span> &<i> size</i>)</h3>
<p>This is an overloaded function.</p>
<p>Sets the <i>size</i> of the viewport to render on the surface.</p>
<p><b>See also </b><a href="qsgabstractrenderer.html#viewportRect">viewportRect</a>().</p>
<!-- @@@setViewportRect -->
<!-- $$$viewportRect[overload1]$$$viewportRect -->
<h3 class="fn" id="viewportRect"><a name="viewportRect"></a><span class="type">QRect</span> QSGAbstractRenderer::<span class="name">viewportRect</span>() const</h3>
<p>Returns the rect of the viewport to render.</p>
<p><b>See also </b><a href="qsgabstractrenderer.html#setViewportRect">setViewportRect</a>().</p>
<!-- @@@viewportRect -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 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>
|