Enables or disables entire subtrees of frame graph nodes. More...
Import Statement: | import Qt3D.Render |
Since: | Qt 5.14 |
Instantiates: | QSubtreeEnabler |
Inherits: |
While FrameGraphNodes can be individually enabled and disabled via the enabled
property, this can become tedious when an entire path needs to be turned on or off. SubtreeEnabler is a convenience node that makes this use case trivial, allowing all of its children to be controlled by a single switch.
For example, the following simplified frame graph includes a subtree for debug rendering that can easily be enabled only when debugging.
RenderSurfaceSelector { ClearBuffers { Viewport { CameraSelector {} } } SubtreeEnabler { enabled: showDebugView Viewport { CameraSelector { RenderPassFilter {} } } } }
SubtreeEnabler is enabled by default.
enablement : enumeration
Controls whether subtree enablement is persistent or transient.
Constant | Description |
---|---|
Persistent |
The value of enabled is persistent. This is the default. |
SingleShot |
The value of enabled will last for a single frame and then be reset to false. This might be used for a subtree drawing to an FBO, for example, to only update the FBO when the relevant portions of the scene changed. |
void requestUpdate()
Requests that the subtree be enabled.
A conveninence method intended to be used with SingleShot
enablement.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qml-qt3d-render-subtreeenabler.html