#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	setEnablePassthrough (bool enable)

void	setQuitOnSessionEnd (bool enable)

void	setEnableDepthSubmission (bool enable)
	\qmlproperty bool QtQuick3D.Xr::XrView::enableDepthSubmission

void	setEnableMultiViewRendering (bool enable)

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)

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 (QQuick3DXrOrigin *xrOrigin)

void	environmentChanged (QQuick3DSceneEnvironment *environment)

void	enablePassthroughChanged (bool enable)

void	quitOnSessionEndChanged ()

void	fixedFoveationChanged ()

void	frameReady (QRhiTexture *colorBuffer)

void	referenceSpaceChanged ()

void	enableDepthSubmissionChanged ()

void	enableMultiViewRenderingChanged ()

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 ()

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

QQuick3DXrHandInput *	leftHandInput () const
	\qmlproperty XrHandInput QtQuick3D.Xr::XrView::leftHandInput

QQuick3DXrHandInput *	rightHandInput () const
	\qmlproperty XrHandInput QtQuick3D.Xr::XrView::rightHandInput

QQuick3DXrHandTrackerInput *	leftHandTrackerInput () const
	\qmlproperty XrHandTrackerInput QtQuick3D.Xr::XrView::leftHandTrackerInput

QQuick3DXrHandTrackerInput *	rightHandTrackerInput () const
	\qmlproperty XrHandTrackerInput QtQuick3D.Xr::XrView::rightHandTrackerInput

bool	isPassthroughSupported () const
	\qmlproperty bool QtQuick3D.Xr::XrView::isPassthroughSupported

bool	isPassthroughEnabled () const
	\qmlproperty bool QtQuick3D.Xr::XrView::isPassthroughEnabled

FoveationLevel	fixedFoveation () const
	\qmlproperty enumeration QtQuick3D.Xr::XrView::fixedFoveation

void	setFixedFoveation (FoveationLevel level)

QOpenXRRuntimeInfo *	runtimeInfo () const
	\qmlproperty QOpenXRRuntimeInfo QtQuick3D.Xr::XrView::runtimeInfo

bool	isQuitOnSessionEndEnabled () const
	\qmlproperty bool QtQuick3D.Xr::XrView::isQuitOnSessionEndEnabled

QQuick3DRenderStats *	renderStats () const
	\qmlproperty RenderStats QtQuick3D.Xr::XrView::renderStats

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_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	isDepthSubmissionEnabled () const

void	registerXrItem (QQuick3DXrItem *newXrItem)

void	unregisterXrItem (QQuick3DXrItem *xrItem)

bool	isMultiViewRenderingSupported () const
	\qmlproperty bool QtQuick3D.Xr::XrView::multiViewRenderingSupported

bool	isMultiViewRenderingEnabled () const
	\qmlproperty bool QtQuick3D.Xr::XrView::enableMultiViewRendering

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

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	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 ()

Properties
QQuick3DXrOrigin *	xrOrigin

QQuick3DSceneEnvironment *	environment

QQuick3DXrHandInput *	leftHandInput

QQuick3DXrHandInput *	rightHandInput

QQuick3DXrHandTrackerInput *	leftHandTrackerInput

QQuick3DXrHandTrackerInput *	rightHandTrackerInput

bool	passthroughSupported

bool	enablePassthrough

QOpenXRRuntimeInfo *	runtimeInfo

bool	quitOnSessionEnd

QQuick3DRenderStats *	renderStats

FoveationLevel	fixedFoveation

ReferenceSpace	referenceSpace

bool	enableDepthSubmission

bool	multiViewRenderingSupported

bool	enableMultiViewRendering

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

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	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 41 of file qquick3dxrview_p.h.

Member Enumeration Documentation

◆ FoveationLevel

enum QQuick3DXrView::FoveationLevel

Enumerator
NoFoveation
LowFoveation
MediumFoveation
HighFoveation

