QRenderSettings Class

(Qt3DRender::QRenderSettings)

The QRenderSettings class holds settings related to rendering process and host the active FrameGraph. More...

Header: #include <QRenderSettings>
qmake: QT += 3drender
Since: Qt 5.7
Instantiated By: RenderSettings
Inherits: Qt3DCore::QComponent

Public Types

enum RenderPolicy { OnDemand, Always }

Properties

Public Functions

QRenderSettings(Qt3DCore::QNode *parent = nullptr)
QFrameGraphNode *activeFrameGraph() const
QPickingSettings *pickingSettings()
RenderPolicy renderPolicy() const

Public Slots

void setActiveFrameGraph(QFrameGraphNode *activeFrameGraph)
void setRenderPolicy(RenderPolicy renderPolicy)

Signals

void activeFrameGraphChanged(QFrameGraphNode *activeFrameGraph)
void renderPolicyChanged(RenderPolicy renderPolicy)

Additional Inherited Members

  • 1 public variable inherited from QObject
  • 10 static public members inherited from QObject
  • 2 protected functions inherited from Qt3DCore::QNode
  • 9 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

The QRenderSettings class holds settings related to rendering process and host the active FrameGraph.

The QRenderSettings component must be set as a component of the scene root entity. It specifies render policy and picking settings, as well as hosts the active FrameGraph.

Member Type Documentation

enum QRenderSettings::RenderPolicy

The render policy.

ConstantValueDescription
Qt3DRender::QRenderSettings::OnDemand0The FrameGraph is rendered only when something changes.
Qt3DRender::QRenderSettings::Always1The FrameGraph is rendered continuously, even if nothing has changed.

Property Documentation

activeFrameGraph : Qt3DRender::QFrameGraphNode *

Holds the currently active FrameGraph.

Access functions:

QFrameGraphNode *activeFrameGraph() const
void setActiveFrameGraph(QFrameGraphNode *activeFrameGraph)

Notifier signal:

void activeFrameGraphChanged(QFrameGraphNode *activeFrameGraph)

pickingSettings : Qt3DRender::QPickingSettings * const

Holds the current pick settings for the FrameGraph.

Access functions:

QPickingSettings *pickingSettings()

renderPolicy : RenderPolicy

Holds the current render policy.

Access functions:

RenderPolicy renderPolicy() const
void setRenderPolicy(RenderPolicy renderPolicy)

Notifier signal:

void renderPolicyChanged(RenderPolicy renderPolicy)

Member Function Documentation

QRenderSettings::QRenderSettings(Qt3DCore::QNode *parent = nullptr)

Default constructs an instance of QRenderSettings.