#include <qquick3dxrview_p.h>

Inheritance diagram for QQuick3DXrView:

Collaboration diagram for QQuick3DXrView:

Classes
struct	XrTouchState

Public Types
enum	FoveationLevel { NoFoveation = 0 , LowFoveation = 1 , MediumFoveation = 2 , HighFoveation = 3 }
enum class	ReferenceSpace { ReferenceSpaceUnknown , ReferenceSpaceLocal , ReferenceSpaceStage , ReferenceSpaceLocalFloor }
Public Types inherited from QQuick3DNode
enum	TransformSpace { LocalSpace , ParentSpace , SceneSpace }
enum	StaticFlags { None }

Public Slots
void	setEnvironment (QQuick3DSceneEnvironment *environment)
void	setPassthroughEnabled (bool enable)
void	setQuitOnSessionEnd (bool enable)
void	setDepthSubmissionEnabled (bool enable)
	\qmlproperty bool QtQuick3D.Xr::XrView::depthSubmissionEnabled
void	setXROrigin (QQuick3DXrOrigin *newXrOrigin)
Public Slots inherited from QQuick3DNode
void	setX (float x)
void	setY (float y)
void	setZ (float z)
void	setRotation (const QQuaternion &rotation)
void	setEulerRotation (const QVector3D &eulerRotation)
void	setPosition (const QVector3D &position)
void	setScale (const QVector3D &scale)
void	setPivot (const QVector3D &pivot)
void	setLocalOpacity (float opacity)
void	setVisible (bool visible)
void	setStaticFlags (int staticFlags)
void	setLayers (int newLayers)
Public Slots inherited from QQuick3DObject
void	update ()
void	setParentItem (QQuick3DObject *parentItem)
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	initializeFailed (const QString &errorString)
void	sessionEnded ()
void	xrOriginChanged ()
void	environmentChanged (QQuick3DSceneEnvironment *environment)
void	passthroughEnabledChanged ()
void	quitOnSessionEndChanged ()
void	fixedFoveationChanged ()
void	frameReady ()
void	referenceSpaceChanged ()
void	depthSubmissionEnabledChanged ()
void	multiViewRenderingEnabledChanged ()
Signals inherited from QQuick3DNode
void	xChanged ()
void	yChanged ()
void	zChanged ()
void	rotationChanged ()
void	eulerRotationChanged ()
void	positionChanged ()
void	scaleChanged ()
void	pivotChanged ()
void	localOpacityChanged ()
void	visibleChanged ()
void	forwardChanged ()
void	upChanged ()
void	rightChanged ()
void	sceneTransformChanged ()
void	scenePositionChanged ()
void	sceneRotationChanged ()
void	sceneScaleChanged ()
void	staticFlagsChanged ()
void	layersChanged ()
Signals inherited from QQuick3DObject
void	parentChanged ()
void	childrenChanged ()
void	stateChanged ()
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QQuick3DXrView ()
	\qmltype XrView \inherits Node \inqmlmodule QtQuick3D.Xr
	~QQuick3DXrView ()
QQuick3DXrOrigin *	xrOrigin () const
	\qmlproperty XrOrigin QtQuick3D.Xr::XrView::xrOrigin
QQuick3DSceneEnvironment *	environment () const
	\qmlproperty SceneEnvironment QtQuick3D.Xr::XrView::environment \summary Holds the SceneEnvironment for the XR view.
bool	passthroughSupported () const
	\qmlproperty bool QtQuick3D.Xr::XrView::passthroughSupported \summary Indicates whether passthrough is supported for the XR view.
bool	passthroughEnabled () const
	\qmlproperty bool QtQuick3D.Xr::XrView::passthroughEnabled \summary Holds whether passthrough is enabled for the XR view.
FoveationLevel	fixedFoveation () const
	\qmlproperty enumeration QtQuick3D.Xr::XrView::fixedFoveation
