diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 46 |
1 files changed, 32 insertions, 14 deletions
@@ -5,26 +5,21 @@ The QtWayland module consists of two parts: Wayland platform plugin: Enables Qt applications to be run as Wayland clients. -QtCompositor API: +QtWaylandCompositor API: Enables the creation of Wayland compositors using Qt and QtQuick. -By default only the Wayland platform plugin is built. If you want to build the -experimental QtCompositor API then you need to set the qmake CONFIG variable to -include "wayland-compositor" when building the QtWayland module: - -qmake CONFIG+=wayland-compositor -make - -Note: make sure the source tree is clean before running those commands. If in -doubt, run git clean -f -d -x. +Please note that QtWaylandCompositor and the QtWaylandClientExtension are +currently in tech preview. This means that all APIs in the QtWayland module are +preliminary and subject to change. The Wayland platform plugin remains officially +supported. To build the QtWayland module you need the external dependencies: xkbcommon 0.2.0 - http://xkbcommon.org/ -wayland 1.2.0 - http://wayland.freedesktop.org/ +wayland 1.6.0 - http://wayland.freedesktop.org/ -QtCompositor supports loading client buffer integrations that don't use the -wayland-egl interfaces. These client buffer integrations are picked up by -QtCompositor as plugins. To specify what plugin to load use the environment +QtWaylandCompositor supports loading client buffer integrations that don't use +the wayland-egl interfaces. These client buffer integrations are picked up by +QtWaylandCompositor as plugins. To specify what plugin to load use the environment variable QT_WAYLAND_CLIENT_BUFFER_INTEGRATION in the environment where the compositor is started. The compositor will broadcast to the clients which hardware integration to load when using the generic platformplugin "wayland". If @@ -45,6 +40,29 @@ brcm xcomposite-egl xcomposite-glx +Shell Integration: + +Some platforms, especially non-desktop ones, use a custom Wayland shell +extension. These are tailored to the specific embedded form factor better than +the generic wl_shell or xdg_shell extensions that target desktop systems. + +Instead of adding multiple protocol implementations into the QPA plugin, +a plugin architecture is used for selecting the shell integration; +when creating a shell surface, the protocol to use is taken from +the QT_WAYLAND_SHELL_INTEGRATION environment variable. If one is not provided or +not pointing to a valid plugin, wl_shell or xdg_shell will be used as fallbacks. + +Example Usage: + +Starting the hellowindow example application (one of the examples for qtbase) +with ivi-shell integration: + + QT_WAYLAND_SHELL_INTEGRATION=ivi-shell ./hellowindow -platform wayland + +Available Shell Integrations: + + * ivi-shell + We hang out at #qt-labs and #qt-lighthouse on freenode if you have any questions |