Definition at line 65 of file qquick3dxrview_p.h.

◆ ReferenceSpace

enum class QQuick3DXrView::ReferenceSpace

strong

Enumerator
ReferenceSpaceUnknown
ReferenceSpaceLocal
ReferenceSpaceStage
ReferenceSpaceLocalFloor

Definition at line 73 of file qquick3dxrview_p.h.

Constructor & Destructor Documentation

◆ QQuick3DXrView()

QT_BEGIN_NAMESPACE 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. \quotefromfile xr_simple/main.qml \printto XrOrigin

Definition at line 25 of file qquick3dxrview.cpp.

◆ ~QQuick3DXrView()

QQuick3DXrView::~QQuick3DXrView ( )

Definition at line 31 of file qquick3dxrview.cpp.

Member Function Documentation

◆ enableDepthSubmissionChanged

void QQuick3DXrView::enableDepthSubmissionChanged ( )

signal

Referenced by setEnableDepthSubmission().

Here is the caller graph for this function:

◆ enableMultiViewRenderingChanged

void QQuick3DXrView::enableMultiViewRenderingChanged ( )

signal

Referenced by setEnableMultiViewRendering().

Here is the caller graph for this function:

◆ enablePassthroughChanged

void QQuick3DXrView::enablePassthroughChanged ( bool enable )

signal

Referenced by setEnablePassthrough().

Here is the caller graph for this function:

◆ environment()

QQuick3DSceneEnvironment * QQuick3DXrView::environment ( ) const

\qmlproperty SceneEnvironment QtQuick3D.Xr::XrView::environment

Holds the SceneEnvironment for the XR view.

Definition at line 51 of file qquick3dxrview.cpp.

References QQuick3DViewport::environment.

◆ environmentChanged

void QQuick3DXrView::environmentChanged ( QQuick3DSceneEnvironment * environment )

signal

Referenced by setEnvironment().

Here is the caller graph for this function:

◆ fixedFoveation()

QQuick3DXrView::FoveationLevel QQuick3DXrView::fixedFoveation ( ) const

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

Controls the level of fixed foveated rendering for the XrView.

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, or there is no control over, fixed foveated rendering. For example, VisionOS-based devices perform dynamic, eye-tracked foveation, and thus the value of this property is ignored in practice. Whereas other devices, such as the Meta Quest 3, only have support for fixed foveation, in which case this property becomes 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 226 of file qquick3dxrview.cpp.

References QQuick3DXrManager::getFixedFoveationLevel().

Here is the call graph for this function:

◆ fixedFoveationChanged

void QQuick3DXrView::fixedFoveationChanged ( )

signal

Referenced by setFixedFoveation().

Here is the caller graph for this function:

◆ frameReady

void QQuick3DXrView::frameReady ( QRhiTexture * colorBuffer )

signal

◆ initializeFailed

void QQuick3DXrView::initializeFailed ( const QString & errorString )

signal

◆ isDepthSubmissionEnabled()

bool QQuick3DXrView::isDepthSubmissionEnabled ( ) const

Definition at line 549 of file qquick3dxrview.cpp.

References QQuick3DXrManager::isDepthSubmissionEnabled(), QQuick3DXrManager::isValid(), and qWarning.

Here is the call graph for this function:

◆ isMultiViewRenderingEnabled()

bool QQuick3DXrView::isMultiViewRenderingEnabled ( ) const

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

Gets or sets whether \l{Multiview Rendering} is enabled for the XR view.

The default value is false. Changing the value to true has an effect only when \l multiViewRenderingSupported is true. See \l{Multiview Rendering} for details.

This property can also be used to query whether multiview rendering is really in use at run time. When not supported, the value will flip back to false.