void	setFixedFoveation (FoveationLevel level)
QQuick3DXrRuntimeInfo *	runtimeInfo () const
	\qmlproperty QQuick3DXrRuntimeInfo QtQuick3D.Xr::XrView::runtimeInfo \summary Provides information about the XR runtime for the XR view.
bool	isQuitOnSessionEndEnabled () const
	\qmlproperty bool QtQuick3D.Xr::XrView::isQuitOnSessionEndEnabled
QQuick3DRenderStats *	renderStats () const
	\qmlproperty RenderStats QtQuick3D.Xr::XrView::renderStats \summary Holds rendering statistics for the XR view.
Q_INVOKABLE QQuick3DPickResult	rayPick (const QVector3D &origin, const QVector3D &direction) const
	\qmlmethod pickResult XrView::rayPick(vector3d origin, vector3d direction)
Q_INVOKABLE QList< QQuick3DPickResult >	rayPickAll (const QVector3D &origin, const QVector3D &direction) const
	\qmlmethod List<pickResult> XrView::rayPickAll(vector3d origin, vector3d direction)
	Q_REVISION (6, 11) Q_INVOKABLE QQuick3DPickResult rayPick(const QVector3D &origin
Q_INVOKABLE void	setTouchpoint (QQuickItem *target, const QPointF &position, int pointId, bool active)
	\qmlmethod XrView::setTouchpoint(Item target, point position, int pointId, bool pressed)
Q_INVOKABLE QVector3D	processTouch (const QVector3D &pos, int pointId)
	\qmlmethod vector3d XrView::processTouch(vector3d position, int pointId)
Q_INVOKABLE QVariantMap	touchpointState (int pointId) const
ReferenceSpace	referenceSpace () const
	\qmlproperty enumeration QtQuick3D.Xr::XrView::referenceSpace
void	setReferenceSpace (ReferenceSpace newReferenceSpace)
bool	depthSubmissionEnabled () const
void	registerXrItem (QQuick3DXrItem *newXrItem)
void	unregisterXrItem (QQuick3DXrItem *xrItem)
bool	isMultiViewRenderingSupported () const
	\qmlproperty bool QtQuick3D.Xr::XrView::multiViewRenderingSupported
bool	multiViewRenderingEnabled () const
	\qmlproperty bool QtQuick3D.Xr::XrView::multiViewRenderingEnabled
QQuick3DXrManager *	xrManager ()
Public Member Functions inherited from QQuick3DNode
	QQuick3DNode (QQuick3DNode *parent=nullptr)
	\qmltype Node \inherits Object3D \inqmlmodule QtQuick3D
	~QQuick3DNode () override
float	x () const
	\qmlproperty real QtQuick3D::Node::x
float	y () const
	\qmlproperty real QtQuick3D::Node::y
float	z () const
	\qmlproperty real QtQuick3D::Node::z
QQuaternion	rotation () const
	\qmlproperty quaternion QtQuick3D::Node::rotation
QVector3D	eulerRotation () const
	\qmlproperty vector3d QtQuick3D::Node::eulerRotation
QVector3D	position () const
	\qmlproperty vector3d QtQuick3D::Node::position
QVector3D	scale () const
	\qmlproperty vector3d QtQuick3D::Node::scale
QVector3D	pivot () const
	\qmlproperty vector3d QtQuick3D::Node::pivot
float	localOpacity () const
	\qmlproperty real QtQuick3D::Node::opacity
bool	visible () const
	\qmlproperty bool QtQuick3D::Node::visible
int	staticFlags () const
	\qmlproperty int QtQuick3D::Node::staticFlags
QQuick3DNode *	parentNode () const
QVector3D	forward () const
	\qmlproperty vector3d QtQuick3D::Node::forward \readonly
QVector3D	up () const
	\qmlproperty vector3d QtQuick3D::Node::up \readonly
QVector3D	right () const
	\qmlproperty vector3d QtQuick3D::Node::right \readonly
QVector3D	scenePosition () const
	\qmlproperty vector3d QtQuick3D::Node::scenePosition \readonly
QQuaternion	sceneRotation () const
	\qmlproperty quaternion QtQuick3D::Node::sceneRotation \readonly
QVector3D	sceneScale () const
	\qmlproperty vector3d QtQuick3D::Node::sceneScale \readonly
QMatrix4x4	sceneTransform () const
	\qmlproperty matrix4x4 QtQuick3D::Node::sceneTransform \readonly
Q_INVOKABLE void	rotate (qreal degrees, const QVector3D &axis, QQuick3DNode::TransformSpace space)
	\qmlmethod QtQuick3D::Node::rotate(real degrees, vector3d axis, enumeration space)
Q_INVOKABLE QVector3D	mapPositionToScene (const QVector3D &localPosition) const
	\qmlmethod vector3d QtQuick3D::Node::mapPositionToScene(vector3d localPosition)
Q_INVOKABLE QVector3D	mapPositionFromScene (const QVector3D &scenePosition) const
	\qmlmethod vector3d QtQuick3D::Node::mapPositionFromScene(vector3d scenePosition)
Q_INVOKABLE QVector3D	mapPositionToNode (const QQuick3DNode *node, const QVector3D &localPosition) const
	\qmlmethod vector3d QtQuick3D::Node::mapPositionToNode(QtQuick3D::Node node, vector3d localPosition)
Q_INVOKABLE QVector3D	mapPositionFromNode (const QQuick3DNode *node, const QVector3D &localPosition) const
	\qmlmethod vector3d QtQuick3D::Node::mapPositionFromNode(QtQuick3D::Node node, vector3d localPosition)
Q_INVOKABLE QVector3D	mapDirectionToScene (const QVector3D &localDirection) const
	\qmlmethod vector3d QtQuick3D::Node::mapDirectionToScene(vector3d localDirection)
Q_INVOKABLE QVector3D	mapDirectionFromScene (const QVector3D &sceneDirection) const
	\qmlmethod vector3d QtQuick3D::Node::mapDirectionFromScene(vector3d sceneDirection)
Q_INVOKABLE QVector3D	mapDirectionToNode (const QQuick3DNode *node, const QVector3D &localDirection) const
	\qmlmethod vector3d QtQuick3D::Node::mapDirectionToNode(QtQuick3D::Node node, vector3d localDirection)
Q_INVOKABLE QVector3D	mapDirectionFromNode (const QQuick3DNode *node, const QVector3D &localDirection) const
	\qmlmethod vector3d QtQuick3D::Node::mapDirectionFromNode(QtQuick3D::Node node, vector3d localDirection)
void	markAllDirty () override
int	layers () const
	\qmlproperty int QtQuick3D::Node::layers
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.
virtual	~QObject ()
	Destroys the object, deleting all its child objects.
virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.
QString	objectName () const
Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.
void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.
bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.
bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.
bool	isQmlObjectType () const
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread *	thread () const
	Returns the thread in which the object lives.
bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
void	killTimer (Qt::TimerId id)
template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList &	children () const
	Returns a list of child objects.
void	setParent (QObject *parent)
	Makes the object a child of parent.
void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.
void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject receiver, const char member=nullptr) const
void	dumpObjectTree () const
	Dumps a tree of children to the debug output.
