QWaylandCompositor Class

The QWaylandCompositor class manages the Wayland display server. More...

Header:	#include <QWaylandCompositor>
CMake:	find_package(Qt6 COMPONENTS Waylandcompositor REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Waylandcompositor)
qmake:	QT += waylandcompositor
Since:	Qt 5.8
Instantiated By:	WaylandCompositor
Inherits:	QWaylandObject

• List of all members, including inherited members

Properties

additionalShmFormats : QVector<ShmFormat> created : const bool defaultOutput : QWaylandOutput* defaultSeat : QWaylandSeat* const

retainedSelection : bool socketName : QByteArray useHardwareIntegrationExtension : bool

Public Functions

	QWaylandCompositor(QObject *parent = nullptr)
virtual	~QWaylandCompositor() override
void	addSocketDescriptor(int fd)
QVector<QWaylandCompositor::ShmFormat>	additionalShmFormats() const
virtual void	create()
QWaylandOutput *	defaultOutput() const
QWaylandSeat *	defaultSeat() const
void	destroyClient(QWaylandClient *client)
void	destroyClientForSurface(QWaylandSurface *surface)
virtual void	grabSurface(QWaylandSurfaceGrabber *grabber, const QWaylandBufferRef &buffer)
bool	isCreated() const
QWaylandOutput *	outputFor(QWindow *window) const
bool	retainedSelectionEnabled() const
QWaylandSeat *	seatFor(QInputEvent *inputEvent)
void	setAdditionalShmFormats(const QVector<QWaylandCompositor::ShmFormat> &additionalShmFormats)
void	setDefaultOutput(QWaylandOutput *output)
void	setRetainedSelectionEnabled(bool enabled)
void	setSocketName(const QByteArray &name)
void	setUseHardwareIntegrationExtension(bool use)
QByteArray	socketName() const
bool	useHardwareIntegrationExtension() const

Signals

void	additionalShmFormatsChanged()
void	createdChanged()
void	defaultOutputChanged()
void	defaultSeatChanged(QWaylandSeat *newDevice, QWaylandSeat *oldDevice)
void	retainedSelectionChanged(bool retainedSelection)
void	socketNameChanged(const QByteArray &socketName)
void	surfaceCreated(QWaylandSurface *surface)
void	surfaceRequested(QWaylandClient *client, uint id, int version)
void	useHardwareIntegrationExtensionChanged()

Detailed Description

The QWaylandCompositor manages the connections to the clients, as well as the different outputs and seats.

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

Member Function Documentation

QWaylandCompositor::QWaylandCompositor(QObject *parent = nullptr)

Constructs a QWaylandCompositor with the given parent.

[signal] void QWaylandCompositor::surfaceCreated(QWaylandSurface *surface)

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

[signal] void QWaylandCompositor::surfaceRequested(QWaylandClient *client, uint 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 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.

[override virtual] QWaylandCompositor::~QWaylandCompositor()

Destroys the QWaylandCompositor

[invokable, since 5.12] void QWaylandCompositor::addSocketDescriptor(int fd)

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 function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

This function was introduced in Qt 5.12.

[virtual] void QWaylandCompositor::create()

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

[invokable] void QWaylandCompositor::destroyClient(QWaylandClient *client)

Destroys the client.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[invokable] void QWaylandCompositor::destroyClientForSurface(QWaylandSurface *surface)

Destroys the client for the surface.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

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

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.

[invokable] QWaylandOutput *QWaylandCompositor::outputFor(QWindow *window) const

Returns the QWaylandOutput that is connected to the given window.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

QWaylandSeat *QWaylandCompositor::seatFor(QInputEvent *inputEvent)

Select the seat for a given input event inputEvent. Currently, Qt only supports a single seat, but you can reimplement QWaylandCompositorPrivate::seatFor for a custom seat selection.