Note: Changing the value dynamically, while the scene is already up and running, is possible, but not recommended, because enabling or disabling multiview mode involves releasing and recreating certain graphics and XR resources. Depending on the platform and headset, this then may cause visual effects that are undesirable, for example the scene may disappear and reappear.; Enabling multiview rendering is recommended, in general. It can improve performance, reduce CPU and GPU load, as well as reduce power consumption. It defaults to disabled in order to ensure maximum compatibility. Developers are encouraged to verify that their application renders as expected with enableMultiViewRendering set to true, and then leave it set afterwards.

Certain Qt Quick and Quick 3D features that involve application-provided shader code, in particular custom 2D and 3D materials and postprocessing effects, require awareness from the developers in order to make the application-provided shader assets multiview-compatible. See \l{Multiview Rendering} for details.

See also: multiViewRenderingSupported

Definition at line 609 of file qquick3dxrview.cpp.

References QQuick3DXrManager::isMultiViewRenderingEnabled(), and QQuick3DXrManager::isValid().

Here is the call graph for this function:

◆ isMultiViewRenderingSupported()

bool QQuick3DXrView::isMultiViewRenderingSupported ( ) const

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

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

See also: enableMultiViewRendering

Definition at line 566 of file qquick3dxrview.cpp.

References QQuick3DXrManager::isMultiViewRenderingSupported(), and QQuick3DXrManager::isValid().

Here is the call graph for this function:

◆ isPassthroughEnabled()

bool QQuick3DXrView::isPassthroughEnabled ( ) const

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

Holds whether passthrough is enabled for the XR view.

Definition at line 121 of file qquick3dxrview.cpp.

References QQuick3DXrManager::isPassthroughEnabled().

Here is the call graph for this function:

◆ isPassthroughSupported()

bool QQuick3DXrView::isPassthroughSupported ( ) const

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

Indicates whether passthrough is supported for the XR view.

Definition at line 174 of file qquick3dxrview.cpp.

References QQuick3DXrManager::isValid().

Here is the call graph for this function:

◆ 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 244 of file qquick3dxrview.cpp.

◆ leftHandInput()

QQuick3DXrHandInput * QQuick3DXrView::leftHandInput ( ) const

\qmlproperty XrHandInput QtQuick3D.Xr::XrView::leftHandInput

Provides access to the left hand input for the XR view.

Definition at line 61 of file qquick3dxrview.cpp.

References QQuick3DXrInputManager::leftHandInput().

Here is the call graph for this function:

◆ leftHandTrackerInput()

QQuick3DXrHandTrackerInput * QQuick3DXrView::leftHandTrackerInput ( ) const

\qmlproperty XrHandTrackerInput QtQuick3D.Xr::XrView::leftHandTrackerInput

Provides access to the left hand tracker input for the XR view.

Definition at line 89 of file qquick3dxrview.cpp.

References QQuick3DXrInputManager::leftHandTrackerInput().

Here is the call graph for this function:

◆ 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 450 of file qquick3dxrview.cpp.

References QList< T >::isEmpty(), item, QQuick3DXrView::XrTouchState::points, pos, and state.

Here is the call graph for this function:

◆ quitOnSessionEndChanged

void QQuick3DXrView::quitOnSessionEndChanged ( )

signal

Referenced by setQuitOnSessionEnd().

Here is the caller graph for this function:

◆ rayPick()

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

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

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.

This can, for instance, be called with 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.

Definition at line 391 of file qquick3dxrview.cpp.

References direction.

◆ 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 410 of file qquick3dxrview.cpp.

References direction.

◆ 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 \value XrView.ReferenceSpaceStage \value XrView.ReferenceSpaceLocalFloor

Definition at line 539 of file qquick3dxrview.cpp.

References QQuick3DXrManager::getReferenceSpace().

Here is the call graph for this function:

◆ referenceSpaceChanged

void QQuick3DXrView::referenceSpaceChanged ( )

signal

◆ registerXrItem()

void QQuick3DXrView::registerXrItem ( QQuick3DXrItem * newXrItem )