void	dumpObjectInfo () const
	Dumps information about signal connections, etc.
bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.
bool	setProperty (const char *name, QVariant &&value)
QVariant	property (const char *name) const
	Returns the value of the object's name property.
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
	Returns a pointer to the parent object.
bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.
Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()
virtual	~QQmlParserStatus ()

Public Attributes
const QVector3D &	direction
const QVector3D QQuick3DModel *model	const

Properties
QQuick3DXrOrigin *	xrOrigin
QQuick3DSceneEnvironment *	environment
bool	passthroughSupported
bool	passthroughEnabled
QQuick3DXrRuntimeInfo *	runtimeInfo
bool	quitOnSessionEnd
QQuick3DRenderStats *	renderStats
FoveationLevel	fixedFoveation
ReferenceSpace	referenceSpace
bool	depthSubmissionEnabled
bool	multiViewRenderingSupported
bool	multiViewRenderingEnabled
Properties inherited from QQuick3DNode
float	x
float	y
float	z
QQuaternion	rotation
QVector3D	eulerRotation
QVector3D	position
QVector3D	scale
QVector3D	pivot
float	opacity
bool	visible
QVector3D	forward
QVector3D	up
QVector3D	right
QVector3D	scenePosition
QQuaternion	sceneRotation
QVector3D	sceneScale
QMatrix4x4	sceneTransform
int	staticFlags
int	layers
Properties inherited from QQuick3DObject
QQuick3DObject *	parent
	\qmlproperty Object3D QtQuick3D::Object3D::parent This property holds the parent of the Object3D in a 3D scene.
