- Qt 6.11
- Qt Quick 3D
- C++ Classes
- QSSGFrameData
- Qt Quick 3D | Commercial or GPLv3

# QSSGFrameData Class

Storage class containing data collected for a frame. More...

Header: | `#include <QSSGFrameData>`
Since: | Qt 6.7

- List of all members, including inherited members

## Public Functions

QSSGCameraId | activeCamera() const
QSSGNodeIdList | getLayerNodes(QSSGCameraId cameraId, QSSGFrameData::TypeMask typeMask = NodeMask) const
QSSGNodeIdList | getLayerNodes(quint32 layerMask, QSSGFrameData::TypeMask typeMask = NodeMask) const
QSSGRhiGraphicsPipelineState | getPipelineState() const
QSSGFrameData::Result | getRenderResult(QSSGFrameData::RenderResult id) const
QSSGFrameData::Result | getRenderResult(QSSGResourceId userPassId, QSSGFrameData::AttachmentSelector attachment) const
void | scheduleRenderResults(QSSGFrameData::RenderResults results) const

## Detailed Description

## Member Function Documentation

### QSSGCameraId QSSGFrameData::activeCamera() const

Returns The active camera for the scene, or null if non could be found.

### QSSGNodeIdList QSSGFrameData::getLayerNodes(QSSGCameraId cameraId, QSSGFrameData::TypeMask typeMask = NodeMask) const

Returns A list of layer nodes for the given cameraId that match the typeMask. If the camera does not have a layer mask, an empty list is returned.

### QSSGNodeIdList QSSGFrameData::getLayerNodes(quint32 layerMask, QSSGFrameData::TypeMask typeMask = NodeMask) const

Returns A list of layer nodes that match the layerMask and typeMask.

### QSSGRhiGraphicsPipelineState QSSGFrameData::getPipelineState() const

Returns Base pipeline state for this frame

### QSSGFrameData::Result QSSGFrameData::getRenderResult(QSSGFrameData::RenderResult id) const

Returns The renderable texture result from id. `nullptr` if no matching id was found.

Note: Even if the function returns a non-null result, the returned QSSGRhiRenderableTexture might not be ready unless the pass rendering to the texture has been executed.

Note: The returned value is only valid within the current frame. On each new frame the renderable will be reset and should therefore be queried again.

### QSSGFrameData::Result QSSGFrameData::getRenderResult(QSSGResourceId userPassId, QSSGFrameData::AttachmentSelector attachment) const

Returns The renderable texture result from a user defined render pass with the given userPassId. If no matching user pass could be found, or if the user pass did not produce any renderable textures, an invalid Result is returned.

Note: Even if the function returns a non-null result, the returned QSSGRhiRenderableTexture might not be ready unless the pass rendering to the texture has been executed.

Note: The returned value is only valid within the current frame. On each new frame the renderable will be reset and should therefore be queried again.

### void QSSGFrameData::scheduleRenderResults(QSSGFrameData::RenderResults results) const

Schedule the given results to be made available for this frame.

This function should only be called during the prepare phase in QSSGRenderExtension::prepareData().

Note: The requested results might not be available if the underlying layer does not support them or if the layer does not contain any data that would make it necessary to produce the requested results, in which case getRenderResult() will return a empty result.

See also getRenderResult().