QQuickFramebufferObject¶
The
QQuickFramebufferObject
class is a convenience class for integrating OpenGL rendering using a framebuffer object (FBO) with Qt Quick. More…
Synopsis¶
Functions¶
def
mirrorVertically
()def
setMirrorVertically
(enable)def
setTextureFollowsItemSize
(follows)def
textureFollowsItemSize
()
Virtual functions¶
def
createRenderer
()
Signals¶
def
mirrorVerticallyChanged
(arg__1)def
textureFollowsItemSizeChanged
(arg__1)
Detailed Description¶
On most platforms, the rendering will occur on a dedicated thread . For this reason, the
QQuickFramebufferObject
class enforces a strict separation between the item implementation and the FBO rendering. All item logic, such as properties and UI-related helper functions needed by QML should be located in aQQuickFramebufferObject
class subclass. Everything that relates to rendering must be located in theRenderer
class.To avoid race conditions and read/write issues from two threads it is important that the renderer and the item never read or write shared variables. Communication between the item and the renderer should primarily happen via the
synchronize()
function. This function will be called on the render thread while the GUI thread is blocked.Using queued connections or events for communication between item and renderer is also possible.
Both the Renderer and the FBO are memory managed internally.
To render into the FBO, the user should subclass the Renderer class and reimplement its
render()
function. The Renderer subclass is returned fromcreateRenderer()
.The size of the FBO will by default adapt to the size of the item. If a fixed size is preferred, set
textureFollowsItemSize
tofalse
and return a texture of your choosing fromcreateFramebufferObject()
.Starting Qt 5.4, the
QQuickFramebufferObject
class is atexture provider
and can be used directly in ShaderEffects and other classes that consume texture providers.See also
Scene Graph - Rendering FBOs Scene Graph and Rendering
-
class
QQuickFramebufferObject
([parent=None])¶ - param parent
Constructs a new
QQuickFramebufferObject
with parentparent
.
-
PySide2.QtQuick.QQuickFramebufferObject.
createRenderer
()¶ - Return type
Reimplement this function to create a renderer used to render into the FBO.
This function will be called on the rendering thread while the GUI thread is blocked.
-
PySide2.QtQuick.QQuickFramebufferObject.
mirrorVertically
()¶ - Return type
bool
See also
-
PySide2.QtQuick.QQuickFramebufferObject.
mirrorVerticallyChanged
(arg__1)¶ - Parameters
arg__1 –
bool
-
PySide2.QtQuick.QQuickFramebufferObject.
setMirrorVertically
(enable)¶ - Parameters
enable –
bool
See also
-
PySide2.QtQuick.QQuickFramebufferObject.
setTextureFollowsItemSize
(follows)¶ - Parameters
follows –
bool
See also
-
PySide2.QtQuick.QQuickFramebufferObject.
textureFollowsItemSize
()¶ - Return type
bool
See also
-
PySide2.QtQuick.QQuickFramebufferObject.
textureFollowsItemSizeChanged
(arg__1)¶ - Parameters
arg__1 –
bool
© 2018 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. 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.