\qmltype PresentationTime \instantiates QWaylandPresentationTime \inqmlmodule QtWayland.Compositor.PresentationTime More...

#include <qwaylandpresentationtime_p.h>

Inheritance diagram for QWaylandPresentationTime:

Collaboration diagram for QWaylandPresentationTime:

Signals
void	presented (quint64 sequence, quint64 tv_sec, quint32 tv_nsec, quint32 refresh_nsec)

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
	QWaylandPresentationTime ()
	Constructs an empty QWaylandPresentationTime object.

	QWaylandPresentationTime (QWaylandCompositor *compositor)
	Constructs a QWaylandPresentationTime object for compositor.

QWaylandCompositor *	compositor () const

void	initialize () override
	Initializes the extension.

Q_INVOKABLE void	sendFeedback (QQuickWindow *window, quint64 sequence, quint64 tv_sec, quint32 tv_nsec)
	\qmlmethod void PresentationTime::sendFeedback(Window window, int sequence, int sec, int nsec)

Public Member Functions inherited from QWaylandCompositorExtensionTemplate< QWaylandPresentationTime >
	QWaylandCompositorExtensionTemplate ()

	QWaylandCompositorExtensionTemplate (QWaylandObject *container)

const struct wl_interface *	extensionInterface () const override
	A pure virtual function which should be reimplemented to return the `wl_interface` which corresponds to this QWaylandCompositorExtension.

Public Member Functions inherited from QWaylandCompositorExtension
	QWaylandCompositorExtension ()
	Creates a QWaylandCompositorExtension with no container.

	QWaylandCompositorExtension (QWaylandObject *container)
	Creates a QWaylandCompositorExtension and adds it to the extension container.

	~QWaylandCompositorExtension () override

QWaylandObject *	extensionContainer () const

void	setExtensionContainer (QWaylandObject *container)
	Sets the extension container for this QWaylandCompositorExtension to container.

bool	isInitialized () const

Public Member Functions inherited from QWaylandObject
	~QWaylandObject () override

QWaylandCompositorExtension *	extension (const QByteArray &name)
	Returns the compositor extension which matches name if one has been registered with the QWaylandObject.

QWaylandCompositorExtension *	extension (const wl_interface *interface)
	Returns the compositor extension which matches interface if one has been registered with the QWaylandObject.

QList< QWaylandCompositorExtension * >	extensions () const
	Returns the list of compositor extensions that have been registered with this QWaylandObject.

void	addExtension (QWaylandCompositorExtension *extension)
	Registers extension with this QWaylandObject.

void	removeExtension (QWaylandCompositorExtension *extension)
	Removes extension from the list of registered extensions in this QWaylandObject, if it has previously been registered using \l{addExtension()}.

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	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 const struct wl_interface *	interface ()
	Returns the Wayland interface for the QWaylandPresentationTime.

static QByteArray	interfaceName ()

Static Public Member Functions inherited from QWaylandCompositorExtensionTemplate< QWaylandPresentationTime >
static QWaylandPresentationTime *	findIn (QWaylandObject *container)
	If any instance of the interface has been registered with container, this is returned.

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)

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Protected Member Functions inherited from QWaylandCompositorExtensionTemplate< QWaylandPresentationTime >
	QWaylandCompositorExtensionTemplate (QWaylandCompositorExtensionPrivate &dd)

	QWaylandCompositorExtensionTemplate (QWaylandObject *container, QWaylandCompositorExtensionPrivate &dd)

Protected Member Functions inherited from QWaylandCompositorExtension
	QWaylandCompositorExtension (QWaylandCompositorExtensionPrivate &dd)

	QWaylandCompositorExtension (QWaylandObject *container, QWaylandCompositorExtensionPrivate &dd)

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 QWaylandObject
	QWaylandObject (QObject *parent=nullptr)
	Creates a QWaylandObject as a child of parent.

	QWaylandObject (QObjectPrivate &d, QObject *parent=nullptr)

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)

Protected Attributes inherited from QWaylandObject
QList< QWaylandCompositorExtension * >	extension_vector

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