Properties inherited from QObject
QString	objectName
	the name of this object

Friends
class	QQuick3DXrViewPrivate
class	QQuick3DXrVirtualMouse

Additional Inherited Members
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe
static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe
static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.
template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)
template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)
Protected Member Functions inherited from QQuick3DNode
void	connectNotify (const QMetaMethod &signal) override
void	disconnectNotify (const QMetaMethod &signal) override
void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.
	QQuick3DNode (QQuick3DNodePrivate &dd, QQuick3DNode *parent=nullptr)
QSSGRenderGraphObject *	updateSpatialNode (QSSGRenderGraphObject *node) override
virtual void	itemChange (ItemChange, const ItemChangeData &) override
Protected Member Functions inherited from QQuick3DObject
	QQuick3DObject (QQuick3DObjectPrivate &dd, QQuick3DObject *parent=nullptr)
void	classBegin () override
	Invoked after class creation, but before any properties have been set.
void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.
bool	isComponentComplete () const
virtual void	preSync ()
Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int	senderSignalIndex () const
int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.
virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 36 of file qquick3dxrview_p.h.

Member Enumeration Documentation

◆ FoveationLevel

enum QQuick3DXrView::FoveationLevel

Enumerator
NoFoveation
LowFoveation
MediumFoveation
HighFoveation

Definition at line 56 of file qquick3dxrview_p.h.

◆ ReferenceSpace

enum class QQuick3DXrView::ReferenceSpace

strong

Enumerator
ReferenceSpaceUnknown
ReferenceSpaceLocal
ReferenceSpaceStage
ReferenceSpaceLocalFloor

Definition at line 64 of file qquick3dxrview_p.h.

Constructor & Destructor Documentation

◆ QQuick3DXrView()

QQuick3DXrView::QQuick3DXrView ( )

explicit

\qmltype XrView \inherits Node \inqmlmodule QtQuick3D.Xr

Sets up the view for an Xr application.

An XrView sets up the view for an XR application. The following snippet is from the \l{\qxr Simple Example} and shows how to use the type.

\quotefromfile xr_simple/main.qml \printto XrOrigin

Definition at line 45 of file qquick3dxrview.cpp.

◆ ~QQuick3DXrView()

QQuick3DXrView::~QQuick3DXrView ( )

Definition at line 51 of file qquick3dxrview.cpp.

Member Function Documentation

◆ depthSubmissionEnabled()

bool QQuick3DXrView::depthSubmissionEnabled ( ) const

Definition at line 550 of file qquick3dxrview.cpp.

◆ depthSubmissionEnabledChanged

void QQuick3DXrView::depthSubmissionEnabledChanged ( )

signal

◆ environment()

QQuick3DSceneEnvironment * QQuick3DXrView::environment ( ) const

\qmlproperty SceneEnvironment QtQuick3D.Xr::XrView::environment \summary Holds the SceneEnvironment for the XR view.

Definition at line 80 of file qquick3dxrview.cpp.

◆ environmentChanged

void QQuick3DXrView::environmentChanged ( QQuick3DSceneEnvironment * environment )

signal

◆ fixedFoveation()

QQuick3DXrView::FoveationLevel QQuick3DXrView::fixedFoveation ( ) const

\qmlproperty enumeration QtQuick3D.Xr::XrView::fixedFoveation

