Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QQuick3DExtensionHelpers Class Reference

\inmodule QtQuick3D More...

#include <qquick3dextensionhelpers.h>

Collaboration diagram for QQuick3DExtensionHelpers:

Public Member Functions

 QQuick3DExtensionHelpers ()

Static Public Member Functions

static QSSGNodeId getNodeId (const QQuick3DObject &node)
static QSSGResourceId getResourceId (const QQuick3DObject &resource)
static QSSGCameraId getCameraId (const QQuick3DObject &camera)
static QSSGExtensionId getExtensionId (const QQuick3DObject &extension)
static QSSGRenderGraphObject::Type getNodeIdType (QSSGNodeId nodeId)
template<typename QSSGTypeId>
static constexpr bool isNull (QSSGTypeId id)

Detailed Description

\inmodule QtQuick3D

Since
6.6

Helper functions for the Extensions APIs.

Definition at line 31 of file qquick3dextensionhelpers.h.

Constructor & Destructor Documentation

◆ QQuick3DExtensionHelpers()

QQuick3DExtensionHelpers::QQuick3DExtensionHelpers ( )

Definition at line 55 of file qquick3dextensionhelpers.cpp.

Member Function Documentation

◆ getCameraId()

QSSGCameraId QQuick3DExtensionHelpers::getCameraId ( const QQuick3DObject & camera)
staticnodiscard
\return a \c QSSGCameraId that can be used to retrieve the corresponding \a camera object
in the engine.

!

See also
QSSGFrameData::getNode()

Definition at line 94 of file qquick3dextensionhelpers.cpp.

◆ getExtensionId()

QSSGExtensionId QQuick3DExtensionHelpers::getExtensionId ( const QQuick3DObject & extension)
staticnodiscard

Definition at line 102 of file qquick3dextensionhelpers.cpp.

◆ getNodeId()

QSSGNodeId QQuick3DExtensionHelpers::getNodeId ( const QQuick3DObject & node)
staticnodiscard
\return a \c QSSGNodeId that can be used to retrieve the object in the engine
corresponding to \a node.

!

See also
QSSGFrameData::getNode()

Definition at line 66 of file qquick3dextensionhelpers.cpp.

◆ getNodeIdType()

QSSGRenderGraphObject::Type QQuick3DExtensionHelpers::getNodeIdType ( QSSGNodeId nodeId)
staticnodiscard
Returns
the type of the node with the given nodeId.

This function is useful to determine the type of a nodeId.

See also
QSSGRenderGraphObject::Type

Definition at line 118 of file qquick3dextensionhelpers.cpp.

◆ getResourceId()

QSSGResourceId QQuick3DExtensionHelpers::getResourceId ( const QQuick3DObject & resource)
staticnodiscard
\return a \c QSSGResourceId that can be used to retrieve the corresponding \a resource object
in the engine.

!

See also
QSSGFrameData::getResource()

Definition at line 80 of file qquick3dextensionhelpers.cpp.

◆ isNull()

template<typename QSSGTypeId>
constexpr bool QQuick3DExtensionHelpers::isNull ( QSSGTypeId id)
inlinestaticnodiscardconstexpr

Definition at line 44 of file qquick3dextensionhelpers.h.


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