Definition at line 617 of file qquick3dxrview.cpp.

References QList< T >::append().

Here is the call graph for this function:

◆ renderStats()

QQuick3DRenderStats * QQuick3DXrView::renderStats ( ) const

\qmlproperty RenderStats QtQuick3D.Xr::XrView::renderStats

Holds rendering statistics for the XR view.

Definition at line 262 of file qquick3dxrview.cpp.

References QQuick3DViewport::renderStats.

◆ rightHandInput()

QQuick3DXrHandInput * QQuick3DXrView::rightHandInput ( ) const

\qmlproperty XrHandInput QtQuick3D.Xr::XrView::rightHandInput

Provides access to the right hand input for the XR view.

Definition at line 75 of file qquick3dxrview.cpp.

References QQuick3DXrInputManager::rightHandInput().

Here is the call graph for this function:

◆ rightHandTrackerInput()

QQuick3DXrHandTrackerInput * QQuick3DXrView::rightHandTrackerInput ( ) const

\qmlproperty XrHandTrackerInput QtQuick3D.Xr::XrView::rightHandTrackerInput

Provides access to the right hand tracker input for the XR view.

Definition at line 103 of file qquick3dxrview.cpp.

References QQuick3DXrInputManager::rightHandTrackerInput().

Here is the call graph for this function:

◆ runtimeInfo()

QOpenXRRuntimeInfo * QQuick3DXrView::runtimeInfo ( ) const

\qmlproperty QOpenXRRuntimeInfo QtQuick3D.Xr::XrView::runtimeInfo

Provides information about the XR runtime for the XR view.

Definition at line 131 of file qquick3dxrview.cpp.

◆ sessionEnded

void QQuick3DXrView::sessionEnded ( )

signal

◆ setEnableDepthSubmission

void QQuick3DXrView::setEnableDepthSubmission ( bool enable )

slot

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

Gets or sets whether submitting the depth buffer to the XR compositor is enabled.

By default the value is false and 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 enableDepthSubmission to true. It will just have no effect when not support by the underlying stack. Inspect the debug output to see if depth submission is in use.

Submitting the depth buffer may improve reprojections that may be performed by the XR compositor. This could happen for example when the system cannot maintain the target frame rate, and thus has to resort to predicting frame contents, in order to improve and stabilize the user's perception of the scene and reduce possibly nauseating effects. However, the application and Qt has no control over the usage of the data. It could also happen that submitting depth data has no practical effects and is simply 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/renderbuffer created and managed by Qt. This has certain lower-level consequences that can have a performance impact:

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

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 normally indicated by Qt as not necessary, which can have positive effects for performance on tiled GPU architectures in particular. With depth submission this is not done, because depth data has to then be written out always from Qt's perspective.

Note: It is 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 680 of file qquick3dxrview.cpp.

References emit, enableDepthSubmissionChanged(), QQuick3DXrManager::isDepthSubmissionEnabled(), QQuick3DXrManager::isValid(), qWarning, and QQuick3DXrManager::setDepthSubmissionEnabled().

Here is the call graph for this function:

◆ setEnableMultiViewRendering

void QQuick3DXrView::setEnableMultiViewRendering ( bool enable )

slot

Definition at line 695 of file qquick3dxrview.cpp.

References emit, enableMultiViewRenderingChanged(), QQuick3DXrManager::isMultiViewRenderingEnabled(), QQuick3DXrManager::isValid(), qWarning, and QQuick3DXrManager::setMultiviewRenderingEnabled().

Here is the call graph for this function:

◆ setEnablePassthrough

void QQuick3DXrView::setEnablePassthrough ( bool enable )

slot

Definition at line 182 of file qquick3dxrview.cpp.

References emit, enablePassthroughChanged(), QQuick3DXrManager::isPassthroughEnabled(), QQuick3DXrManager::isValid(), qWarning, and QQuick3DXrManager::setPassthroughEnabled().