Controls the level of fixed foveated rendering for the XrView. \default XrView.HighFoveation

Foveated rendering reduces GPU load by reducing image quality (resolution) in areas where the difference is less perceptible to the eye. With fixed foveated rendering, the areas with reduced visual fidelity are fixed and do not change. On some platforms, there is no concept of fixed foveated rendering or control over it. For example, VisionOS-based devices perform dynamic, eye-tracked foveation; thus, the value of this property is ignored in practice. Other devices, such as the Meta Quest 3, only support fixed foveation, which makes this property relevant.

The value can be one of: \value XrView.NoFoveation 0, no foveation. \value XrView.LowFoveation 1, low foveation. \value XrView.MediumFoveation 2, medium foveation. \value XrView.HighFoveation 3, high foveation.

Where supported, the default is HighFoveation. Therefore, changing this value in applications should be rarely needed in practice.

Definition at line 200 of file qquick3dxrview.cpp.

◆ fixedFoveationChanged

void QQuick3DXrView::fixedFoveationChanged ( )

signal

◆ frameReady

void QQuick3DXrView::frameReady ( )

signal

◆ initializeFailed

void QQuick3DXrView::initializeFailed ( const QString & errorString )

signal

◆ isMultiViewRenderingSupported()

bool QQuick3DXrView::isMultiViewRenderingSupported ( ) const

\qmlproperty bool QtQuick3D.Xr::XrView::multiViewRenderingSupported

This read-only property reports the availability of \l{Multiview Rendering}.

See also: multiViewRenderingEnabled

Definition at line 567 of file qquick3dxrview.cpp.

◆ isQuitOnSessionEndEnabled()

bool QQuick3DXrView::isQuitOnSessionEndEnabled ( ) const

\qmlproperty bool QtQuick3D.Xr::XrView::isQuitOnSessionEndEnabled

Holds whether the application should quit when the XR session ends.

Definition at line 218 of file qquick3dxrview.cpp.

◆ multiViewRenderingEnabled()

bool QQuick3DXrView::multiViewRenderingEnabled ( ) const

\qmlproperty bool QtQuick3D.Xr::XrView::multiViewRenderingEnabled

This is a read-only property that reports if \l{Multiview Rendering} is enabled for the XR view.

\default true

This property tells you if multiview rendering is actually in use at run time. When not supported, the value will flip back to false.

Enabling multiview rendering is recommended. It can improve performance and reduce CPU and GPU power usage. It defaults to disabled to ensure maximum compatibility. Developers are encouraged to verify that their application renders as expected with multiViewRenderingEnabled set to true and then leave it set afterward.

Note: Certain Qt Quick and Quick 3D features that involve shader code that is provided by the application may need this code to be modified to be multiview compatible. Examples of these are custom 2D and 3D materials and postprocessing effects. The \l {Multiview Rendering} documentation provides more information on this and how to disable multiview rendering.

See also: multiViewRenderingSupported {Multiview Rendering}

Definition at line 599 of file qquick3dxrview.cpp.

◆ multiViewRenderingEnabledChanged

void QQuick3DXrView::multiViewRenderingEnabledChanged ( )

signal

◆ passthroughEnabled()

bool QQuick3DXrView::passthroughEnabled ( ) const

\qmlproperty bool QtQuick3D.Xr::XrView::passthroughEnabled \summary Holds whether passthrough is enabled for the XR view.

Definition at line 94 of file qquick3dxrview.cpp.

◆ passthroughEnabledChanged

void QQuick3DXrView::passthroughEnabledChanged ( )

signal

◆ passthroughSupported()

bool QQuick3DXrView::passthroughSupported ( ) const

\qmlproperty bool QtQuick3D.Xr::XrView::passthroughSupported \summary Indicates whether passthrough is supported for the XR view.

Definition at line 150 of file qquick3dxrview.cpp.

◆ processTouch()

QVector3D QQuick3DXrView::processTouch	(	const QVector3D &	pos,
		int	pointId )

\qmlmethod vector3d XrView::processTouch(vector3d position, int pointId)

This method will search for an XrItem near position and send a virtual touch event with touch point ID pointId if position maps to a point on the surface.

The return value is the offset between position and the touched point on the surface. This can be used to prevent a hand model from passing through an XrItem.

See also: XrHandModel

Definition at line 440 of file qquick3dxrview.cpp.

◆ Q_REVISION()

QQuick3DXrView::Q_REVISION	(	6	,
		11	) const &

◆ quitOnSessionEndChanged

void QQuick3DXrView::quitOnSessionEndChanged ( )

signal

◆ rayPick()

QQuick3DPickResult QQuick3DXrView::rayPick	(	const QVector3D &	origin,
		const QVector3D &	direction ) const

\qmlmethod pickResult XrView::rayPick(vector3d origin, vector3d direction)

\qmlmethod pickResult XrView::rayPick(vector3d origin, vector3d direction, Model model)

This method will shoot a ray into the scene starting at origin and in direction and return information about the nearest intersection with an object in the scene.

For example, pass the position and forward vector of any object in a scene to see what object is in front of an item. This makes it possible to do picking from any point in the scene.

This method will "shoot" a ray into the scene starting at origin and in direction and return information about the intersection between the ray and the specified model.

Since: 6.11

Definition at line 368 of file qquick3dxrview.cpp.

◆ rayPickAll()

QList< QQuick3DPickResult > QQuick3DXrView::rayPickAll	(	const QVector3D &	origin,
		const QVector3D &	direction ) const

\qmlmethod List<pickResult> XrView::rayPickAll(vector3d origin, vector3d direction)

This method will shoot a ray into the scene starting at origin and in direction and return a list of information about the nearest intersections with objects in the scene. The list is presorted by distance from the origin along the direction vector with the nearest intersections appearing first and the furthest appearing last.

This can, for instance, be called with the position and forward vector of any object in a scene to see what objects are in front of an item. This makes it possible to do picking from any point in the scene.

Definition at line 387 of file qquick3dxrview.cpp.

◆ referenceSpace()

QQuick3DXrView::ReferenceSpace QQuick3DXrView::referenceSpace ( ) const

\qmlproperty enumeration QtQuick3D.Xr::XrView::referenceSpace

Gets or sets the reference space for the XR view.

It can be one of: \value XrView.ReferenceSpaceUnknown \value XrView.ReferenceSpaceLocal Origin is at the default view position (typically defined by a "reset view" operation). \value XrView.ReferenceSpaceStage Origin is at floor height in the center of the user's defined area. \value XrView.ReferenceSpaceLocalFloor Origin is at floor height, below the default view position.

ReferenceSpaceLocal is mainly useful for seated applications where the content is not positioned relative to the floor, for example floating menus. The content will move when the user resets the view.

ReferenceSpaceStage is mainly useful for room-scale applications where the user will move freely within the playing area. The content will not move when the user resets the view.

ReferenceSpaceLocalFloor is mainly useful for stationary applications (seated or standing) where the content is positioned relative to the floor. The content will move when the user resets the view.

\default XrView.ReferenceSpaceLocal

Definition at line 540 of file qquick3dxrview.cpp.

◆ referenceSpaceChanged

void QQuick3DXrView::referenceSpaceChanged ( )

signal

◆ registerXrItem()

void QQuick3DXrView::registerXrItem ( QQuick3DXrItem * newXrItem )

Definition at line 607 of file qquick3dxrview.cpp.

◆ renderStats()

QQuick3DRenderStats * QQuick3DXrView::renderStats ( ) const

\qmlproperty RenderStats QtQuick3D.Xr::XrView::renderStats \summary Holds rendering statistics for the XR view.

Definition at line 236 of file qquick3dxrview.cpp.

◆ runtimeInfo()

QQuick3DXrRuntimeInfo * QQuick3DXrView::runtimeInfo ( ) const

\qmlproperty QQuick3DXrRuntimeInfo QtQuick3D.Xr::XrView::runtimeInfo \summary Provides information about the XR runtime for the XR view.

Definition at line 104 of file qquick3dxrview.cpp.

◆ sessionEnded

void QQuick3DXrView::sessionEnded ( )

signal

◆ setDepthSubmissionEnabled

void QQuick3DXrView::setDepthSubmissionEnabled ( bool enable )

slot

\qmlproperty bool QtQuick3D.Xr::XrView::depthSubmissionEnabled

Controls whether submitting the depth buffer to the XR compositor is enabled. \default false

By default, the depth buffer used by the 3D scene in the XrView is not exposed to the XR compositor. However, in some platforms, depth submission is implicit and cannot be disabled or controlled by the application. An example of this is VisionOS. Changing this property has no effect on those platforms. Elsewhere, with OpenXR in particular, support depends on the OpenXR implementation used at run time.

It is always safe to set depthSubmissionEnabled to true. It will just have no effect when not supported by the underlying stack. To be sure, you can inspect the debug output to see if depth submission is in use. Submitting the depth buffer may improve reprojections that the XR compositor may perform. Reprojection could happen, for example, when the system cannot maintain the target frame rate and thus has to resort to predicting frame contents to improve and stabilize the user's perception of the scene and reduce possible motion sickness. However, the application and Qt have no control over data usage. It could also happen that submitting depth data has no practical effects and is ignored by the underlying XR runtime and compositor.

In practice, submitting the depth buffer implies rendering into a depth texture provided by the XR runtime instead of the intermediate texture/render buffer created and managed by Qt. Rendering into a depth texture has certain lower-level consequences that can have a performance impact:

When using \l{QtQuick3D::SceneEnvironment::antialiasingMode}{multisample antialiasing} (MSAA), enabling depth submission implies rendering into a multisample depth texture and resolving the samples into the non-multisample depth texture provided by the XR runtime. Without depth submission, the resolve step would not be necessary. In addition, some 3D APIs do not support resolving multisample depth-stencil data (see the \l{QRhi::ResolveDepthStencil} flag for details). Without this support, attempts to enable depth submission in combination with MSAA are gracefully ignored.

Even when MSAA is not used, enabling depth submission triggers writing out depth data with 3D APIs that have control over this. The store operation for depth/stencil data is typically indicated by Qt as unnecessary, which can have positive performance impacts on tiled GPU architectures. This is not done with depth submission because depth data must always be written out from Qt's perspective.

Note: We recommended that developers test their applications with depth submission enabled, evaluate the advantages and disadvantages, and make a conscious choice based on their testing if they wish to enable it or not.

Definition at line 668 of file qquick3dxrview.cpp.

◆ setEnvironment

void QQuick3DXrView::setEnvironment ( QQuick3DSceneEnvironment * environment )

slot

Definition at line 109 of file qquick3dxrview.cpp.

◆ setFixedFoveation()

void QQuick3DXrView::setFixedFoveation ( FoveationLevel level )

Definition at line 205 of file qquick3dxrview.cpp.

◆ setPassthroughEnabled

void QQuick3DXrView::setPassthroughEnabled ( bool enable )

slot

Definition at line 158 of file qquick3dxrview.cpp.

◆ setQuitOnSessionEnd

void QQuick3DXrView::setQuitOnSessionEnd ( bool enable )

slot

Definition at line 223 of file qquick3dxrview.cpp.

◆ setReferenceSpace()

void QQuick3DXrView::setReferenceSpace ( ReferenceSpace newReferenceSpace )

Definition at line 545 of file qquick3dxrview.cpp.

◆ setTouchpoint()

void QQuick3DXrView::setTouchpoint	(	QQuickItem *	target,
		const QPointF &	position,
		int	pointId,
		bool	pressed )

\qmlmethod XrView::setTouchpoint(Item target, point position, int pointId, bool pressed)

Sends a synthetic touch event to target, moving the touch point with ID pointId to position, with pressed determining if the point is pressed. Also sends the appropriate touch release event if pointId was previously active on a different item.

Definition at line 414 of file qquick3dxrview.cpp.

