ForwardRenderer QML Type

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

Import Statement:	import Qt3D.Extras 2.0
Since:	Qt 5.7
Instantiates:	QForwardRenderer

• List of all members, including inherited members
• Obsolete members

Properties

• buffersToClear : color
• camera : Entity
• clearColor : color
• externalRenderTargetSize : QSize
• frustumCulling : bool
• gamma : real
• showDebugOverlay : bool
• surface : Object
• viewportRect : rect

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.

ForwardRenderer is a single leaf FrameGraph tree which contains a Viewport, a CameraSelector, and a ClearBuffers. The ForwardRenderer 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.

Property Documentation

[since 5.14] buffersToClear : color

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

This property was introduced in Qt 5.14.

camera : Entity

Holds the current camera entity used to render the scene.

Note: A camera is an Entity that has a CameraLens as one of its components.

clearColor : color

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

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

frustumCulling : bool

Indicates if the renderer applies frustum culling to the scene.

gamma : real

Holds the gamma value the renderer applies to the scene.

[since 5.15] 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.

This property was introduced in Qt 5.15.

surface : Object

Holds the current render surface.

viewportRect : rect

Holds the current normalized viewport rectangle.