Qt 6.x
The Qt SDK
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
QSSGFrameData Class Reference

\inmodule QtQuick3DRuntimeRender More...

#include <qssgrenderextensions_p.h>

+ Collaboration diagram for QSSGFrameData:

Public Member Functions

QSSGRhiGraphicsPipelineState getPipelineState () const
 
QSSGRenderableNodeEntry getNode (QSSGNodeId id) const
 id a QSSGNodeId
 
QSSGRenderableNodeEntry takeNode (QSSGNodeId id)
 id a QSSGNodeId
 
QSSGRenderGraphObject * getResource (QSSGResourceId id) const
 id a QSSGNodeId
 
QSSGRenderCamera * camera () const
 
QSSGRenderer * renderer () const
 

Friends

class QSSGLayerRenderData
 
class QSSGRenderHelpers
 

Detailed Description

\inmodule QtQuick3DRuntimeRender

Since
6.6

Storage class containing data collected for a frame.

Definition at line 36 of file qssgrenderextensions_p.h.

Member Function Documentation

◆ camera()

QSSGRenderCamera * QSSGFrameData::camera ( ) const
Returns
The main camera for the scene, or null if non could be found.
See also
QSSGRenderCamera

Definition at line 86 of file qssgrenderextensions.cpp.

References QSSG_ASSERT.

◆ getNode()

QSSGRenderableNodeEntry QSSGFrameData::getNode ( QSSGNodeId  id) const

id a QSSGNodeId

Returns
The \l {QSSGRenderableNodeEntry}{renderable entry} that corresponds to the QSSGNodeId.
Note
This function does not remove the renderable entry which means any other extension or internal code processed after this extension will be able to process it as well.
See also
QSSGFrameData::takeNode(), QQuick3DExtensionHelpers::getNodeId(), QSSGRenderableNodeEntry

Definition at line 41 of file qssgrenderextensions.cpp.

References QSSG_ASSERT.

◆ getPipelineState()

QSSGRhiGraphicsPipelineState QSSGFrameData::getPipelineState ( ) const
Returns
Base pipeline state for this frame

Definition at line 23 of file qssgrenderextensions.cpp.

References QSSG_ASSERT.

◆ getResource()

QSSGRenderGraphObject * QSSGFrameData::getResource ( QSSGResourceId  id) const

id a QSSGNodeId

Returns
The \l {QSSGRenderGraphObject}{resource object} that corresponds to the provided QSSGResourceId.
See also
QQuick3DExtensionHelpers::getResourceId()

Definition at line 72 of file qssgrenderextensions.cpp.

References QSSG_ASSERT.

◆ renderer()

QSSGRenderer * QSSGFrameData::renderer ( ) const
inline

Definition at line 48 of file qssgrenderextensions_p.h.

◆ takeNode()

QSSGRenderableNodeEntry QSSGFrameData::takeNode ( QSSGNodeId  id)

id a QSSGNodeId

Returns
The \l {QSSGRenderableNodeEntry}{renderable entry} that corresponds to the provided QSSGNodeId.
Note
This function removes the renderable entry which means it won't be available for any other extension or internal code executed after this extension.
See also
QSSGFrameData::takeNode(), QQuick3DExtensionHelpers::getNodeId(), QSSGRenderableNodeEntry

Definition at line 58 of file qssgrenderextensions.cpp.

References QSSG_ASSERT.

Friends And Related Symbol Documentation

◆ QSSGLayerRenderData

friend class QSSGLayerRenderData
friend

Definition at line 51 of file qssgrenderextensions_p.h.

◆ QSSGRenderHelpers

friend class QSSGRenderHelpers
friend

Definition at line 52 of file qssgrenderextensions_p.h.

The documentation for this class was generated from the following files: