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
CompositorLayer Class Reference
Inheritance diagram for CompositorLayer:
Collaboration diagram for CompositorLayer:

Public Types

enum  Event : EventT {
  Render = QEvent::User + 1 , Pause , Stop , Pulse ,
  Render = QEvent::User + 1 , Pause , Stop , Pulse
}
enum  Event : EventT {
  Render = QEvent::User + 1 , Pause , Stop , Pulse ,
  Render = QEvent::User + 1 , Pause , Stop , Pulse
}
using EventT = std::underlying_type_t<QEvent::Type>
using EventT = std::underlying_type_t<QEvent::Type>

Signals

void layerRendererReady ()
void layerRendererChanged ()
void renderStateChanged (QQuick3DXrManagerPrivate::RenderState)
void arStateChanged (QQuick3DXrManagerPrivate::ArTrackingState)
void layerRendererReady ()
void layerRendererChanged ()
void renderStateChanged (QQuick3DXrManagerPrivate::RenderState)
void arStateChanged (QQuick3DXrManagerPrivate::ArTrackingState)
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

 CompositorLayer ()=default
 ~CompositorLayer () final
void configure (cp_layer_renderer_capabilities_t capabilities, cp_layer_renderer_configuration_t configuration) const override
void render (cp_layer_renderer_t renderer) override
void handleSpatialEvents (const QJsonObject &events) override
bool isInitialized () const
bool isMultiviewSupported () const
bool isMultiviewEnabled () const
bool isFoveationSupported () const
bool isFoveationEnabled () const
cp_layer_renderer_t layerRenderer () const
void getDefaultDepthRange (float &near, float &far) const
void init (QQuick3DXrManagerPrivate *xrManager)
void teardown ()
void stopArSession ()
QMutex & renderLock ()
bool waitForSyncToComplete ()
 CompositorLayer ()=default
 ~CompositorLayer () final
void configure (cp_layer_renderer_capabilities_t capabilities, cp_layer_renderer_configuration_t configuration) const override
void render (cp_layer_renderer_t renderer) override
void handleSpatialEvents (const QJsonObject &events) override
bool isInitialized () const
bool isMultiviewSupported () const
bool isMultiviewEnabled () const
bool isFoveationSupported () const
bool isFoveationEnabled () const
cp_layer_renderer_t layerRenderer () const
void getDefaultDepthRange (float &near, float &far) const
void init (QQuick3DXrManagerPrivate *xrManager)
void teardown ()
void stopArSession ()
QMutex & renderLock ()
bool waitForSyncToComplete ()
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 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.

Static Public Member Functions

static constexpr QEvent::Type asQEvent (CompositorLayer::Event event)
static bool supportsLayoutType (cp_layer_renderer_capabilities_t capabilities, cp_layer_renderer_layout layout)
static Q_INVOKABLE void destroy (QQuick3DXrManagerPrivate *mngr, QQuickWindow *window, CompositorLayer *compositorLayer)
static constexpr QEvent::Type asQEvent (CompositorLayer::Event event)
static bool supportsLayoutType (cp_layer_renderer_capabilities_t capabilities, cp_layer_renderer_layout layout)
static Q_INVOKABLE void destroy (QQuick3DXrManagerPrivate *mngr, QQuickWindow *window, CompositorLayer *compositorLayer)
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

bool event (QEvent *event) override
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
bool event (QEvent *event) override
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
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.
virtual void connectNotify (const QMetaMethod &signal)
virtual void disconnectNotify (const QMetaMethod &signal)
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Friends

bool QQuick3DXrManagerPrivate::renderFrameImpl (QMutexLocker< QMutex > &locker, QWaitCondition &waitCondition)
void QQuick3DXrManagerPrivate::update ()
bool QQuick3DXrManagerPrivate::renderFrameImpl (QMutexLocker< QMutex > &locker, QWaitCondition &waitCondition)
void QQuick3DXrManagerPrivate::update ()

Additional Inherited Members

Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
Properties inherited from QObject
QString objectName
 the name of this object
Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 \macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 42 of file qquick3dxrmanager_visionos.mm.

Member Typedef Documentation

◆ EventT [1/2]

using CompositorLayer::EventT = std::underlying_type_t<QEvent::Type>

Definition at line 57 of file qquick3dxrmanager_visionos.mm.

◆ EventT [2/2]

using CompositorLayer::EventT = std::underlying_type_t<QEvent::Type>

Definition at line 57 of file qquick3dxrmanager_visionos.mm.

Member Enumeration Documentation

◆ Event [1/2]

enum CompositorLayer::Event : EventT
Enumerator
Render 
Pause 
Stop 
Pulse 
Render 
Pause 
Stop 
Pulse 

Definition at line 58 of file qquick3dxrmanager_visionos.mm.

◆ Event [2/2]

enum CompositorLayer::Event : EventT
Enumerator
Render 
Pause 
Stop 
Pulse 
Render 
Pause 
Stop 
Pulse 

Definition at line 58 of file qquick3dxrmanager_visionos.mm.

Constructor & Destructor Documentation

◆ CompositorLayer() [1/2]

CompositorLayer::CompositorLayer ( )
default

◆ ~CompositorLayer() [1/2]

CompositorLayer::~CompositorLayer ( )
inlinefinal

Definition at line 47 of file qquick3dxrmanager_visionos.mm.

◆ CompositorLayer() [2/2]

CompositorLayer::CompositorLayer ( )
default

◆ ~CompositorLayer() [2/2]

CompositorLayer::~CompositorLayer ( )
inlinefinal

Definition at line 47 of file qquick3dxrmanager_visionos.mm.

Member Function Documentation

◆ arStateChanged [1/2]

void CompositorLayer::arStateChanged ( QQuick3DXrManagerPrivate::ArTrackingState )
signal

◆ arStateChanged [2/2]

void CompositorLayer::arStateChanged ( QQuick3DXrManagerPrivate::ArTrackingState )
signal

◆ asQEvent() [1/2]

constexpr QEvent::Type CompositorLayer::asQEvent ( CompositorLayer::Event event)
inlinestaticconstexpr

Definition at line 66 of file qquick3dxrmanager_visionos.mm.

◆ asQEvent() [2/2]

constexpr QEvent::Type CompositorLayer::asQEvent ( CompositorLayer::Event event)
inlinestaticconstexpr

Definition at line 66 of file qquick3dxrmanager_visionos.mm.

◆ configure() [1/2]

void CompositorLayer::configure ( cp_layer_renderer_capabilities_t capabilities,
cp_layer_renderer_configuration_t configuration ) const
inlineoverride

Definition at line 78 of file qquick3dxrmanager_visionos.mm.

References QQuick3DXrManager::isMultiviewRenderingDisabled(), and qssgDisableFoveation().

Here is the call graph for this function:

◆ configure() [2/2]

void CompositorLayer::configure ( cp_layer_renderer_capabilities_t capabilities,
cp_layer_renderer_configuration_t configuration ) const
inlineoverride

Definition at line 78 of file qquick3dxrmanager_visionos.mm.

◆ destroy() [1/2]

Q_INVOKABLE void CompositorLayer::destroy ( QQuick3DXrManagerPrivate * mngr,
QQuickWindow * window,
CompositorLayer * compositorLayer )
inlinestatic

Definition at line 199 of file qquick3dxrmanager_visionos.mm.

◆ destroy() [2/2]

Q_INVOKABLE void CompositorLayer::destroy ( QQuick3DXrManagerPrivate * mngr,
QQuickWindow * window,
CompositorLayer * compositorLayer )
inlinestatic

Definition at line 199 of file qquick3dxrmanager_visionos.mm.

◆ event() [1/2]

bool CompositorLayer::event ( QEvent * e)
inlineoverrideprotectedvirtual

This virtual function receives events to an object and should return true if the event e was recognized and processed.

The event() function can be reimplemented to customize the behavior of an object.

Make sure you call the parent event class implementation for all the events you did not handle.

Example:

class MyClass : public QWidget
{
Q_OBJECT
public:
MyClass(QWidget *parent = nullptr);
~MyClass();
bool event(QEvent* ev) override
{
if (ev->type() == QEvent::PolishRequest) {
// overwrite handling of PolishRequest if any
doThings();
return true;
} else if (ev->type() == QEvent::Show) {
// complement handling of Show if any
doThings2();
QWidget::event(ev);
return true;
}
// Make sure the rest of events are handled
return QWidget::event(ev);
}
};
See also
installEventFilter(), timerEvent(), QCoreApplication::sendEvent(), QCoreApplication::postEvent()

Reimplemented from QObject.

Definition at line 235 of file qquick3dxrmanager_visionos.mm.

References Pause, Pulse, Render, and Stop.

◆ event() [2/2]

bool CompositorLayer::event ( QEvent * e)
inlineoverrideprotectedvirtual

This virtual function receives events to an object and should return true if the event e was recognized and processed.

The event() function can be reimplemented to customize the behavior of an object.

Make sure you call the parent event class implementation for all the events you did not handle.

Example:

class MyClass : public QWidget
{
Q_OBJECT
public:
MyClass(QWidget *parent = nullptr);
~MyClass();
bool event(QEvent* ev) override
{
if (ev->type() == QEvent::PolishRequest) {
// overwrite handling of PolishRequest if any
doThings();
return true;
} else if (ev->type() == QEvent::Show) {
// complement handling of Show if any
doThings2();
QWidget::event(ev);
return true;
}
// Make sure the rest of events are handled
return QWidget::event(ev);
}
};
See also
installEventFilter(), timerEvent(), QCoreApplication::sendEvent(), QCoreApplication::postEvent()

Reimplemented from QObject.

Definition at line 235 of file qquick3dxrmanager_visionos.mm.

◆ getDefaultDepthRange() [1/2]

void CompositorLayer::getDefaultDepthRange ( float & near,
float & far ) const
inline

Definition at line 153 of file qquick3dxrmanager_visionos.mm.

◆ getDefaultDepthRange() [2/2]

void CompositorLayer::getDefaultDepthRange ( float & near,
float & far ) const
inline

Definition at line 153 of file qquick3dxrmanager_visionos.mm.

◆ handleSpatialEvents() [1/2]

void CompositorLayer::handleSpatialEvents ( const QJsonObject & events)
inlineoverride

Definition at line 135 of file qquick3dxrmanager_visionos.mm.

◆ handleSpatialEvents() [2/2]

void CompositorLayer::handleSpatialEvents ( const QJsonObject & events)
inlineoverride

Definition at line 135 of file qquick3dxrmanager_visionos.mm.

◆ init() [1/2]

void CompositorLayer::init ( QQuick3DXrManagerPrivate * xrManager)
inline

Definition at line 160 of file qquick3dxrmanager_visionos.mm.

◆ init() [2/2]

void CompositorLayer::init ( QQuick3DXrManagerPrivate * xrManager)
inline

Definition at line 160 of file qquick3dxrmanager_visionos.mm.

◆ isFoveationEnabled() [1/2]

bool CompositorLayer::isFoveationEnabled ( ) const
inline

Definition at line 146 of file qquick3dxrmanager_visionos.mm.

◆ isFoveationEnabled() [2/2]

bool CompositorLayer::isFoveationEnabled ( ) const
inline

Definition at line 146 of file qquick3dxrmanager_visionos.mm.

◆ isFoveationSupported() [1/2]

bool CompositorLayer::isFoveationSupported ( ) const
inline

Definition at line 145 of file qquick3dxrmanager_visionos.mm.

◆ isFoveationSupported() [2/2]

bool CompositorLayer::isFoveationSupported ( ) const
inline

Definition at line 145 of file qquick3dxrmanager_visionos.mm.

◆ isInitialized() [1/2]

bool CompositorLayer::isInitialized ( ) const
inline

Definition at line 141 of file qquick3dxrmanager_visionos.mm.

◆ isInitialized() [2/2]

bool CompositorLayer::isInitialized ( ) const
inline

Definition at line 141 of file qquick3dxrmanager_visionos.mm.

◆ isMultiviewEnabled() [1/2]

bool CompositorLayer::isMultiviewEnabled ( ) const
inline

Definition at line 144 of file qquick3dxrmanager_visionos.mm.

◆ isMultiviewEnabled() [2/2]

bool CompositorLayer::isMultiviewEnabled ( ) const
inline

Definition at line 144 of file qquick3dxrmanager_visionos.mm.

◆ isMultiviewSupported() [1/2]

bool CompositorLayer::isMultiviewSupported ( ) const
inline

Definition at line 143 of file qquick3dxrmanager_visionos.mm.

◆ isMultiviewSupported() [2/2]

bool CompositorLayer::isMultiviewSupported ( ) const
inline

