QWaylandCompositor Class
The QWaylandCompositor class manages the Wayland display server. More...
| Header: | #include <QWaylandCompositor> |
| qmake: | QT += waylandcompositor |
| Inherits: | QWaylandObject |
This class is under development and is subject to change.
Properties
|
|
Public Functions
| QWaylandCompositor(QObject *parent = nullptr) | |
| virtual | ~QWaylandCompositor() |
| virtual void | create() |
| QWaylandView * | createSurfaceView(QWaylandSurface *surface) |
| QWaylandInputDevice * | defaultInputDevice() const |
| QWaylandOutput * | defaultOutput() 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 |
| void | setDefaultOutput(QWaylandOutput *output) |
| void | setRetainedSelectionEnabled(bool enabled) |
| void | setSocketName(const QByteArray &name) |
| void | setUseHardwareIntegrationExtension(bool use) |
| QByteArray | socketName() const |
| bool | useHardwareIntegrationExtension() const |
- 5 public functions inherited from QWaylandObject
Signals
| void | createSurface(QWaylandClient *client, uint id, int version) |
| void | defaultInputDeviceChanged(QWaylandInputDevice *newDevice, QWaylandInputDevice *oldDevice) |
| void | defaultOutputChanged() |
| void | subsurfaceChanged(QWaylandSurface *child, QWaylandSurface *parent) |
| void | surfaceAboutToBeDestroyed(QWaylandSurface *surface) |
| void | surfaceCreated(QWaylandSurface *surface) |
| void | useHardwareIntegrationExtensionChanged() |
Detailed Description
The QWaylandCompositor class manages the Wayland display server.
The QWaylandCompositor manages the connections to the clients, as well as the different outputs and input devices.
Normally, a compositor application will have a single WaylandCompositor instance, which can have several outputs as children.
Property Documentation
defaultInputDevice : QWaylandInputDevice * const
This property contains the default input device for this QWaylandCompositor.
Access functions:
| QWaylandInputDevice * | defaultInputDevice() const |
Notifier signal:
| void | defaultInputDeviceChanged(QWaylandInputDevice *newDevice, QWaylandInputDevice *oldDevice) |
defaultOutput : QWaylandOutput *
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.
Access functions:
| QWaylandOutput * | defaultOutput() const |
| void | setDefaultOutput(QWaylandOutput *output) |
Notifier signal:
| void | defaultOutputChanged() |
retainedSelection : bool
This property holds whether retained selection is enabled.
Access functions:
| bool | retainedSelectionEnabled() const |
| void | setRetainedSelectionEnabled(bool enabled) |
socketName : QByteArray
This property holds the socket name used by QWaylandCompositor to communicate with clients. This must be set before the QWaylandCompositor is 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.
Access functions:
| QByteArray | socketName() const |
| void | setSocketName(const QByteArray &name) |
useHardwareIntegrationExtension : bool
This property holds whether the hardware integration extension should be enabled for this QWaylandCompositor.
This property must be set before the compositor is created.
Access functions:
| bool | useHardwareIntegrationExtension() const |
| void | setUseHardwareIntegrationExtension(bool use) |
Notifier signal:
| void | useHardwareIntegrationExtensionChanged() |
Member Function Documentation
QWaylandCompositor::QWaylandCompositor(QObject *parent = nullptr)
Constructs a QWaylandCompositor with the given parent.
[virtual] QWaylandCompositor::~QWaylandCompositor()
Destroys the QWaylandCompositor
[virtual] void QWaylandCompositor::create()
Initializes the QWaylandCompositor. If you override this function in your subclass, be sure to call the base class implementation.
[signal] void QWaylandCompositor::createSurface(QWaylandClient *client, uint id, int version)
This signal is emitted when a client has created a surface. 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.
QWaylandView *QWaylandCompositor::createSurfaceView(QWaylandSurface *surface)
void QWaylandCompositor::destroyClient(QWaylandClient *client)
Destroys the client.
void QWaylandCompositor::destroyClientForSurface(QWaylandSurface *surface)
Destroys the client for the surface.
[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 SHM 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).
bool QWaylandCompositor::isCreated() const
Returns true if the QWaylandCompositor has been initialized. Otherwise returns false.
QWaylandOutput *QWaylandCompositor::outputFor(QWindow *window) const
Returns the QWaylandOutput that is connected to the given window.