class QForwardRenderer

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

Synopsis

Properties

• buffersToClearᅟ

• cameraᅟ

• clearColorᅟ

• externalRenderTargetSizeᅟ

• frustumCullingᅟ

• gammaᅟ

• showDebugOverlayᅟ

• surfaceᅟ

• viewportRectᅟ

• windowᅟ

Methods

• def __init__()

• def buffersToClear()

• def camera()

• def clearColor()

• def externalRenderTargetSize()

• def gamma()

• def isFrustumCullingEnabled()

• def showDebugOverlay()

• def surface()

• def viewportRect()

Slots

• def setBuffersToClear()

• def setCamera()

• def setClearColor()

• def setExternalRenderTargetSize()

• def setFrustumCullingEnabled()

• def setGamma()

• def setShowDebugOverlay()

• def setSurface()

• def setViewportRect()

Signals

• def buffersToClearChanged()

• def cameraChanged()

• def clearColorChanged()

• def externalRenderTargetSizeChanged()

• def frustumCullingEnabledChanged()

• def gammaChanged()

• def showDebugOverlayChanged()

• def surfaceChanged()

• def viewportRectChanged()

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.

Note

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

property buffersToClearᅟ: Qt3DRender.QClearBuffers.BufferType

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

Access functions:

• buffersToClear()

• setBuffersToClear()

• Signal buffersToClearChanged()

property cameraᅟ: 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:

• camera()

• setCamera()

• Signal cameraChanged()

property clearColorᅟ: QColor

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

Access functions:

• clearColor()

• setClearColor()

• Signal clearColorChanged()

property externalRenderTargetSizeᅟ: 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:

• externalRenderTargetSize()

• setExternalRenderTargetSize()

• Signal externalRenderTargetSizeChanged()

property frustumCullingᅟ: bool

Indicates if the renderer applies frustum culling to the scene.

Access functions:

• isFrustumCullingEnabled()

• setFrustumCullingEnabled()

• Signal frustumCullingEnabledChanged()

property gammaᅟ: float

Holds the gamma value the renderer applies to the scene.

Access functions:

• gamma()

• setGamma()

• Signal gammaChanged()

property 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:

• showDebugOverlay()

• setShowDebugOverlay()

• Signal showDebugOverlayChanged()

property surfaceᅟ: QObject

Holds the current render surface.

Access functions:

• surface()

• setSurface()

• Signal surfaceChanged()

property viewportRectᅟ: QRectF

Holds the current normalized viewport rectangle.

Access functions:

• viewportRect()

• setViewportRect()

• Signal viewportRectChanged()

property windowᅟ: QObject

Holds the current render surface.

Access functions:

• surface()

• setSurface()

• Signal surfaceChanged()

__init__([parent=None])

Parameters:

parent – QNode

buffersToClear()

Return type:

BufferType

See also

setBuffersToClear()

Getter of property buffersToClearᅟ .

buffersToClearChanged(arg__1)

Parameters:

arg__1 – BufferType

Notification signal of property buffersToClearᅟ .

camera()

Return type:

QEntity

See also

setCamera()

Getter of property cameraᅟ .

cameraChanged(camera)

Parameters:

camera – QEntity

Notification signal of property cameraᅟ .

clearColor()

Return type:

QColor

See also

setClearColor()

Getter of property clearColorᅟ .

clearColorChanged(clearColor)

Parameters:

clearColor – QColor

Notification signal of property clearColorᅟ .

externalRenderTargetSize()

Return type:

QSize

See also

setExternalRenderTargetSize()

Getter of property externalRenderTargetSizeᅟ .

externalRenderTargetSizeChanged(size)

Parameters:

size – QSize

Notification signal of property externalRenderTargetSizeᅟ .

frustumCullingEnabledChanged(enabled)

Parameters:

enabled – bool

Notification signal of property frustumCullingᅟ .

gamma()

Return type:

float

See also

setGamma()

Getter of property gammaᅟ .

gammaChanged(gamma)

Parameters:

gamma – float

Notification signal of property gammaᅟ .

isFrustumCullingEnabled()

Return type:

bool

Getter of property frustumCullingᅟ .

setBuffersToClear(arg__1)

Parameters:

arg__1 – BufferType

See also

buffersToClear()

Setter of property buffersToClearᅟ .

setCamera(camera)

Parameters:

camera – QEntity

See also

camera()

Setter of property cameraᅟ .

setClearColor(clearColor)

Parameters:

clearColor – QColor

See also

clearColor()

Setter of property clearColorᅟ .

setExternalRenderTargetSize(size)

Parameters:

size – QSize

See also

externalRenderTargetSize()

Setter of property externalRenderTargetSizeᅟ .

setFrustumCullingEnabled(enabled)

Parameters:

enabled – bool

See also

isFrustumCullingEnabled()

Setter of property frustumCullingᅟ .

setGamma(gamma)

Parameters:

gamma – float

See also

gamma()

Setter of property gammaᅟ .

setShowDebugOverlay(showDebugOverlay)

Parameters:

showDebugOverlay – bool

See also

showDebugOverlay()

Setter of property showDebugOverlayᅟ .

setSurface(surface)

Parameters:

surface – QObject

See also

surface()

Setter of property surfaceᅟ .

setViewportRect(viewportRect)

Parameters:

viewportRect – QRectF

See also

viewportRect()

Setter of property viewportRectᅟ .

showDebugOverlay()

Return type:

bool

See also

setShowDebugOverlay()

Getter of property showDebugOverlayᅟ .

showDebugOverlayChanged(showDebugOverlay)

Parameters:

showDebugOverlay – bool

Notification signal of property showDebugOverlayᅟ .

surface()

Return type:

QObject

See also

setSurface()

Getter of property surfaceᅟ .

surfaceChanged(surface)

Parameters:

surface – QObject

Notification signal of property surfaceᅟ .

viewportRect()

Return type:

QRectF

See also

setViewportRect()

Getter of property viewportRectᅟ .

viewportRectChanged(viewportRect)

Parameters:

viewportRect – QRectF

Notification signal of property viewportRectᅟ .