Here is the call graph for this function:

◆ setEnvironment

void QQuick3DXrView::setEnvironment ( QQuick3DSceneEnvironment * environment )

slot

Definition at line 136 of file qquick3dxrview.cpp.

References QQuick3DSceneEnvironment::antialiasingModeChanged(), QQuick3DSceneEnvironment::antialiasingQualityChanged(), QQuick3DSceneEnvironment::backgroundModeChanged(), QQuick3DSceneEnvironment::clearColorChanged(), QObject::connect(), disconnect(), emit, QQuick3DViewport::environment, environment, environmentChanged(), and QQuick3DViewport::setEnvironment().

Here is the call graph for this function:

◆ setFixedFoveation()

void QQuick3DXrView::setFixedFoveation ( FoveationLevel level )

Definition at line 231 of file qquick3dxrview.cpp.

References emit, fixedFoveationChanged(), QQuick3DXrManager::getFixedFoveationLevel(), and QQuick3DXrManager::setFixedFoveationLevel().

Here is the call graph for this function:

◆ setQuitOnSessionEnd

void QQuick3DXrView::setQuitOnSessionEnd ( bool enable )

slot

Definition at line 249 of file qquick3dxrview.cpp.

References emit, and quitOnSessionEndChanged().

Here is the call graph for this function:

◆ setReferenceSpace()

void QQuick3DXrView::setReferenceSpace ( ReferenceSpace newReferenceSpace )

Definition at line 544 of file qquick3dxrview.cpp.

References QQuick3DXrManager::setReferenceSpace().

Here is the call graph for this function:

◆ 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 424 of file qquick3dxrview.cpp.

References QQuick3DNode::position.

◆ touchpointState()

QVariantMap QQuick3DXrView::touchpointState ( int pointId ) const

Definition at line 512 of file qquick3dxrview.cpp.

References QHash< Key, T >::const_iterator, QHash< Key, T >::constFind(), QVariant::fromValue(), it, QQuick3DXrView::XrTouchState::points, Q_TOUCHPOINT_STATE, and QStringLiteral.

Here is the call graph for this function:

◆ unregisterXrItem()

void QQuick3DXrView::unregisterXrItem ( QQuick3DXrItem * xrItem )

Definition at line 622 of file qquick3dxrview.cpp.

References QList< T >::removeAll().

Here is the call graph for this function:

◆ xrOrigin()

QQuick3DXrOrigin * QQuick3DXrView::xrOrigin ( ) const

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

Holds the XR origin.

Definition at line 41 of file qquick3dxrview.cpp.

◆ xrOriginChanged

void QQuick3DXrView::xrOriginChanged ( QQuick3DXrOrigin * xrOrigin )

signal

Friends And Related Symbol Documentation

◆ QQuick3DXrVirtualMouse

friend class QQuick3DXrVirtualMouse

friend

Definition at line 159 of file qquick3dxrview_p.h.

Property Documentation

◆ enableDepthSubmission

bool QQuick3DXrView::enableDepthSubmission

readwrite

Definition at line 58 of file qquick3dxrview_p.h.

◆ enableMultiViewRendering

bool QQuick3DXrView::enableMultiViewRendering

readwrite

Definition at line 60 of file qquick3dxrview_p.h.

◆ enablePassthrough

bool QQuick3DXrView::enablePassthrough

readwrite

Definition at line 52 of file qquick3dxrview_p.h.

◆ environment

QQuick3DSceneEnvironment * QQuick3DXrView::environment

readwrite

Definition at line 46 of file qquick3dxrview_p.h.

Referenced by setEnvironment().

◆ fixedFoveation

FoveationLevel QQuick3DXrView::fixedFoveation

readwrite

Definition at line 56 of file qquick3dxrview_p.h.

◆ leftHandInput

QQuick3DXrHandInput * QQuick3DXrView::leftHandInput

read

Definition at line 47 of file qquick3dxrview_p.h.

◆ leftHandTrackerInput

QQuick3DXrHandTrackerInput * QQuick3DXrView::leftHandTrackerInput

read

Definition at line 49 of file qquick3dxrview_p.h.

◆ multiViewRenderingSupported

bool QQuick3DXrView::multiViewRenderingSupported

read

Definition at line 59 of file qquick3dxrview_p.h.

◆ passthroughSupported

bool QQuick3DXrView::passthroughSupported

read

Definition at line 51 of file qquick3dxrview_p.h.

◆ quitOnSessionEnd

bool QQuick3DXrView::quitOnSessionEnd

readwrite

Definition at line 54 of file qquick3dxrview_p.h.

◆ referenceSpace

ReferenceSpace QQuick3DXrView::referenceSpace

readwrite

Definition at line 57 of file qquick3dxrview_p.h.

◆ renderStats

QQuick3DRenderStats * QQuick3DXrView::renderStats

read

Definition at line 55 of file qquick3dxrview_p.h.

◆ rightHandInput

QQuick3DXrHandInput * QQuick3DXrView::rightHandInput

read

Definition at line 48 of file qquick3dxrview_p.h.

◆ rightHandTrackerInput

QQuick3DXrHandTrackerInput * QQuick3DXrView::rightHandTrackerInput

read

Definition at line 50 of file qquick3dxrview_p.h.

◆ runtimeInfo

QOpenXRRuntimeInfo * QQuick3DXrView::runtimeInfo

read

Definition at line 53 of file qquick3dxrview_p.h.

◆ xrOrigin

QQuick3DXrOrigin * QQuick3DXrView::xrOrigin

read

Definition at line 45 of file qquick3dxrview_p.h.

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

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

Classes

Public Types

Public Slots

Signals

Public Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ FoveationLevel

◆ ReferenceSpace

Constructor & Destructor Documentation

◆ QQuick3DXrView()

◆ ~QQuick3DXrView()

Member Function Documentation

◆ enableDepthSubmissionChanged

◆ enableMultiViewRenderingChanged

◆ enablePassthroughChanged

◆ environment()

◆ environmentChanged

◆ fixedFoveation()

◆ fixedFoveationChanged

◆ frameReady

◆ initializeFailed

◆ isDepthSubmissionEnabled()

◆ isMultiViewRenderingEnabled()

◆ isMultiViewRenderingSupported()

◆ isPassthroughEnabled()

◆ isPassthroughSupported()

◆ isQuitOnSessionEndEnabled()

◆ leftHandInput()

◆ leftHandTrackerInput()

◆ processTouch()

◆ quitOnSessionEndChanged

◆ rayPick()

◆ rayPickAll()

◆ referenceSpace()

◆ referenceSpaceChanged

◆ registerXrItem()

◆ renderStats()

◆ rightHandInput()

◆ rightHandTrackerInput()

◆ runtimeInfo()

◆ sessionEnded

◆ setEnableDepthSubmission

◆ setEnableMultiViewRendering

◆ setEnablePassthrough

◆ setEnvironment

◆ setFixedFoveation()

◆ setQuitOnSessionEnd

◆ setReferenceSpace()

◆ setTouchpoint()

◆ touchpointState()

◆ unregisterXrItem()

◆ xrOrigin()

◆ xrOriginChanged

Friends And Related Symbol Documentation

◆ QQuick3DXrVirtualMouse

Property Documentation

◆ enableDepthSubmission

◆ enableMultiViewRendering

◆ enablePassthrough

◆ environment

◆ fixedFoveation

◆ leftHandInput

◆ leftHandTrackerInput

◆ multiViewRenderingSupported

◆ passthroughSupported

◆ quitOnSessionEnd

◆ referenceSpace

◆ renderStats

◆ rightHandInput

◆ rightHandTrackerInput

◆ runtimeInfo

◆ xrOrigin