QSGAbstractRenderer Class▲
-
Header: QSGAbstractRenderer
-
Since: Qt 5.4
-
qmake: QT += quick
-
Inherits: QObject
-
Inherited By:
Detailed Description▲
A QSGAbstractRenderer created by a QSGEngine allows you to set your QSGNode tree through setRootNode() and control the rendering viewport through setDeviceRect(), setViewportRect() and setProjectionMatrixToRect(). You can finally trigger the rendering to the desired framebuffer through renderScene().
The QSGAbstractRenderer is only available when used with a QSGEngine and isn't exposed when used internally by QQuickWindow.
See Also▲
Member Type Documentation▲
enum QSGAbstractRenderer::ClearModeBit▲
flags QSGAbstractRenderer::ClearMode
Used with setClearMode() to indicate which buffer should be cleared before the scene render.
|
Constant |
Value |
Description |
|---|---|---|
|
QSGAbstractRenderer::ClearColorBuffer |
0x0001 |
Clear the color buffer using clearColor(). |
|
QSGAbstractRenderer::ClearDepthBuffer |
0x0002 |
Clear the depth buffer. |
|
QSGAbstractRenderer::ClearStencilBuffer |
0x0004 |
Clear the stencil buffer. |
The ClearMode type is a typedef for QFlags<ClearModeBit>. It stores an OR combination of ClearModeBit values.
See Also▲
See also setClearMode(), setClearColor()
Member Function Documentation▲
QColor QSGAbstractRenderer::clearColor() const▲
Returns the color that clears the framebuffer at the beginning of the rendering.
See Also▲
See also setClearColor(), clearMode()
QSGAbstractRenderer::ClearMode QSGAbstractRenderer::clearMode() const▲
Flags defining which attachment of the framebuffer will be cleared before each scene render.
See Also▲
See also setClearMode(), clearColor()
QRect QSGAbstractRenderer::deviceRect() const▲
QMatrix4x4 QSGAbstractRenderer::projectionMatrix() const▲
[pure virtual] void QSGAbstractRenderer::renderScene(uint fboId = 0)▲
Render the scene to the specified fboId
If fboId isn't specified, the scene graph will be rendered to the default framebuffer. You will have to call QOpenGLContext::swapBuffers() yourself afterward.
The framebuffer specified by fboId will be bound automatically.
See Also▲
See also QOpenGLContext::swapBuffers(), QOpenGLFramebufferObject::handle()
QSGRootNode *QSGAbstractRenderer::rootNode() const▲
void QSGAbstractRenderer::sceneGraphChanged()▲
This signal is emitted on the first modification of a node in the tree after the last scene render.
void QSGAbstractRenderer::setClearColor(const QColor &color)▲
Use color to clear the framebuffer when clearMode() is set to QSGAbstractRenderer::ClearColorBuffer.
See Also▲
See also clearColor(), setClearMode()
void QSGAbstractRenderer::setClearMode(QSGAbstractRenderer::ClearMode mode)▲
Defines which attachment of the framebuffer should be cleared before each scene render with the mode flag.
See Also▲
See also clearMode(), setClearColor()
void QSGAbstractRenderer::setDeviceRect(const QRect &rect)▲
void QSGAbstractRenderer::setDeviceRect(const QSize &size)▲
This is an overloaded function.
Sets the size of the surface being rendered to.
See Also▲
See also deviceRect()
void QSGAbstractRenderer::setProjectionMatrix(const QMatrix4x4 &matrix)▲
Use matrix to project the QSGNode coordinates onto surface pixels.
See Also▲
See also projectionMatrix(), setProjectionMatrixToRect()
void QSGAbstractRenderer::setProjectionMatrixToRect(const QRectF &rect)▲
Convenience method that calls setProjectionMatrix() with an orthographic matrix generated from rect.
See Also▲
See also setProjectionMatrix(), projectionMatrix()
void QSGAbstractRenderer::setRootNode(QSGRootNode *node)▲
Sets the node as the root of the QSGNode scene that you want to render. You need to provide a node before trying to render the scene.
This doesn't take ownership of node.
See Also▲
See also rootNode()
void QSGAbstractRenderer::setViewportRect(const QRect &rect)▲
Sets rect as the geometry of the viewport to render on the surface.
See Also▲
See also viewportRect()
void QSGAbstractRenderer::setViewportRect(const QSize &size)▲
This is an overloaded function.
Sets the size of the viewport to render on the surface.
See Also▲
See also viewportRect()