SubtreeEnabler QML Type

Enables or disables entire subtrees of frame graph nodes. More...

• List of all members, including inherited members

Properties

• enablement : enumeration

Methods

• void requestUpdate()

Detailed Description

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.

Property Documentation

Method Documentation