QSGAbstractRenderer

QSGAbstractRenderer gives access to the scene graph nodes and rendering of a QSGEngine . More…

Synopsis

Functions

• def clearColor ()

• def clearMode ()

• def deviceRect ()

• def projectionMatrix ()

• def projectionMatrixWithNativeNDC ()

• def setClearColor (color)

• def setClearMode (mode)

• def setDeviceRect (rect)

• def setDeviceRect (size)

• def setProjectionMatrix (matrix)

• def setProjectionMatrixToRect (rect)

• def setProjectionMatrixToRect (rect, flags)

• def setProjectionMatrixWithNativeNDC (matrix)

• def setViewportRect (rect)

• def setViewportRect (size)

• def viewportRect ()

Virtual functions

• def nodeChanged (node, state)

• def renderScene ([fboId=0])

Signals

• def sceneGraphChanged ()

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

QSGEngine QSGNode

class PySide2.QtQuick.QSGAbstractRenderer([parent=None])

Parameters:

parent – PySide2.QtCore.QObject

PySide2.QtQuick.QSGAbstractRenderer.ClearModeBit

Used with setClearMode() to indicate which buffer should be cleared before the scene render.

Constant	Description
QSGAbstractRenderer.ClearColorBuffer	Clear the color buffer using clearColor() .
QSGAbstractRenderer.ClearDepthBuffer	Clear the depth buffer.
QSGAbstractRenderer.ClearStencilBuffer	Clear the stencil buffer.

See also

setClearMode() setClearColor()

PySide2.QtQuick.QSGAbstractRenderer.MatrixTransformFlag

Used with setProjectionMatrixToRect() to indicate the expectations towards the generated projection matrix.

Constant	Description
QSGAbstractRenderer.MatrixTransformFlipY	The traditional assumption in Qt Quick is that Y points up in the normalized device coordinate system. There is at least one modern graphics API where this is not the case (Vulkan). This flag can then be used to get a projection that is appropriate for such an API.

See also

setProjectionMatrixToRect()

New in version 5.14.

PySide2.QtQuick.QSGAbstractRenderer.clearColor()

Return type:

PySide2.QtGui.QColor

Returns the color that clears the framebuffer at the beginning of the rendering.

See also

setClearColor() clearMode()

PySide2.QtQuick.QSGAbstractRenderer.clearMode()

Return type:

ClearMode

Flags defining which attachment of the framebuffer will be cleared before each scene render.

See also

setClearMode() clearColor()

PySide2.QtQuick.QSGAbstractRenderer.deviceRect()

Return type:

PySide2.QtCore.QRect

Returns the device rect of the surface being rendered to.

See also

setDeviceRect()

PySide2.QtQuick.QSGAbstractRenderer.nodeChanged(node, state)

Parameters:

• node – PySide2.QtQuick.QSGNode

• state – DirtyState

PySide2.QtQuick.QSGAbstractRenderer.projectionMatrix()

Return type:

PySide2.QtGui.QMatrix4x4

Returns the projection matrix

See also

setProjectionMatrix() setProjectionMatrixToRect()

PySide2.QtQuick.QSGAbstractRenderer.projectionMatrixWithNativeNDC()

Return type:

PySide2.QtGui.QMatrix4x4

PySide2.QtQuick.QSGAbstractRenderer.renderScene([fboId=0])

Parameters:

fboId – uint

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 swapBuffers() yourself afterward.

The framebuffer specified by fboId will be bound automatically.

See also

swapBuffers() handle()

PySide2.QtQuick.QSGAbstractRenderer.sceneGraphChanged()

PySide2.QtQuick.QSGAbstractRenderer.setClearColor(color)

Parameters:

color – PySide2.QtGui.QColor

Use color to clear the framebuffer when clearMode() is set to ClearColorBuffer .

See also

clearColor() setClearMode()

PySide2.QtQuick.QSGAbstractRenderer.setClearMode(mode)

Parameters:

mode – ClearMode

Defines which attachment of the framebuffer should be cleared before each scene render with the mode flag.

See also

clearMode() setClearColor()

PySide2.QtQuick.QSGAbstractRenderer.setDeviceRect(rect)

Parameters:

rect – PySide2.QtCore.QRect

PySide2.QtQuick.QSGAbstractRenderer.setDeviceRect(size)

Parameters:

size – PySide2.QtCore.QSize

PySide2.QtQuick.QSGAbstractRenderer.setProjectionMatrix(matrix)

Parameters:

matrix – PySide2.QtGui.QMatrix4x4

Use matrix to project the QSGNode coordinates onto surface pixels.

See also

projectionMatrix() setProjectionMatrixToRect()

PySide2.QtQuick.QSGAbstractRenderer.setProjectionMatrixToRect(rect)

Parameters:

rect – PySide2.QtCore.QRectF

Convenience method that calls setProjectionMatrix() with an orthographic matrix generated from rect .

Note

This function assumes that the graphics API uses Y up in its normalized device coordinate system.

See also

setProjectionMatrix() projectionMatrix()

PySide2.QtQuick.QSGAbstractRenderer.setProjectionMatrixToRect(rect, flags)

Parameters:

• rect – PySide2.QtCore.QRectF

• flags – MatrixTransformFlags

Convenience method that calls setProjectionMatrix() with an orthographic matrix generated from rect .

Set MatrixTransformFlipY in flags when the graphics API uses Y down in its normalized device coordinate system (for example, Vulkan).

See also

setProjectionMatrix() projectionMatrix()

PySide2.QtQuick.QSGAbstractRenderer.setProjectionMatrixWithNativeNDC(matrix)

Parameters:

matrix – PySide2.QtGui.QMatrix4x4

PySide2.QtQuick.QSGAbstractRenderer.setViewportRect(rect)

Parameters:

rect – PySide2.QtCore.QRect

PySide2.QtQuick.QSGAbstractRenderer.setViewportRect(size)

Parameters:

size – PySide2.QtCore.QSize

PySide2.QtQuick.QSGAbstractRenderer.viewportRect()

Return type:

PySide2.QtCore.QRect

Returns the rect of the viewport to render.

See also

setViewportRect()