Qt Documentation

Contents

WaylandCompositor QML Type

Manages the Wayland display server. More...

Import Statement: import QtWayland.Compositor 1.0

Properties

Methods

Detailed Description

The WaylandCompositor 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. When a client requests the compositor to create a surface, the request is handled by the onCreateSurface handler.

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

Property Documentation

defaultInputDevice : object

This property contains the default input device for this WaylandCompositor.


defaultOutput : object

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.


extensions : list

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.

import QtWayland.Compositor 1.0

WaylandCompositor {
    extensions: [ WlShell {
        // ...
    } ]
}

retainedSelection : bool

This property holds whether retained selection is enabled.


socketName : string

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.


useHardwareIntegrationExtension : bool

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.


Method Documentation

destroyClient(client)

Destroys the given WaylandClient client.


destroyClientForSurface(surface)

Destroys the client for the WaylandSurface surface.


© 2016 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.