◆ setXROrigin

void QQuick3DXrView::setXROrigin ( QQuick3DXrOrigin * newXrOrigin )

slot

Definition at line 683 of file qquick3dxrview.cpp.

◆ touchpointState()

QVariantMap QQuick3DXrView::touchpointState ( int pointId ) const

Definition at line 502 of file qquick3dxrview.cpp.

◆ unregisterXrItem()

void QQuick3DXrView::unregisterXrItem ( QQuick3DXrItem * xrItem )

Definition at line 612 of file qquick3dxrview.cpp.

◆ xrManager()

QQuick3DXrManager * QQuick3DXrView::xrManager ( )

inline

Definition at line 109 of file qquick3dxrview_p.h.

◆ xrOrigin()

QQuick3DXrOrigin * QQuick3DXrView::xrOrigin ( ) const

\qmlproperty XrOrigin QtQuick3D.Xr::XrView::xrOrigin

Holds the active XR origin.

The XR origin is the point in the scene that is considered the origin of the XR coordinate system. The XR origin is used to position tracked objects like the camera and controllers in the scene. An application can have multiple XrOrigins but only one can be active at a time.

Note: This property must be set for the scene to be rendered in XR.

See also: XrOrigin

Definition at line 70 of file qquick3dxrview.cpp.

QQuick3DXrRuntimeInfo * QQuick3DXrView::runtimeInfo

read

Definition at line 44 of file qquick3dxrview_p.h.

◆ xrOrigin

QQuick3DXrOrigin * QQuick3DXrView::xrOrigin

readwrite

Definition at line 40 of file qquick3dxrview_p.h.

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

qtquick3d/src/xr/quick3dxr/qquick3dxrview_p.h (9f23c13b34caef433af119c37490b10c772917ea)
qtquick3d/src/xr/quick3dxr/qquick3dxrview.cpp (9f23c13b34caef433af119c37490b10c772917ea)

Classes

Public Types

Public Slots

Signals

Public Member Functions

Public Attributes

Properties

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ FoveationLevel

◆ ReferenceSpace

Constructor & Destructor Documentation

◆ QQuick3DXrView()

◆ ~QQuick3DXrView()

Member Function Documentation

◆ depthSubmissionEnabled()

◆ depthSubmissionEnabledChanged

◆ environment()

◆ environmentChanged

◆ fixedFoveation()

◆ fixedFoveationChanged

◆ frameReady

◆ initializeFailed

◆ isMultiViewRenderingSupported()

◆ isQuitOnSessionEndEnabled()

◆ multiViewRenderingEnabled()

◆ multiViewRenderingEnabledChanged

◆ passthroughEnabled()

◆ passthroughEnabledChanged

◆ passthroughSupported()

◆ processTouch()

◆ Q_REVISION()

◆ quitOnSessionEndChanged

◆ rayPick()

◆ rayPickAll()

◆ referenceSpace()

◆ referenceSpaceChanged

◆ registerXrItem()

◆ renderStats()

◆ runtimeInfo()

◆ sessionEnded

◆ setDepthSubmissionEnabled

◆ setEnvironment

◆ setFixedFoveation()

◆ setPassthroughEnabled

◆ setQuitOnSessionEnd

◆ setReferenceSpace()

◆ setTouchpoint()

◆ setXROrigin

◆ touchpointState()

◆ unregisterXrItem()

◆ xrManager()

◆ xrOrigin()

◆ xrOriginChanged

Friends And Related Symbol Documentation

◆ QQuick3DXrViewPrivate

◆ QQuick3DXrVirtualMouse

Member Data Documentation

◆ const

◆ direction

Property Documentation

◆ depthSubmissionEnabled

◆ environment

◆ fixedFoveation

◆ multiViewRenderingEnabled

◆ multiViewRenderingSupported

◆ passthroughEnabled

◆ passthroughSupported

◆ quitOnSessionEnd

◆ referenceSpace

◆ renderStats

◆ runtimeInfo

◆ xrOrigin