\qmltype WaylandCompositor \nativetype QWaylandCompositor \inqmlmodule QtWayland.Compositor More...

#include <qwaylandcompositor.h>

Inheritance diagram for QWaylandCompositor:

Collaboration diagram for QWaylandCompositor:

Public Types

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
void	processWaylandEvents ()
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

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

Public Member Functions
	QWaylandCompositor (QObject *parent=nullptr)
	Constructs a QWaylandCompositor with the given parent.
	~QWaylandCompositor () override
	Destroys the QWaylandCompositor.
virtual void	create ()
	Initializes 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)
virtual void	grabSurface (QWaylandSurfaceGrabber *grabber, const QWaylandBufferRef &buffer)
	Grab the surface content from the given buffer.
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`.

Protected Member Functions
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)

Properties
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

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 Attributes inherited from QWaylandObject
QList< QWaylandCompositorExtension * >	extension_vector
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

\qmltype WaylandCompositor \nativetype QWaylandCompositor \inqmlmodule QtWayland.Compositor

Since: 5.8

Manages the Wayland display server.

The WaylandCompositor manages the connections to the clients, as well as the different \l{WaylandOutput}{outputs} and \l{QWaylandSeat}{seats}.

Normally, a compositor application will have a single WaylandCompositor instance, which can have several outputs as children. When a client requests the compositor to create a surface, the request is handled by the onSurfaceRequested handler.

Extensions that are supported by the compositor should be instantiated and added to the extensions property.

\inmodule QtWaylandCompositor

Since: 5.8

The QWaylandCompositor class manages the Wayland display server.

The QWaylandCompositor manages the connections to the clients, as well as the different \l{QWaylandOutput}{outputs} and \l{QWaylandSeat}{seats}.

Normally, a compositor application will have a single WaylandCompositor instance, which can have several outputs as children.

Definition at line 42 of file qwaylandcompositor.h.

Member Enumeration Documentation

◆ ShmFormat

enum QWaylandCompositor::ShmFormat

Enumerator
ShmFormat_ARGB8888
ShmFormat_XRGB8888
ShmFormat_C8
ShmFormat_XRGB4444
ShmFormat_ARGB4444
ShmFormat_XRGB1555
ShmFormat_RGB565
ShmFormat_RGB888
ShmFormat_XBGR8888
ShmFormat_ABGR8888
ShmFormat_BGR888
ShmFormat_XRGB2101010
ShmFormat_XBGR2101010
ShmFormat_ARGB2101010
ShmFormat_ABGR2101010

Definition at line 59 of file qwaylandcompositor.h.

Constructor & Destructor Documentation

◆ QWaylandCompositor() [1/2]

QWaylandCompositor::QWaylandCompositor ( QObject * parent = nullptr )

Constructs a QWaylandCompositor with the given parent.

Definition at line 558 of file qwaylandcompositor.cpp.

◆ ~QWaylandCompositor()

QWaylandCompositor::~QWaylandCompositor ( )

override

Destroys the QWaylandCompositor.

Definition at line 575 of file qwaylandcompositor.cpp.

◆ QWaylandCompositor() [2/2]

QWaylandCompositor::QWaylandCompositor	(	QWaylandCompositorPrivate &	dptr,
		QObject *	parent = nullptr )

protected

Constructs a QWaylandCompositor with the private object dptr and parent.

Definition at line 567 of file qwaylandcompositor.cpp.

Member Function Documentation

◆ additionalShmFormats()

QVector< QWaylandCompositor::ShmFormat > QWaylandCompositor::additionalShmFormats ( ) const

Definition at line 1091 of file qwaylandcompositor.cpp.

◆ additionalShmFormatsChanged

void QWaylandCompositor::additionalShmFormatsChanged ( )

signal

◆ addSocketDescriptor()

void QWaylandCompositor::addSocketDescriptor ( int fd )

\qmlmethod QtWayland.Compositor::WaylandCompositor::addSocketDescriptor(fd)

Since: 5.12

Listen for client connections on a file descriptor, fd, referring to a server socket already bound and listening.

Does not take ownership of the file descriptor; it must be closed explicitly if needed.

Note: This method is only available with libwayland 1.10.0 or newer. If built against an earlier libwayland runtime, this method is a noop.

Listen for client connections on a file descriptor, fd, referring to a server socket already bound and listening.

Does not take ownership of the file descriptor; it must be closed explicitly if needed.

Note: This method is only available with libwayland 1.10.0 or newer. If built against an earlier libwayland runtime, this method is a noop.

Since: 5.12

Definition at line 680 of file qwaylandcompositor.cpp.

◆ clients()

QList< QWaylandClient * > QWaylandCompositor::clients ( ) const

Definition at line 709 of file qwaylandcompositor.cpp.

◆ create()

void QWaylandCompositor::create ( )

virtual

Initializes the QWaylandCompositor.

If you override this function in your subclass, be sure to call the base class implementation.

Reimplemented in QWaylandQuickCompositor.

Definition at line 583 of file qwaylandcompositor.cpp.

◆ createdChanged

void QWaylandCompositor::createdChanged ( )

signal

◆ createKeyboardDevice()

QWaylandKeyboard * QWaylandCompositor::createKeyboardDevice ( QWaylandSeat * seat )

protectedvirtual

Definition at line 875 of file qwaylandcompositor.cpp.

◆ createPointerDevice()

QWaylandPointer * QWaylandCompositor::createPointerDevice ( QWaylandSeat * seat )

protectedvirtual

Definition at line 867 of file qwaylandcompositor.cpp.

◆ createSeat()

QWaylandSeat * QWaylandCompositor::createSeat ( )

protectedvirtual

Definition at line 859 of file qwaylandcompositor.cpp.

◆ createTouchDevice()

QWaylandTouch * QWaylandCompositor::createTouchDevice ( QWaylandSeat * seat )

protectedvirtual

Definition at line 883 of file qwaylandcompositor.cpp.

◆ currentTimeMsecs()

uint QWaylandCompositor::currentTimeMsecs ( ) const

Definition at line 838 of file qwaylandcompositor.cpp.

◆ defaultOutput()

QWaylandOutput * QWaylandCompositor::defaultOutput ( ) const

Definition at line 808 of file qwaylandcompositor.cpp.

◆ defaultOutputChanged

void QWaylandCompositor::defaultOutputChanged ( )

signal

◆ defaultSeat()

QWaylandSeat * QWaylandCompositor::defaultSeat ( ) const

Definition at line 947 of file qwaylandcompositor.cpp.

◆ defaultSeatChanged

void QWaylandCompositor::defaultSeatChanged	(	QWaylandSeat *	newDevice,
		QWaylandSeat *	oldDevice )

signal

◆ destroyClient()

void QWaylandCompositor::destroyClient ( QWaylandClient * client )

\qmlmethod QtWayland.Compositor::WaylandCompositor::destroyClient(client)

Destroys the given WaylandClient client.

Destroys the client.

Definition at line 738 of file qwaylandcompositor.cpp.

◆ destroyClientForSurface()

void QWaylandCompositor::destroyClientForSurface ( QWaylandSurface * surface )

\qmlmethod QtWayland.Compositor::WaylandCompositor::destroyClientForSurface(surface)

Destroys the client for the WaylandSurface surface.

Destroys the client for the surface.

Definition at line 724 of file qwaylandcompositor.cpp.

◆ display()

struct wl_display * QWaylandCompositor::display ( ) const

Definition at line 691 of file qwaylandcompositor.cpp.

◆ grabSurface()

void QWaylandCompositor::grabSurface	(	QWaylandSurfaceGrabber *	grabber,
		const QWaylandBufferRef &	buffer )

virtual

Grab the surface content from the given buffer.

The default implementation requires a OpenGL context to be bound to the current thread to work. If this is not possible, reimplement this function in your compositor subclass to implement custom logic. The default implementation only grabs shared memory and OpenGL buffers, reimplement this in your compositor subclass to handle more buffer types.

Note: You should not call this manually, but rather use QWaylandSurfaceGrabber (grabber).

Reimplemented in QWaylandQuickCompositor.

Definition at line 1019 of file qwaylandcompositor.cpp.

◆ isCreated()

bool QWaylandCompositor::isCreated ( ) const

Definition at line 603 of file qwaylandcompositor.cpp.

◆ nextSerial()

uint32_t QWaylandCompositor::nextSerial ( )

Definition at line 700 of file qwaylandcompositor.cpp.

◆ outputAdded

void QWaylandCompositor::outputAdded ( QWaylandOutput * output )

signal

◆ outputFor()

QWaylandOutput * QWaylandCompositor::outputFor ( QWindow * window ) const

Returns the QWaylandOutput that is connected to the given window.

Definition at line 776 of file qwaylandcompositor.cpp.

◆ outputRemoved

void QWaylandCompositor::outputRemoved ( QWaylandOutput * output )

signal

◆ outputs()

QList< QWaylandOutput * > QWaylandCompositor::outputs ( ) const

Definition at line 829 of file qwaylandcompositor.cpp.

◆ overrideSelection()

void QWaylandCompositor::overrideSelection ( const QMimeData * data )

Definition at line 926 of file qwaylandcompositor.cpp.

◆ processWaylandEvents

void QWaylandCompositor::processWaylandEvents ( )

slot

Definition at line 847 of file qwaylandcompositor.cpp.

◆ retainedSelectionChanged

void QWaylandCompositor::retainedSelectionChanged ( bool retainedSelection )

signal

◆ retainedSelectionEnabled()

bool QWaylandCompositor::retainedSelectionEnabled ( ) const

Definition at line 910 of file qwaylandcompositor.cpp.

◆ retainedSelectionReceived()

void QWaylandCompositor::retainedSelectionReceived ( QMimeData * mimeData )

protectedvirtual

Definition at line 919 of file qwaylandcompositor.cpp.

◆ seatFor()

QWaylandSeat * QWaylandCompositor::seatFor ( QInputEvent * inputEvent )

Select the seat for a given input event inputEvent.

Currently, Qt only supports a single seat.

Definition at line 959 of file qwaylandcompositor.cpp.

◆ setAdditionalShmFormats()

void QWaylandCompositor::setAdditionalShmFormats ( const QVector< ShmFormat > & additionalShmFormats )

Definition at line 1081 of file qwaylandcompositor.cpp.

◆ setDefaultOutput()

void QWaylandCompositor::setDefaultOutput ( QWaylandOutput * output )

Definition at line 814 of file qwaylandcompositor.cpp.

◆ setRetainedSelectionEnabled()

void QWaylandCompositor::setRetainedSelectionEnabled ( bool enabled )

Definition at line 899 of file qwaylandcompositor.cpp.

◆ setSocketName()

void QWaylandCompositor::setSocketName ( const QByteArray & name )

Definition at line 630 of file qwaylandcompositor.cpp.

◆ setUseHardwareIntegrationExtension()

void QWaylandCompositor::setUseHardwareIntegrationExtension ( bool use )

Definition at line 992 of file qwaylandcompositor.cpp.

◆ socketName()

QByteArray QWaylandCompositor::socketName ( ) const

Definition at line 646 of file qwaylandcompositor.cpp.

◆ socketNameChanged

void QWaylandCompositor::socketNameChanged ( const QByteArray & socketName )

signal

◆ subsurfaceChanged

void QWaylandCompositor::subsurfaceChanged	(	QWaylandSurface *	child,
		QWaylandSurface *	parent )

signal

◆ surfaceAboutToBeDestroyed

void QWaylandCompositor::surfaceAboutToBeDestroyed ( QWaylandSurface * surface )

signal

◆ surfaceCreated

void QWaylandCompositor::surfaceCreated ( QWaylandSurface * surface )

signal

\qmlsignal void QtWayland.Compositor::WaylandCompositor::surfaceCreated(WaylandSurface surface)

This signal is emitted when a new WaylandSurface instance surface has been created.

This signal is emitted when a new QWaylandSurface instance surface has been created.

◆ surfaceRequested

void QWaylandCompositor::surfaceRequested	(	QWaylandClient *	client,
		uint	id,
		int	version )

signal

\qmlsignal void QtWayland.Compositor::WaylandCompositor::surfaceRequested(WaylandClient client, int id, int version)

This signal is emitted when a client has created a surface with id id. The interface version is also available.

The slot connecting to this signal may create and initialize a WaylandSurface instance in the scope of the slot. Otherwise a default surface is created.

This signal is emitted when a client has created a surface with id id. The interface version is also available.

The slot connecting to this signal may create and initialize a QWaylandSurface instance in the scope of the slot. Otherwise a default surface is created.

Connections to this signal must be of Qt::DirectConnection connection type.

◆ surfaces()

QList< QWaylandSurface * > QWaylandCompositor::surfaces ( ) const

Definition at line 767 of file qwaylandcompositor.cpp.

◆ surfacesForClient()

QList< QWaylandSurface * > QWaylandCompositor::surfacesForClient ( QWaylandClient * client ) const

Definition at line 753 of file qwaylandcompositor.cpp.

◆ useHardwareIntegrationExtension()

bool QWaylandCompositor::useHardwareIntegrationExtension ( ) const

Definition at line 982 of file qwaylandcompositor.cpp.

◆ useHardwareIntegrationExtensionChanged

void QWaylandCompositor::useHardwareIntegrationExtensionChanged ( )

signal

Property Documentation

◆ additionalShmFormats

QVector<ShmFormat> QWaylandCompositor::additionalShmFormats

readwrite

\qmlproperty list<enum> QtWayland.Compositor::WaylandCompositor::additionalShmFormats

This property holds the list of additional wl_shm formats advertised as supported by the compositor.

By default, only the required ShmFormat_ARGB8888 and ShmFormat_XRGB8888 are listed and this list will empty. Additional formats may require conversion internally and can thus affect performance.

This property must be set before the compositor component is completed. Subsequent changes will have no effect.

Since: 6.0

This property holds the list of additional wl_shm formats advertised as supported by the compositor.

By default, only the required ShmFormat_ARGB8888 and ShmFormat_XRGB8888 are listed and this list will empty.

This property must be set before the compositor is \l{create()}{created}. Subsequent changes will have no effect.

Since: 6.0

Definition at line 52 of file qwaylandcompositor.h.

◆ created

bool QWaylandCompositor::created

read

\qmlproperty bool QtWayland.Compositor::WaylandCompositor::created

This property is true if WaylandCompositor has been initialized, otherwise it's false.

This property is true if QWaylandCompositor has been initialized, otherwise it's false.

Definition at line 47 of file qwaylandcompositor.h.

◆ defaultOutput

QWaylandOutput * QWaylandCompositor::defaultOutput

readwrite

\qmlproperty WaylandOutput QtWayland.Compositor::WaylandCompositor::defaultOutput

This property contains the first in the list of outputs added to the WaylandCompositor, or null if no outputs have been added.

Setting a new default output prepends it to the output list, making it the new default, but the previous default is not removed from the list.

This property contains the first in the list of outputs added to the QWaylandCompositor, or null if no outputs have been added.

Setting a new default output prepends it to the output list, making it the new default, but the previous default is not removed from the list. If the new default output was already in the list of outputs, it is moved to the beginning of the list.

Definition at line 49 of file qwaylandcompositor.h.

◆ defaultSeat

QWaylandSeat * QWaylandCompositor::defaultSeat

read

\qmlproperty WaylandSeat QtWayland.Compositor::WaylandCompositor::defaultSeat

This property contains the default seat for this WaylandCompositor.

This property contains the default seat for this QWaylandCompositor.

Definition at line 51 of file qwaylandcompositor.h.

◆ retainedSelection

bool QWaylandCompositor::retainedSelection

readwrite

\qmlproperty bool QtWayland.Compositor::WaylandCompositor::retainedSelection

This property holds whether retained selection is enabled.

Definition at line 48 of file qwaylandcompositor.h.

◆ socketName

QByteArray QWaylandCompositor::socketName

readwrite

\qmlproperty string QtWayland.Compositor::WaylandCompositor::socketName

This property holds the socket name used by WaylandCompositor to communicate with clients. It must be set before the component is completed.

If the socketName is empty (the default), the contents of the start argument --wayland-socket-name are used instead. If the argument is not set, the compositor tries to find a socket name, which is {wayland-0} by default.

This property holds the socket name used by QWaylandCompositor to communicate with clients. This must be set before the QWaylandCompositor is \l{create()}{created}.

If the socketName is empty (the default), the contents of the start argument --wayland-socket-name are used instead. If the argument is not set, the compositor tries to find a socket name, which is {wayland-0} by default.

Definition at line 46 of file qwaylandcompositor.h.

◆ useHardwareIntegrationExtension

bool QWaylandCompositor::useHardwareIntegrationExtension

readwrite

\qmlproperty bool QtWayland.Compositor::WaylandCompositor::useHardwareIntegrationExtension

This property holds whether the hardware integration extension should be enabled for this WaylandCompositor.

This property must be set before the compositor component is completed.

This property holds whether the hardware integration extension should be enabled for this QWaylandCompositor.

This property must be set before the compositor is \l{create()}{created}.

Definition at line 50 of file qwaylandcompositor.h.

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

qtwayland/src/compositor/compositor_api/qwaylandcompositor.h (deae8b9ce9f551b29ef98d0bb827a8543af2797e)
qtwayland/src/compositor/compositor_api/qwaylandcompositor.cpp (bc861d37690e29a84c99e295329f2f7f006274f6)

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ShmFormat

Constructor & Destructor Documentation

◆ QWaylandCompositor() [1/2]

◆ ~QWaylandCompositor()

◆ QWaylandCompositor() [2/2]

Member Function Documentation

◆ additionalShmFormats()

◆ additionalShmFormatsChanged

◆ addSocketDescriptor()

◆ clients()

◆ create()

◆ createdChanged

◆ createKeyboardDevice()

◆ createPointerDevice()

◆ createSeat()

◆ createTouchDevice()

◆ currentTimeMsecs()

◆ defaultOutput()

◆ defaultOutputChanged

◆ defaultSeat()

◆ defaultSeatChanged

◆ destroyClient()

◆ destroyClientForSurface()

◆ display()

◆ grabSurface()

◆ isCreated()

◆ nextSerial()

◆ outputAdded

◆ outputFor()

◆ outputRemoved

◆ outputs()

◆ overrideSelection()

◆ processWaylandEvents

◆ retainedSelectionChanged

◆ retainedSelectionEnabled()

◆ retainedSelectionReceived()

◆ seatFor()

◆ setAdditionalShmFormats()

◆ setDefaultOutput()

◆ setRetainedSelectionEnabled()

◆ setSocketName()

◆ setUseHardwareIntegrationExtension()

◆ socketName()

◆ socketNameChanged

◆ subsurfaceChanged

◆ surfaceAboutToBeDestroyed

◆ surfaceCreated

◆ surfaceRequested

◆ surfaces()

◆ surfacesForClient()

◆ useHardwareIntegrationExtension()

◆ useHardwareIntegrationExtensionChanged

Property Documentation

◆ additionalShmFormats

◆ created

◆ defaultOutput

◆ defaultSeat

◆ retainedSelection

◆ socketName

◆ useHardwareIntegrationExtension