QSSGFrameData Class Reference

\inmodule QtQuick3D More...

#include <qssgrenderextensions.h>

Collaboration diagram for QSSGFrameData:

Classes
struct	Result

Public Types
enum class	RenderResult : quint32 { AoTexture , DepthTexture , ScreenTexture }

Public Member Functions
Result	getRenderResult (RenderResult id) const
QSSGRhiGraphicsPipelineState	getPipelineState () const
QSSGCameraId	activeCamera () const
QSSGRenderContextInterface *	contextInterface () const

Friends
class	QSSGLayerRenderData
class	QSSGRenderHelpers

Detailed Description

\inmodule QtQuick3D

Since

6.7

Storage class containing data collected for a frame.

Definition at line 29 of file qssgrenderextensions.h.

Member Enumeration Documentation

RenderResult

enum class QSSGFrameData::RenderResult : quint32

strong

Enumerator
AoTexture
DepthTexture
ScreenTexture

Definition at line 32 of file qssgrenderextensions.h.

Member Function Documentation

activeCamera()

QSSGCameraId QSSGFrameData::activeCamera

(

)

const

Returns

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

Definition at line 52 of file qssgrenderextensions.cpp.

References QSSGRenderGraphObjectUtils::getCameraId(), QSSGLayerRenderData::getCurrent(), Invalid, QSSG_ASSERT, QSSGRenderContextInterface::renderer(), and ret.

Here is the call graph for this function:

contextInterface()

QSSGRenderContextInterface * QSSGFrameData::contextInterface

(

)

const

Definition at line 63 of file qssgrenderextensions.cpp.

Referenced by QSSGRenderHelpers::commit(), QSSGRenderHelpers::createRenderables(), QSSGModelHelpers::getGlobalOpacity(), QSSGModelHelpers::getGlobalTransform(), QSSGRenderHelpers::prepareForRender(), QSSGRenderHelpers::prepareRenderables(), QSSGRenderExtensionHelpers::registerRenderResult(), QSSGRenderHelpers::renderRenderables(), QSSGModelHelpers::setGlobalOpacity(), QSSGModelHelpers::setGlobalTransform(), QSSGModelHelpers::setModelMaterials(), and QSSGModelHelpers::setModelMaterials().

Here is the caller graph for this function:

getPipelineState()

QSSGRhiGraphicsPipelineState QSSGFrameData::getPipelineState

(

)

const

Returns

Base pipeline state for this frame

Definition at line 42 of file qssgrenderextensions.cpp.

References QSSGLayerRenderData::getCurrent(), QSSG_ASSERT, and QSSGRenderContextInterface::renderer().

Here is the call graph for this function:

getRenderResult()

QSSGFrameData::Result QSSGFrameData::getRenderResult

(

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.

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.

Definition at line 28 of file qssgrenderextensions.cpp.

References QSSGLayerRenderData::getCurrent(), QSSG_GUARD, QSSGRenderContextInterface::renderer(), and QSSGFrameData::Result::texture.

Here is the call graph for this function:

Friends And Related Symbol Documentation

QSSGLayerRenderData

friend class QSSGLayerRenderData

friend

Definition at line 54 of file qssgrenderextensions.h.

QSSGRenderHelpers

friend class QSSGRenderHelpers

friend

Definition at line 55 of file qssgrenderextensions.h.

---

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

• qtquick3d/src/runtimerender/extensionapi/qssgrenderextensions.h (9eba936a8c45e845a09357f130742f4dbf6f822c)
• qtquick3d/src/runtimerender/extensionapi/qssgrenderextensions.cpp (9eba936a8c45e845a09357f130742f4dbf6f822c)