QForwardRenderer

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

Inheritance diagram of PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer

Synopsis

Functions

Slots

Signals

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 PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer([parent=None])
Parameters:

parent – PySide2.Qt3DCore.Qt3DCore.QNode

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.buffersToClear()
Return type:

BufferType

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

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.buffersToClearChanged(arg__1)
Parameters:

arg__1 – BufferType

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.camera()
Return type:

PySide2.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.

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.cameraChanged(camera)
Parameters:

camera – PySide2.Qt3DCore.Qt3DCore.QEntity

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.clearColor()
Return type:

PySide2.QtGui.QColor

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

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.clearColorChanged(clearColor)
Parameters:

clearColor – PySide2.QtGui.QColor

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.externalRenderTargetSize()
Return type:

PySide2.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 ).

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.externalRenderTargetSizeChanged(size)
Parameters:

size – PySide2.QtCore.QSize

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.frustumCullingEnabledChanged(enabled)
Parameters:

enabled – bool

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.gamma()
Return type:

float

Holds the gamma value the renderer applies to the scene.

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.gammaChanged(gamma)
Parameters:

gamma – float

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.isFrustumCullingEnabled()
Return type:

bool

Indicates if the renderer applies frustum culling to the scene.

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.setBuffersToClear(arg__1)
Parameters:

arg__1 – BufferType

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

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.setCamera(camera)
Parameters:

camera – PySide2.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.

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.setClearColor(clearColor)
Parameters:

clearColor – PySide2.QtGui.QColor

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

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.setExternalRenderTargetSize(size)
Parameters:

size – PySide2.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 ).

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.setFrustumCullingEnabled(enabled)
Parameters:

enabled – bool

Indicates if the renderer applies frustum culling to the scene.

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.setGamma(gamma)
Parameters:

gamma – float

Holds the gamma value the renderer applies to the scene.

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.setShowDebugOverlay(showDebugOverlay)
Parameters:

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.

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.setSurface(surface)
Parameters:

surface – PySide2.QtCore.QObject

Holds the current render surface.

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.setViewportRect(viewportRect)
Parameters:

viewportRect – PySide2.QtCore.QRectF

Holds the current normalized viewport rectangle.

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.showDebugOverlay()
Return type:

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.

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.showDebugOverlayChanged(showDebugOverlay)
Parameters:

showDebugOverlay – bool

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.surface()
Return type:

PySide2.QtCore.QObject

Holds the current render surface.

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.surfaceChanged(surface)
Parameters:

surface – PySide2.QtCore.QObject

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.viewportRect()
Return type:

PySide2.QtCore.QRectF

Holds the current normalized viewport rectangle.

PySide2.Qt3DExtras.Qt3DExtras.QForwardRenderer.viewportRectChanged(viewportRect)
Parameters:

viewportRect – PySide2.QtCore.QRectF