/usr/share/qt5/doc/qtquick/qquickframebufferobject-renderer.html is in qtdeclarative5-doc-html 5.2.1-3ubuntu15.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickframebufferobject.cpp -->
<title>Renderer Class | QtQuick 5.2</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.2</li>
<li><a href="qtquick-index.html">Qt Quick</a></li>
<li><a href="qtquick-module.html">C++ Classes</a></li>
<li>Renderer</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">Renderer Class</h1>
<span class="small-subtitle">(QQuickFramebufferObject::Renderer)<br/></span>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <<a href="qquickframebufferobject.html">QQuickFramebufferObject</a>></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += quick</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.2</td></tr></table><ul>
<li><a href="qquickframebufferobject-renderer-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qquickframebufferobject-renderer.html#Renderer">Renderer</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qquickframebufferobject-renderer.html#dtor.Renderer">~Renderer</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QOpenGLFramebufferObject * </td><td class="memItemRight bottomAlign"><b><a href="qquickframebufferobject-renderer.html#createFramebufferObject">createFramebufferObject</a></b>(const QSize &<i> size</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QOpenGLFramebufferObject * </td><td class="memItemRight bottomAlign"><b><a href="qquickframebufferobject-renderer.html#framebufferObject">framebufferObject</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qquickframebufferobject-renderer.html#invalidateFramebufferObject">invalidateFramebufferObject</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qquickframebufferobject-renderer.html#render">render</a></b>() = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qquickframebufferobject-renderer.html#synchronize">synchronize</a></b>(QQuickFramebufferObject *<i> item</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qquickframebufferobject-renderer.html#update">update</a></b>()</td></tr>
</table>
<a name="details"></a>
<!-- $$$Renderer-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QQuickFramebufferObject::Renderer class is used to implement the rendering logic of a <a href="qquickframebufferobject.html">QQuickFramebufferObject</a>.</p>
</div>
<!-- @@@Renderer -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$Renderer[overload1]$$$Renderer -->
<h3 class="fn"><a name="Renderer"></a>Renderer::<span class="name">Renderer</span>()<tt> [protected]</tt></h3>
<p>Constructs a new renderer.</p>
<p>This function is called during the scene graph sync phase when the GUI thread is blocked.</p>
<!-- @@@Renderer -->
<!-- $$$~Renderer[overload1]$$$~Renderer -->
<h3 class="fn"><a name="dtor.Renderer"></a>Renderer::<span class="name">~Renderer</span>()<tt> [virtual protected]</tt></h3>
<p>The Renderer is automatically deleted when the scene graph resources for the <a href="qquickframebufferobject.html">QQuickFramebufferObject</a> item is cleaned up.</p>
<p>This function is called on the rendering thread.</p>
<!-- @@@~Renderer -->
<!-- $$$createFramebufferObject[overload1]$$$createFramebufferObjectconstQSize& -->
<h3 class="fn"><a name="createFramebufferObject"></a><span class="type">QOpenGLFramebufferObject</span> * Renderer::<span class="name">createFramebufferObject</span>(const <span class="type">QSize</span> &<i> size</i>)<tt> [virtual protected]</tt></h3>
<p>This function is called when a new FBO is needed. This happens on the initial frame. If <a href="qquickframebufferobject.html#textureFollowsItemSize-prop">QQuickFramebufferObject::textureFollowsItemSize</a> is set to true, it is called again every time the dimensions of the item changes.</p>
<p>The returned FBO can have any attachment. If the QOpenGLFramebufferObjectFormat indicates that the FBO should be multisampled, the internal implementation of the Renderer will allocate a second FBO and blit the multisampled FBO into the FBO used to display the texture.</p>
<p><b>Note: </b>Some hardware has issues with small FBO sizes. <i>size</i> takes that into account, so be cautious when overriding the size with a fixed size. A minimal size of 64x64 should always work.</p><!-- @@@createFramebufferObject -->
<!-- $$$framebufferObject[overload1]$$$framebufferObject -->
<h3 class="fn"><a name="framebufferObject"></a><span class="type">QOpenGLFramebufferObject</span> * Renderer::<span class="name">framebufferObject</span>() const<tt> [protected]</tt></h3>
<p>Returns the framebuffer object currently being rendered to.</p>
<!-- @@@framebufferObject -->
<!-- $$$invalidateFramebufferObject[overload1]$$$invalidateFramebufferObject -->
<h3 class="fn"><a name="invalidateFramebufferObject"></a><span class="type">void</span> Renderer::<span class="name">invalidateFramebufferObject</span>()<tt> [protected]</tt></h3>
<p>Call this function during <a href="qquickframebufferobject-renderer.html#synchronize">synchronize</a>() to invalidate the current FBO. This will result in a new FBO being created with <a href="qquickframebufferobject-renderer.html#createFramebufferObject">createFramebufferObject</a>().</p>
<!-- @@@invalidateFramebufferObject -->
<!-- $$$render[overload1]$$$render -->
<h3 class="fn"><a name="render"></a><span class="type">void</span> Renderer::<span class="name">render</span>()<tt> [pure virtual protected]</tt></h3>
<p>This function is called when the FBO should be rendered into. The framebuffer is bound at this point and the <tt>glViewport</tt> has been set up to match the FBO size.</p>
<p>The FBO will be automatically unbound after the function returns.</p>
<!-- @@@render -->
<!-- $$$synchronize[overload1]$$$synchronizeQQuickFramebufferObject* -->
<h3 class="fn"><a name="synchronize"></a><span class="type">void</span> Renderer::<span class="name">synchronize</span>(<span class="type"><a href="qquickframebufferobject.html">QQuickFramebufferObject</a></span> *<i> item</i>)<tt> [virtual protected]</tt></h3>
<p>This function is called as a result of <a href="qquickitem.html#update">QQuickFramebufferObject::update</a>().</p>
<p>Use this function to update the renderer with changes that have occurred in the item. <i>item</i> is the item that instantiated this renderer. The function is called once before the FBO is created.</p>
<p><i>For instance, if the item has a color property which is controlled by QML, one should call <a href="qquickitem.html#update">QQuickFramebufferObject::update</a>() and use synchronize() to copy the new color into the renderer so that it can be used to render the next frame.</i></p>
<p>This function is the only place when it is safe for the renderer and the item to read and write each others members.</p>
<!-- @@@synchronize -->
<!-- $$$update[overload1]$$$update -->
<h3 class="fn"><a name="update"></a><span class="type">void</span> Renderer::<span class="name">update</span>()<tt> [protected]</tt></h3>
<p>Call this function when the FBO should be rendered again.</p>
<p>This function can be called from <a href="qquickframebufferobject-renderer.html#render">render</a>() to force the FBO to be rendered again before the next frame.</p>
<p><b>Note: </b>This function should be used from inside the renderer. To update the item on the GUI thread, use <a href="qquickitem.html#update">QQuickFramebufferObject::update</a>().</p><!-- @@@update -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. 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> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|