Qt Wayland Compositor is a module that provides QML and C++ APIs for developing custom display servers based on the Wayland protocol. The server displays content from client applications that support the Wayland protocol.

Environment Variables and Command-line Arguments

The Qt Wayland Compositor API recognizes some environment variables and command-line arguments that can be used to customize its behavior.

• Environment variables:
  • QT_WAYLAND_HARDWARE_INTEGRATION Selects the hardware integration plugin to use.
  • QT_WAYLAND_CLIENT_BUFFER_INTEGRATION Selects the client buffer integration plugin to use.
  • QT_WAYLAND_SERVER_BUFFER_INTEGRATION Selects the server integration plugin to use.
• Command-line arguments:
  • --wayland-socket-name Overrides the default socket name used for communicating with clients.

Examples

Take a look at the Qt Wayland Compositor Examples for a demonstration on how the APIs can be used to write custom display servers.

Licenses and Attributions

Qt Wayland Compositor and the Qt Wayland integration plugin are available under commercial licenses from The Qt Company. In addition, they are available under the GNU Lesser General Public License, version 3, or the GNU General Public License, version 2. See Qt Licensing for further details.

Qt Wayland Compositor and the Qt Wayland integration plugin use protocol definitions under following permissive licenses:

API Reference

The Qt Wayland Compositor API can be used from C++ or QML.

• Qt Wayland Compositor QML Types
• Qt Wayland Compositor C++ Classes