#include <qwaylandquickcompositor.h>

Inheritance diagram for QWaylandQuickCompositor:

Collaboration diagram for QWaylandQuickCompositor:

Public Member Functions
	QWaylandQuickCompositor (QObject *parent=nullptr)
void	create () override
	\qmlproperty list QtWayland.Compositor::WaylandCompositor::extensions
void	grabSurface (QWaylandSurfaceGrabber *grabber, const QWaylandBufferRef &buffer) override
	Grab the surface content from the given buffer.
Public Member Functions inherited from QWaylandCompositor
	QWaylandCompositor (QObject *parent=nullptr)
	Constructs a QWaylandCompositor with the given parent.
	~QWaylandCompositor () override
	Destroys the QWaylandCompositor.
bool	isCreated () const
void	setSocketName (const QByteArray &name)
QByteArray	socketName () const
Q_INVOKABLE void	addSocketDescriptor (int fd)
	\qmlmethod QtWayland.Compositor::WaylandCompositor::addSocketDescriptor(fd)
::wl_display *	display () const
uint32_t	nextSerial ()
QList< QWaylandClient * >	clients () const
Q_INVOKABLE void	destroyClientForSurface (QWaylandSurface *surface)
	\qmlmethod QtWayland.Compositor::WaylandCompositor::destroyClientForSurface(surface)
Q_INVOKABLE void	destroyClient (QWaylandClient *client)
	\qmlmethod QtWayland.Compositor::WaylandCompositor::destroyClient(client)
QList< QWaylandSurface * >	surfaces () const
QList< QWaylandSurface * >	surfacesForClient (QWaylandClient *client) const
Q_INVOKABLE QWaylandOutput *	outputFor (QWindow *window) const
	Returns the QWaylandOutput that is connected to the given window.
QWaylandOutput *	defaultOutput () const
void	setDefaultOutput (QWaylandOutput *output)
QList< QWaylandOutput * >	outputs () const
uint	currentTimeMsecs () const
void	setRetainedSelectionEnabled (bool enabled)
bool	retainedSelectionEnabled () const
void	overrideSelection (const QMimeData *data)
QWaylandSeat *	defaultSeat () const
QWaylandSeat *	seatFor (QInputEvent *inputEvent)
	Select the seat for a given input event inputEvent.
bool	useHardwareIntegrationExtension () const
void	setUseHardwareIntegrationExtension (bool use)
QVector< ShmFormat >	additionalShmFormats () const
void	setAdditionalShmFormats (const QVector< ShmFormat > &additionalShmFormats)
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	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 ()

Protected Member Functions
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.
Protected Member Functions inherited from QWaylandCompositor
virtual void	retainedSelectionReceived (QMimeData *mimeData)
virtual QWaylandSeat *	createSeat ()
virtual QWaylandPointer *	createPointerDevice (QWaylandSeat *seat)
virtual QWaylandKeyboard *	createKeyboardDevice (QWaylandSeat *seat)
virtual QWaylandTouch *	createTouchDevice (QWaylandSeat *seat)
	QWaylandCompositor (QWaylandCompositorPrivate &dptr, QObject *parent=nullptr)
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)

Additional Inherited Members
Public Types inherited from QWaylandCompositor
enum	ShmFormat { ShmFormat_ARGB8888 = 0 , ShmFormat_XRGB8888 = 1 , ShmFormat_C8 = 0x20203843 , ShmFormat_XRGB4444 = 0x32315258 , ShmFormat_ARGB4444 = 0x32315241 , ShmFormat_XRGB1555 = 0x35315258 , ShmFormat_RGB565 = 0x36314752 , ShmFormat_RGB888 = 0x34324752 , ShmFormat_XBGR8888 = 0x34324258 , ShmFormat_ABGR8888 = 0x34324241 , ShmFormat_BGR888 = 0x34324742 , ShmFormat_XRGB2101010 = 0x30335258 , ShmFormat_XBGR2101010 = 0x30334258 , ShmFormat_ARGB2101010 = 0x30335241 , ShmFormat_ABGR2101010 = 0x30334241 }
Public Slots inherited from QWaylandCompositor
void	processWaylandEvents ()
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
Signals inherited from QWaylandCompositor
void	createdChanged ()
void	socketNameChanged (const QByteArray &socketName)
void	retainedSelectionChanged (bool retainedSelection)
void	surfaceRequested (QWaylandClient *client, uint id, int version)
	\qmlsignal void QtWayland.Compositor::WaylandCompositor::surfaceRequested(WaylandClient client, int id, int version)
void	surfaceCreated (QWaylandSurface *surface)
	\qmlsignal void QtWayland.Compositor::WaylandCompositor::surfaceCreated(WaylandSurface surface)
void	surfaceAboutToBeDestroyed (QWaylandSurface *surface)
void	subsurfaceChanged (QWaylandSurface child, QWaylandSurface parent)
void	defaultOutputChanged ()
void	defaultSeatChanged (QWaylandSeat newDevice, QWaylandSeat oldDevice)
void	useHardwareIntegrationExtensionChanged ()
void	outputAdded (QWaylandOutput *output)
void	outputRemoved (QWaylandOutput *output)
void	additionalShmFormatsChanged ()
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.
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 Attributes inherited from QWaylandObject
QList< QWaylandCompositorExtension * >	extension_vector
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Properties inherited from QWaylandCompositor
QByteArray	socketName
	\qmlproperty string QtWayland.Compositor::WaylandCompositor::socketName
bool	created
	\qmlproperty bool QtWayland.Compositor::WaylandCompositor::created
bool	retainedSelection
	\qmlproperty bool QtWayland.Compositor::WaylandCompositor::retainedSelection
QWaylandOutput *	defaultOutput
	\qmlproperty WaylandOutput QtWayland.Compositor::WaylandCompositor::defaultOutput
bool	useHardwareIntegrationExtension
	\qmlproperty bool QtWayland.Compositor::WaylandCompositor::useHardwareIntegrationExtension
QWaylandSeat *	defaultSeat
	\qmlproperty WaylandSeat QtWayland.Compositor::WaylandCompositor::defaultSeat
QVector< ShmFormat >	additionalShmFormats
	\qmlproperty list<enum> QtWayland.Compositor::WaylandCompositor::additionalShmFormats
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

Definition at line 18 of file qwaylandquickcompositor.h.

Constructor & Destructor Documentation

◆ QWaylandQuickCompositor()

QWaylandQuickCompositor::QWaylandQuickCompositor ( QObject * parent = nullptr )

Definition at line 44 of file qwaylandquickcompositor.cpp.

Member Function Documentation

◆ classBegin()

void QWaylandQuickCompositor::classBegin ( )

overrideprotectedvirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 76 of file qwaylandquickcompositor.cpp.

◆ componentComplete()

void QWaylandQuickCompositor::componentComplete ( )

overrideprotectedvirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 81 of file qwaylandquickcompositor.cpp.

◆ create()

void QWaylandQuickCompositor::create ( )

overridevirtual

\qmlproperty list QtWayland.Compositor::WaylandCompositor::extensions

A list of extensions that the compositor advertises to its clients. For any Wayland extension the compositor should support, instantiate its component, and add it to the list of extensions.

For instance, the following code would allow the clients to request wl_shell surfaces in the compositor using the wl_shell interface.

\qml import QtWayland.Compositor

WaylandCompositor { WlShell { // ... } } \endqml

Reimplemented from QWaylandCompositor.

Definition at line 70 of file qwaylandquickcompositor.cpp.