\qmltype PresentationTime \instantiates QWaylandPresentationTime \inqmlmodule QtWayland.Compositor.PresentationTime

Since: 6.3

Provides tracking the timing when a frame is presented on screen.

The PresentationTime extension provides a way to track rendering timing for a surface. Client can request feedbacks associated with a surface, then compositor send events for the feedback with the time when the surface is presented on-screen.

PresentationTime corresponds to the Wayland wp_presentation interface.

To provide the functionality of the presentationtime extension in a compositor, create an instance of the PresentationTime component and add it to the list of extensions supported by the compositor:

Then, call sendFeedback() when a surface is presented on screen. Usually, the timing can be obtained from drm page flip event.

\qml import QtWayland.Compositor.PresentationTime

WaylandCompositor { PresentationTime { id: presentationTime } } \endqml

\inmodule QtWaylandCompositor

Since: 6.3

The QWaylandPresentationTime class is an extension to get timing for on-screen presentation.

The QWaylandPresentationTime extension provides a way to track rendering timing for a surface. Client can request feedbacks associated with a surface, then compositor send events for the feedback with the time when the surface is presented on-screen.

QWaylandPresentationTime corresponds to the Wayland wp_presentation interface.

Definition at line 27 of file qwaylandpresentationtime_p.h.

Constructor & Destructor Documentation

◆ QWaylandPresentationTime() [1/2]

QWaylandPresentationTime::QWaylandPresentationTime ( )

Constructs an empty QWaylandPresentationTime object.

Definition at line 73 of file qwaylandpresentationtime.cpp.

◆ QWaylandPresentationTime() [2/2]

QWaylandPresentationTime::QWaylandPresentationTime ( QWaylandCompositor * compositor )

Constructs a QWaylandPresentationTime object for compositor.

Definition at line 64 of file qwaylandpresentationtime.cpp.

Member Function Documentation

◆ compositor()

QWaylandCompositor * QWaylandPresentationTime::compositor ( ) const

Definition at line 101 of file qwaylandpresentationtime.cpp.

References QWaylandCompositorExtension::extensionContainer().

Referenced by initialize(), and PresentationFeedback::sendSyncOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initialize()

void QWaylandPresentationTime::initialize ( )

overridevirtual

Initializes the extension.

Reimplemented from QWaylandCompositorExtension.

Definition at line 81 of file qwaylandpresentationtime.cpp.

References compositor(), d, QWaylandCompositorExtension::initialize(), QWaylandCompositorExtension::isInitialized(), and qWarning.

Here is the call graph for this function:

◆ interface()

const struct wl_interface * QWaylandPresentationTime::interface ( )

static

Returns the Wayland interface for the QWaylandPresentationTime.

Definition at line 134 of file qwaylandpresentationtime.cpp.

◆ interfaceName()

QByteArray QWaylandPresentationTime::interfaceName ( )

static

Definition at line 142 of file qwaylandpresentationtime.cpp.

◆ presented

void QWaylandPresentationTime::presented	(	quint64	sequence,
		quint64	tv_sec,
		quint32	tv_nsec,
		quint32	refresh_nsec )

signal

Referenced by sendFeedback().

Here is the caller graph for this function:

◆ sendFeedback()

void QWaylandPresentationTime::sendFeedback	(	QQuickWindow *	window,
		quint64	sequence,
		quint64	tv_sec,
		quint32	tv_nsec )

\qmlmethod void PresentationTime::sendFeedback(Window window, int sequence, int sec, int nsec)

Interface to notify that a frame is presented on screen using window. If your platform supports DRM events, page_flip_handler is the proper timing to send it. The sequence is the refresh counter. sec and nsec hold the seconds and nanoseconds parts of the presentation timestamp, respectively.

Interface to notify that a frame is presented on screen using window. If your platform supports DRM events, page_flip_handler is the proper timing to send it. The sequence is the refresh counter. tv_sec and tv_nsec hold the seconds and nanoseconds parts of the presentation timestamp, respectively.

Definition at line 121 of file qwaylandpresentationtime.cpp.

References emit, presented(), and window().

Here is the call graph for this function:

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