Definition at line 143 of file qquick3dxrmanager_visionos.mm.

◆ layerRenderer() [1/2]

cp_layer_renderer_t CompositorLayer::layerRenderer ( ) const
inline

Definition at line 148 of file qquick3dxrmanager_visionos.mm.

◆ layerRenderer() [2/2]

cp_layer_renderer_t CompositorLayer::layerRenderer ( ) const
inline

Definition at line 148 of file qquick3dxrmanager_visionos.mm.

◆ layerRendererChanged [1/2]

void CompositorLayer::layerRendererChanged ( )
signal

◆ layerRendererChanged [2/2]

void CompositorLayer::layerRendererChanged ( )
signal

◆ layerRendererReady [1/2]

void CompositorLayer::layerRendererReady ( )
signal

◆ layerRendererReady [2/2]

void CompositorLayer::layerRendererReady ( )
signal

◆ render() [1/2]

void CompositorLayer::render ( cp_layer_renderer_t renderer)
inlineoverride

Definition at line 116 of file qquick3dxrmanager_visionos.mm.

◆ render() [2/2]

void CompositorLayer::render ( cp_layer_renderer_t renderer)
inlineoverride

Definition at line 116 of file qquick3dxrmanager_visionos.mm.

◆ renderLock() [1/2]

QMutex & CompositorLayer::renderLock ( )
inline

Definition at line 193 of file qquick3dxrmanager_visionos.mm.

◆ renderLock() [2/2]

QMutex & CompositorLayer::renderLock ( )
inline

Definition at line 193 of file qquick3dxrmanager_visionos.mm.

◆ renderStateChanged [1/2]

void CompositorLayer::renderStateChanged ( QQuick3DXrManagerPrivate::RenderState )
signal

◆ renderStateChanged [2/2]

void CompositorLayer::renderStateChanged ( QQuick3DXrManagerPrivate::RenderState )
signal

◆ stopArSession() [1/2]

void CompositorLayer::stopArSession ( )
inline

Definition at line 175 of file qquick3dxrmanager_visionos.mm.

References QQuick3DXrManagerPrivate::Uninitialized.

◆ stopArSession() [2/2]

void CompositorLayer::stopArSession ( )
inline

Definition at line 175 of file qquick3dxrmanager_visionos.mm.

◆ supportsLayoutType() [1/2]

bool CompositorLayer::supportsLayoutType ( cp_layer_renderer_capabilities_t capabilities,
cp_layer_renderer_layout layout )
inlinestatic

Definition at line 68 of file qquick3dxrmanager_visionos.mm.

◆ supportsLayoutType() [2/2]

bool CompositorLayer::supportsLayoutType ( cp_layer_renderer_capabilities_t capabilities,
cp_layer_renderer_layout layout )
inlinestatic

Definition at line 68 of file qquick3dxrmanager_visionos.mm.

◆ teardown() [1/2]

void CompositorLayer::teardown ( )
inline

Definition at line 173 of file qquick3dxrmanager_visionos.mm.

◆ teardown() [2/2]

void CompositorLayer::teardown ( )
inline

Definition at line 173 of file qquick3dxrmanager_visionos.mm.

◆ waitForSyncToComplete() [1/2]

bool CompositorLayer::waitForSyncToComplete ( )
inline

Definition at line 194 of file qquick3dxrmanager_visionos.mm.

◆ waitForSyncToComplete() [2/2]

bool CompositorLayer::waitForSyncToComplete ( )
inline

Definition at line 194 of file qquick3dxrmanager_visionos.mm.

◆ QQuick3DXrManagerPrivate::renderFrameImpl [1/2]

bool QQuick3DXrManagerPrivate::renderFrameImpl ( QMutexLocker< QMutex > & locker,
QWaitCondition & waitCondition )
friend

◆ QQuick3DXrManagerPrivate::renderFrameImpl [2/2]

bool QQuick3DXrManagerPrivate::renderFrameImpl ( QMutexLocker< QMutex > & locker,
QWaitCondition & waitCondition )
friend

◆ QQuick3DXrManagerPrivate::update [1/2]

void QQuick3DXrManagerPrivate::update ( )
friend

◆ QQuick3DXrManagerPrivate::update [2/2]

void QQuick3DXrManagerPrivate::update ( )
friend
The documentation for this class was generated from the following file: