summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohan Klokkhammer Helsing <johan.helsing@qt.io>2016-11-22 13:37:10 +0100
committerPaul Olav Tvete <paul.tvete@qt.io>2016-12-06 08:42:44 +0000
commite2f856d9da896c202d98b179b9482fe7e7b57222 (patch)
treed9b79e62827a2eae39c819f8a963a7637a3e620c /README
parent542c6392ca52f86bd5fffb6141e93ad2a1ab8fcb (diff)
downloadqtwayland-e2f856d9da896c202d98b179b9482fe7e7b57222.tar.gz
Deprecate QT_WAYLAND_USE_XDG_SHELL
In favor of QT_WAYLAND_SHELL_INTEGRATION, which can be set to: - ivi-shell - wl-shell - xdg-shell-v5 - xdg-shell-v6 Change-Id: Ie2ca1184f22dcac56beb441329ea8b5a9a81baf4 Reviewed-by: Paul Olav Tvete <paul.tvete@qt.io>
Diffstat (limited to 'README')
-rw-r--r--README12
1 files changed, 7 insertions, 5 deletions
diff --git a/README b/README
index d0c5e03c..8215b30b 100644
--- a/README
+++ b/README
@@ -67,12 +67,11 @@ 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.
+Custom shell protocols are added through shell integration plugins.
-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.
+Which shell integration to use is determined by the QT_WAYLAND_SHELL_INTEGRATION
+environment variable. If no shell is specified, the default is to first try
+xdg-shell-v6 and then wl-shell.
Example Usage:
@@ -84,6 +83,9 @@ with ivi-shell integration:
Available Shell Integrations:
* ivi-shell
+ * wl-shell
+ * xdg-shell-v5
+ * xdg-shell-v6
We hang out at #qt-labs and #qt-lighthouse on freenode if you have any questions