QForwardRenderer#

The QForwardRenderer provides a default FrameGraph implementation of a forward renderer. More

Inheritance diagram of PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer

Synopsis#

Properties#

Functions#

Slots#

Signals#

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

Forward rendering is what OpenGL traditionally uses. It renders directly to the backbuffer one object at a time shading each one as it goes.

QForwardRenderer is a single leaf FrameGraph tree which contains a QViewport , a QCameraSelector , and a QClearBuffers . The QForwardRenderer has a default requirement filter key whose name is “renderingStyle” and value “forward”. If you need to filter out your techniques, you should do so based on that filter key.

By default the viewport occupies the whole screen and the clear color is white. Frustum culling is also enabled.

class PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer([parent=None])#
Parameters:

parentPySide6.Qt3DCore.Qt3DCore.QNode

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property PᅟySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.buffersToClear: BufferType#

Holds the current buffers to be cleared. Default value is ColorDepthBuffer

Access functions:
property PᅟySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.camera: PySide6.Qt3DCore.Qt3DCore.QEntity#

Holds the current camera entity used to render the scene.

Note

A camera is a QEntity that has a QCameraLens as one of its components.

Access functions:
property PᅟySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.clearColor: PySide6.QtGui.QColor#

Holds the current clear color of the scene. The frame buffer is initialized to the clear color before rendering.

Access functions:
property PᅟySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.externalRenderTargetSize: PySide6.QtCore.QSize#

Contains the size of the external render target. External render targets are relevant when rendering does not target a window surface (as set in surface ).

Access functions:
property PᅟySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.frustumCulling: bool#

Indicates if the renderer applies frustum culling to the scene.

Access functions:
property PᅟySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.gamma: float#

Holds the gamma value the renderer applies to the scene.

Access functions:
property PᅟySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.showDebugOverlay: bool#

If true, a debug overlay will be rendered over the scene. It will show detailed information about the runtime rendering state, let the user turn logging on and off, etc.

Access functions:
property PᅟySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.surface: PySide6.QtCore.QObject#

Holds the current render surface.

Access functions:
property PᅟySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.viewportRect: PySide6.QtCore.QRectF#

Holds the current normalized viewport rectangle.

Access functions:
property PᅟySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.window: PySide6.QtCore.QObject#

Holds the current render surface.

Access functions:
PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.buffersToClear()#
Return type:

BufferType

Getter of property buffersToClear .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.buffersToClearChanged(arg__1)#
Parameters:

arg__1BufferType

Notification signal of property buffersToClear .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.camera()#
Return type:

PySide6.Qt3DCore.Qt3DCore.QEntity

See also

setCamera()

Getter of property camera .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.cameraChanged(camera)#
Parameters:

cameraPySide6.Qt3DCore.Qt3DCore.QEntity

Notification signal of property camera .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.clearColor()#
Return type:

PySide6.QtGui.QColor

See also

setClearColor()

Getter of property clearColor .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.clearColorChanged(clearColor)#
Parameters:

clearColorPySide6.QtGui.QColor

Notification signal of property clearColor .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.externalRenderTargetSize()#
Return type:

PySide6.QtCore.QSize

Getter of property externalRenderTargetSize .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.externalRenderTargetSizeChanged(size)#
Parameters:

sizePySide6.QtCore.QSize

Notification signal of property externalRenderTargetSize .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.frustumCullingEnabledChanged(enabled)#
Parameters:

enabled – bool

Notification signal of property frustumCulling .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.gamma()#
Return type:

float

See also

setGamma()

Getter of property gamma .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.gammaChanged(gamma)#
Parameters:

gamma – float

Notification signal of property gamma .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.isFrustumCullingEnabled()#
Return type:

bool

Getter of property frustumCulling .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.setBuffersToClear(arg__1)#
Parameters:

arg__1BufferType

See also

buffersToClear()

Setter of property buffersToClear .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.setCamera(camera)#
Parameters:

cameraPySide6.Qt3DCore.Qt3DCore.QEntity

See also

camera()

Setter of property camera .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.setClearColor(clearColor)#
Parameters:

clearColorPySide6.QtGui.QColor

See also

clearColor()

Setter of property clearColor .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.setExternalRenderTargetSize(size)#
Parameters:

sizePySide6.QtCore.QSize

Setter of property externalRenderTargetSize .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.setFrustumCullingEnabled(enabled)#
Parameters:

enabled – bool

Setter of property frustumCulling .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.setGamma(gamma)#
Parameters:

gamma – float

See also

gamma()

Setter of property gamma .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.setShowDebugOverlay(showDebugOverlay)#
Parameters:

showDebugOverlay – bool

Setter of property showDebugOverlay .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.setSurface(surface)#
Parameters:

surfacePySide6.QtCore.QObject

See also

surface()

Setter of property surface .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.setViewportRect(viewportRect)#
Parameters:

viewportRectPySide6.QtCore.QRectF

See also

viewportRect()

Setter of property viewportRect .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.showDebugOverlay()#
Return type:

bool

Getter of property showDebugOverlay .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.showDebugOverlayChanged(showDebugOverlay)#
Parameters:

showDebugOverlay – bool

Notification signal of property showDebugOverlay .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.surface()#
Return type:

PySide6.QtCore.QObject

See also

setSurface()

Getter of property surface .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.surfaceChanged(surface)#
Parameters:

surfacePySide6.QtCore.QObject

Notification signal of property surface .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.viewportRect()#
Return type:

PySide6.QtCore.QRectF

Getter of property viewportRect .

PySide6.Qt3DExtras.Qt3DExtras.QForwardRenderer.viewportRectChanged(viewportRect)#
Parameters:

viewportRectPySide6.QtCore.QRectF

Notification signal of property viewportRect .