Difference between revisions of "Wayland"

From ArchWiki
Jump to navigation Jump to search
(Deps in weston-1.0.6-2)
m (Mention that RDP backend for wlroot has been removed and replaced with VNC.)
 
(462 intermediate revisions by more than 100 users not shown)
Line 1: Line 1:
[[Category:X Server]]
+
[[Category:Graphical user interfaces]]
 +
[[es:Wayland]]
 
[[fr:Wayland]]
 
[[fr:Wayland]]
 
[[ja:Wayland]]
 
[[ja:Wayland]]
[[zh-CN:Wayland]]
+
[[pt:Wayland]]
{{Article summary start}}
+
[[ru:Wayland]]
{{Article summary text|A guide to installing and running the Wayland display server.}}
+
[[zh-hans:Wayland]]
{{Article summary heading|Related}}
+
{{Related articles start}}
{{Article summary wiki|KMS}}
+
{{Related|KMS}}
{{Article summary wiki|Xorg}}
+
{{Related|Xorg}}
{{Article summary end}}
+
{{Related articles end}}
  
'''Wayland''' is a new windowing protocol for Linux. Utilization of Wayland requires changes to and re-installation of parts of your system's software. For more information on Wayland see its [http://wayland.freedesktop.org/ homepage].
+
[https://wayland.freedesktop.org/ Wayland] is a protocol for a [[wikipedia:Compositing window manager|compositing window manager]] to talk to its clients, as well as a library implementing the protocol. It is supported on some desktop environments like [[GNOME]] and [[KDE]]. There is also a compositor reference implementation called [[Weston]]. XWayland provides a compatibility layer to seamlessly run legacy [[X11]] applications in Wayland.
  
{{Warning|Wayland is under heavy development. Support can not be guaranteed and it may not function as you expect.}}
+
== Requirements ==
 +
 
 +
Most Wayland compositors only work on systems using [[Kernel mode setting]]. Wayland by itself does not provide a graphical environment; for this you also need a compositor such as [[Weston]] or [[Sway]], or a desktop environment that includes a compositor like [[GNOME]] or [[KDE]].
 +
 
 +
For the GPU driver and Wayland compositor to be compatible they must support the same buffer API. There are two main APIs: [[Wikipedia:Generic Buffer Management|GBM]] and [https://www.phoronix.com/scan.php?page=news_item&px=XDC2016-Device-Memory-API EGLStreams].
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Buffer API !! GPU driver support !! Wayland compositor support
 +
|-
 +
| GBM || All except [[NVIDIA]] || All
 +
|-
 +
| EGLStreams || [[NVIDIA]] || [[GNOME]], [[KDE]]
 +
|-
 +
|}
 +
 
 +
== Compositors ==
 +
 
 +
{| class="wikitable sortable"
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| Mutter
 +
| Stacking
 +
| See [[GNOME#Starting]].
 +
|-
 +
| sway
 +
| Tiling
 +
| [[Sway]] is an i3-compatible window manager for Wayland. [https://github.com/SirCmpwn/sway GitHub]
 +
|-
 +
| Enlightenment
 +
| Stacking and tiling
 +
| [https://www.enlightenment.org/about-wayland More Info]
 +
|-
 +
| KDE Kwin
 +
| Stacking
 +
| See [[KDE#Starting Plasma]]
 +
|-
 +
| Orbment
 +
| Tiling
 +
| [https://github.com/Cloudef/orbment orbment] (previously loliwm) is an abandoned tiling WM for Wayland.
 +
|-
 +
| Velox
 +
| Tiling
 +
| [[Velox]] is a simple window manager based on swc. It is inspired by [[dwm]] and [[xmonad]].
 +
|-
 +
| Orbital
 +
| Stacking
 +
| [https://github.com/giucam/orbital Orbital] is a Wayland compositor and shell (more akin to a WM than a DE) using Qt5 and Weston. The goal of the project is to build a simple but flexible and good looking Wayland desktop.
 +
|-
 +
| Liri Shell
 +
| Stacking
 +
| [https://github.com/lirios/shell Liri Shell] is the desktop shell for [[Liri]], built using QtQuick and QtCompositor as a compositor for Wayland.
 +
|-
 +
| Maynard
 +
| ''(Unclear)''
 +
| [https://github.com/raspberrypi/maynard Maynard] is a desktop shell client for Weston based on GTK. It was based on weston-gtk-shell, a project by Tiago Vignatti. Not under development. [https://github.com/raspberrypi/maynard/issues/54#issuecomment-303422302][https://github.com/raspberrypi/maynard/issues/55#issuecomment-373808518]
 +
|-
 +
| Motorcar
 +
| ''(Unclear)''
 +
| [https://github.com/evil0sheep/motorcar Motorcar] is a Wayland compositor to explore 3D windowing using virtual reality.
 +
|-
 +
| Maze Compositor
 +
| Floating 3D
 +
| [https://github.com/imbavirus/mazecompositor Maze Compositor] is a 3D Qt based Wayland compositor
 +
|-
 +
| Cage
 +
| Kiosk
 +
| [https://www.hjdskes.nl/projects/cage/ Cage] is a Wayland compositor that displays a single fullscreen application
 +
|-
 +
| Greenfield
 +
| Stacking
 +
| [https://github.com/udevbe/greenfield Greenfield] is a Wayland compositor that runs in a web browser and can display remote applications
 +
|-
 +
| Grefsen
 +
| Floating
 +
| [https://github.com/ec1oud/grefsen Grefsen] is a Qt/Wayland compositor providing a minimal desktop environment.
 +
|-
 +
| Waymonad
 +
| Tiling
 +
| [https://github.com/waymonad/waymonad Waymonad] is a Wayland compositor based on ideas from and inspired by xmonad
 +
|-
 +
| wayfire
 +
| Stacking
 +
| [https://github.com/WayfireWM/wayfire Wayfire] is a general purpose compositor.
 +
|-
 +
| Weston
 +
| Floating
 +
| [[Weston]] is a Wayland compositor reference implementation.
 +
|}
 +
 
 +
Some of the above may support [[display manager]]s. Check {{ic|/usr/share/wayland-sessions/''compositor''.desktop}} to see how they are started.
 +
 
 +
== Display managers ==
 +
 
 +
Below listed display managers which supports running Wayland compositors. The Type column indicates whether the display manager supports running on Wayland or not.
 +
 
 +
{| class="wikitable sortable"
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| [[GDM]]
 +
| Runs on Wayland
 +
| [[GNOME]] display manager.
 +
|-
 +
| [[LightDM]]
 +
| Runs on X11
 +
| Cross-desktop display manager.
 +
|-
 +
| [[Ly]]
 +
| Runs in console
 +
| TUI display manager written in C
 +
|-
 +
| [[SDDM]]
 +
| Runs on X11
 +
| QML-based display manager.
 +
|}
 +
 
 +
== GUI libraries ==
 +
 
 +
See details on the [https://wayland.freedesktop.org/toolkits.html official website].
 +
 
 +
=== GTK 3 ===
 +
 
 +
The {{Pkg|gtk3}} package has the Wayland backend enabled. GTK will default to the Wayland backend, but it is possible to override it to Xwayland by modifying an environment variable: {{ic|1=GDK_BACKEND=x11}}.
 +
 
 +
=== Qt 5 ===
 +
 
 +
To enable Wayland support in Qt 5, install the {{Pkg|qt5-wayland}} package.
 +
 
 +
To run a Qt 5 app with the Wayland plugin [https://wiki.qt.io/QtWayland#How_do_I_use_QtWayland.3F], use {{ic|1=-platform wayland}} or {{ic|1=QT_QPA_PLATFORM=wayland-egl}} [[environment variable]]. To force the usage of [[X11]] on a Wayland session, use {{ic|1=QT_QPA_PLATFORM=xcb}}.
 +
 
 +
=== Clutter ===
 +
 
 +
The Clutter toolkit has a Wayland backend that allows it to run as a Wayland client. The backend is enabled in the {{Pkg|clutter}} package.
 +
 
 +
To run a Clutter app on Wayland, set {{ic|1=CLUTTER_BACKEND=wayland}}.
 +
 
 +
=== SDL2 ===
 +
 
 +
To run a SDL2 application on Wayland, set {{ic|1=SDL_VIDEODRIVER=wayland}}.
 +
 
 +
{{Note|Many proprietary games come bundled with old versions of SDL, which don't support Wayland and might break entirely if you set {{ic|1=SDL_VIDEODRIVER=wayland}}. To force the application to run with XWayland, set {{ic|1=SDL_VIDEODRIVER=x11}}.}}
 +
 
 +
=== GLFW ===
  
== Requirements ==
+
To use GLFW with the Wayland backend, install the {{Pkg|glfw-wayland}} package (instead of {{Pkg|glfw-x11}}).
Currently Wayland will only work with on a system that is utilizing [[KMS]].
+
 
 +
=== GLEW ===
 +
 
 +
To use GLEW with the Wayland backend, install the {{Pkg|glew-wayland}} package (instead of {{Pkg|glew}}).
 +
 
 +
=== EFL ===
 +
 
 +
EFL has complete Wayland support. To run a EFL application on Wayland, see Wayland [https://wayland.freedesktop.org/efl.html project page].
 +
 
 +
=== winit ===
 +
 
 +
Winit is window handling library in Rust. It will default to the Wayland backend, but it is possible to override it to Xwayland by modifying an environment variable: {{ic|1=WINIT_UNIX_BACKEND=x11}}.
 +
 
 +
==Troubleshooting==
 +
 
 +
=== Gamma ===
 +
 
 +
While [[Redshift]] doesn't support Wayland (without a patch) it is possible to apply the desired temperature in [[tty]] before starting a compositor. For example:
  
== Installation ==
+
  redshift -m drm -PO 3000
Wayland is most probably installed on your system already as it is an indirect dependency of {{pkg|gtk2}} and {{pkg|gtk3}}. If it is not installed, you will find the {{pkg|wayland}} package in extra.
 
  
== Usage ==
+
Otherwise some compositors feature this option during runtime:
As Wayland is only a library, it is useless on its own. To use it, you need a compositor (like Weston), Weston demo applications, Qt5 with Wayland plugin, and/or GTK+ with Wayland support.
 
  
== Weston ==
+
* [[GNOME]] provides features like [[Redshift]] out-of-the-box and has Wayland support. Enable [[GNOME#Night_Light|Night Light]] in Display settings.
=== Installation ===
+
* Likewise, [[KDE Plasma]] also provides ''Night Color''.
You need to install {{pkg|weston}} from community.
+
* On Sway 1.0 and other wlroots-based compositors, {{AUR|redshift-wlr-gamma-control-git}} can be used.
 +
* On Orbital, {{AUR|redshift-wayland-git}} can be used.
  
=== Usage ===
+
=== LLVM assertion failure ===
Now that Wayland and its requirements are installed you should be ready to test it out. Try switching to a terminal and running:
 
$ weston-launch
 
{{Note|You need to be in the video group for Weston to start; this command is not supposed to be run as root and doing that may freeze your VT. }}
 
{{Note|If you get an LLVM assertion failure, you need to rebuild {{Pkg|mesa}} without Gallium LLVM until this problem is fixed. This may imply disabling some drivers which require LLVM.}}
 
  
You may also try exporting the following, if having problems with hardware drivers:
+
If you get an LLVM assertion failure, you need to rebuild {{Pkg|mesa}} without Gallium LLVM until this problem is fixed.  
$ export EGL_DRIVER=/usr/lib/egl/egl_gallium.so
 
  
It is possible to run Weston inside a running X session:
+
This may imply disabling some drivers which require LLVM. You may also try exporting the following, if having problems with hardware drivers:  
$ weston
 
  
Then at a TTY you can run the demos. To launch a terminal emulator:
+
  $ export EGL_DRIVER=/usr/lib/egl/egl_gallium.so
  $ weston-terminal
 
  
To move flowers around the screen:
+
=== Slow motion, graphical glitches, and crashes ===
$ weston-flower
 
  
To test the frame protocol (runs {{ic|glxgears}}):
+
Gnome-shell users may experience display issues when they switch to Wayland from X. One of the root cause might be the {{ic|1=CLUTTER_PAINT=disable-clipped-redraws:disable-culling}} set by yourself for Xorg-based gnome-shell. Just try to remove it from {{ic|/etc/environment}} or other rc files to see if everything goes back to normal.
$ weston-gears
 
  
To display images:
+
=== Cannot open display: :0 with Electron-based applications ===
$ weston-image image1.jpg image2.jpg...
 
  
To display PDF Files:
+
Make sure you haven't set GDK_BACKEND=wayland. Setting it globally will break Electron apps.
$ weston-view doc1.pdf doc2.pdf...
 
  
== GUI libraries ==
+
=== Screen recording ===
([http://wayland.freedesktop.org/toolkits.html page from official website])
 
  
===GTK+===
+
{{AUR|green-recorder}}, {{AUR|obs-gnome-screencast}} and {{AUR|obs-xdg-portal-git}} support screen recording on Wayland using GNOME screencast feature.
  
You need to install {{pkg|gtk3}} from extra, which now has the Wayland backend enabled.
+
{{AUR|wf-recorder-git}} is a video recorder for wlroots-based compositors.
  
With GTK+ 3.0, GTK+ gained support for multiple backends at runtime and can switch between backends in the same way Qt can with lighthouse.
+
{{AUR|wlrobs-hg}} is a {{Pkg|obs-studio}} plugin that allows you to screen capture on wlroots-based compositors.
  
When both Wayland and X backends are enabled, GTK+ will default to the X11 backend, but this can be overridden by setting the <code>GDK_BACKEND</code> environment variable to <code>wayland</code>.
+
=== Remote display ===
  
Remove {{pkg|libcanberra}} if you get segmentation faults when running gtk applications. A [http://git.0pointer.de/?p=libcanberra.git;a=commit;h=c0620e432650e81062c1967cc669829dbd29b310 fix] for these segfaults has been committed as of 9 Nov 2012, so presumably as soon as 0.31.0 comes out, this should not be necessary anymore.
+
* (20200206) {{pkg|wlroots}} (used by [[sway]]) offers an VNC backend via {{AUR|wayvnc}} since version 0.10. RDP backend has been removed. [https://github.com/swaywm/wlroots/releases/tag/0.10.0].
 +
* (20180401) {{pkg|mutter}} has now remote desktop enabled at compile time, see [https://wiki.gnome.org/Projects/Mutter/RemoteDesktop] and {{Pkg|gnome-remote-desktop}} for details.
 +
* There was a merge of FreeRDP into Weston in 2013, enabled via a compile flag. The {{Pkg|weston}} package has it enabled since version 6.0.0.
 +
* {{AUR|waypipe-git}} is a transparent proxy for Wayland applications, with a wrapper command to run over [[SSH]]
  
===Qt5===
+
=== Input grabbing in games, remote desktop and VM windows  ===
  
You need to install {{pkg|qt5-base}} and the wayland plugin - {{aur|qt5-qtwayland-git}}.
+
In contrast to Xorg, Wayland does not allow exclusive input device grabbing, also known as active or explicit grab (e.g. [https://tronche.com/gui/x/xlib/input/XGrabKeyboard.html keyboard], [https://tronche.com/gui/x/xlib/input/XGrabPointer.html mouse]), instead, it depends on the Wayland compositor to pass keyboard shortcuts and confine the pointer device to the application window.
  
To run a Qt5 app with the Wayland plugin, set QT_QPA_PLATFORM=wayland-egl.
+
This change in input grabbing breaks current applications' behavior, meaning:
  
===Clutter===
+
* Hotkey combinations and modifiers will be caught by the compositor and won't be sent to remote desktop and virtual machine windows.
 +
* The mouse pointer will not be restricted to the application's window which might cause a parallax effect where the location of the mouse pointer inside the window of the virtual machine or remote desktop is displaced from the host's mouse pointer.
  
The Clutter toolkit has a Wayland backend that allows it to run as a Wayland client. The backend is in the master branch of the [http://git.gnome.org/browse/clutter main repo] and can be activated by passing <code>--with-flavour=wayland</code> to the configure script.
+
Wayland solves this by adding protocol extensions for Wayland and XWayland. Support for these extensions is needed to be added to the Wayland compositors. In the case of native Wayland clients, the used widget toolkits (e.g GTK, Qt) needs to support these extensions or the applications themselves if no widget toolkit is being used. In the case of Xorg applications, no changes in the applications or widget toolkits are needed as the XWayland support is enough.
  
===SDL===
+
These extensions are already included in {{pkg|wayland-protocols}}, and supported by {{pkg|xorg-server-xwayland}} 1.20.
  
Benjamin Franzke is working on a port of SDL to Wayland, it's available in his [http://cgit.freedesktop.org/~bnf/sdl-wayland/ sdl-wayland repo] on freedesktop.org. Further development upon Benjamins work was done by Andre Heider in his [https://github.com/dhewg/libsdl/tree/wl wayland branch] of libsdl.
+
The related extensions are:
  
===EFL===
+
* [https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/xwayland-keyboard-grab/xwayland-keyboard-grab-unstable-v1.xml XWayland keyboard grabbing protocol]
 +
* [https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/keyboard-shortcuts-inhibit/keyboard-shortcuts-inhibit-unstable-v1.xml Compositor shortcuts inhibit protocol]
 +
* [https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/relative-pointer/relative-pointer-unstable-v1.xml Relative pointer protocol]
 +
* [https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/pointer-constraints/pointer-constraints-unstable-v1.xml Pointer constraints protocol]
  
EFL has complete Wayland support. Please see [http://trac.enlightenment.org/e/wiki/Wayland here] for details.
+
Supporting Wayland compositors:
  
==Window managers and desktop shells==
+
* Mutter, [[GNOME]]'s compositor [https://bugzilla.gnome.org/show_bug.cgi?id=783342 since release 3.28].
  
===KDE===
+
Supporting widget toolkits:
  
There is [http://blog.martin-graesslin.com/blog/2011/03/kwin-at-gsoc-2011/ early work] to make it possible to run KWin (KDE's window manager) on Wayland.
+
* GTK since release 3.22.18.
  
===GNOME===
+
==== wlroots input inhibitor protocol ====
  
GNOME will be ported to Wayland in a future version.
+
[https://github.com/swaywm/wlr-protocols/blob/master/unstable/wlr-input-inhibitor-unstable-v1.xml Input inhibitor] is a Wayland protocol which was defined the by developers of Sway and wlroots and is overlapping Wayland's {{ic|Compositor shortcuts inhibit}} protocol.<br/>
 +
Sway and wlroots do not support the {{ic|Compositor shortcuts inhibit}} and {{ic|XWayland keyboard grabbing}} protocols, and it seems they are against adding support for the latter [https://github.com/swaywm/wlroots/pull/635#issuecomment-366385856] [https://github.com/swaywm/wlroots/issues/624#issuecomment-367276476].<br/>
 +
No widget toolkit or application is known to support this protocol.
  
==See also==
+
== See also ==
* [[Cursor Themes]]
 
  
==External links==
+
* [https://fedoraproject.org/wiki/How_to_debug_Wayland_problems Article about Wayland debugging on Fedora Wiki]
 +
* [[Cursor themes]]
 
* [https://bbs.archlinux.org/viewtopic.php?id=107499 Arch Linux forum discussion]
 
* [https://bbs.archlinux.org/viewtopic.php?id=107499 Arch Linux forum discussion]
* [http://wayland.freedesktop.org/docs/html/ Wayland documentation online]
+
* [https://wayland.freedesktop.org/docs/html/ Wayland documentation online]

Latest revision as of 05:26, 6 February 2020

Wayland is a protocol for a compositing window manager to talk to its clients, as well as a library implementing the protocol. It is supported on some desktop environments like GNOME and KDE. There is also a compositor reference implementation called Weston. XWayland provides a compatibility layer to seamlessly run legacy X11 applications in Wayland.

Requirements

Most Wayland compositors only work on systems using Kernel mode setting. Wayland by itself does not provide a graphical environment; for this you also need a compositor such as Weston or Sway, or a desktop environment that includes a compositor like GNOME or KDE.

For the GPU driver and Wayland compositor to be compatible they must support the same buffer API. There are two main APIs: GBM and EGLStreams.

Buffer API GPU driver support Wayland compositor support
GBM All except NVIDIA All
EGLStreams NVIDIA GNOME, KDE

Compositors

Name Type Description
Mutter Stacking See GNOME#Starting.
sway Tiling Sway is an i3-compatible window manager for Wayland. GitHub
Enlightenment Stacking and tiling More Info
KDE Kwin Stacking See KDE#Starting Plasma
Orbment Tiling orbment (previously loliwm) is an abandoned tiling WM for Wayland.
Velox Tiling Velox is a simple window manager based on swc. It is inspired by dwm and xmonad.
Orbital Stacking Orbital is a Wayland compositor and shell (more akin to a WM than a DE) using Qt5 and Weston. The goal of the project is to build a simple but flexible and good looking Wayland desktop.
Liri Shell Stacking Liri Shell is the desktop shell for Liri, built using QtQuick and QtCompositor as a compositor for Wayland.
Maynard (Unclear) Maynard is a desktop shell client for Weston based on GTK. It was based on weston-gtk-shell, a project by Tiago Vignatti. Not under development. [1][2]
Motorcar (Unclear) Motorcar is a Wayland compositor to explore 3D windowing using virtual reality.
Maze Compositor Floating 3D Maze Compositor is a 3D Qt based Wayland compositor
Cage Kiosk Cage is a Wayland compositor that displays a single fullscreen application
Greenfield Stacking Greenfield is a Wayland compositor that runs in a web browser and can display remote applications
Grefsen Floating Grefsen is a Qt/Wayland compositor providing a minimal desktop environment.
Waymonad Tiling Waymonad is a Wayland compositor based on ideas from and inspired by xmonad
wayfire Stacking Wayfire is a general purpose compositor.
Weston Floating Weston is a Wayland compositor reference implementation.

Some of the above may support display managers. Check /usr/share/wayland-sessions/compositor.desktop to see how they are started.

Display managers

Below listed display managers which supports running Wayland compositors. The Type column indicates whether the display manager supports running on Wayland or not.

Name Type Description
GDM Runs on Wayland GNOME display manager.
LightDM Runs on X11 Cross-desktop display manager.
Ly Runs in console TUI display manager written in C
SDDM Runs on X11 QML-based display manager.

GUI libraries

See details on the official website.

GTK 3

The gtk3 package has the Wayland backend enabled. GTK will default to the Wayland backend, but it is possible to override it to Xwayland by modifying an environment variable: GDK_BACKEND=x11.

Qt 5

To enable Wayland support in Qt 5, install the qt5-wayland package.

To run a Qt 5 app with the Wayland plugin [3], use -platform wayland or QT_QPA_PLATFORM=wayland-egl environment variable. To force the usage of X11 on a Wayland session, use QT_QPA_PLATFORM=xcb.

Clutter

The Clutter toolkit has a Wayland backend that allows it to run as a Wayland client. The backend is enabled in the clutter package.

To run a Clutter app on Wayland, set CLUTTER_BACKEND=wayland.

SDL2

To run a SDL2 application on Wayland, set SDL_VIDEODRIVER=wayland.

Note: Many proprietary games come bundled with old versions of SDL, which don't support Wayland and might break entirely if you set SDL_VIDEODRIVER=wayland. To force the application to run with XWayland, set SDL_VIDEODRIVER=x11.

GLFW

To use GLFW with the Wayland backend, install the glfw-wayland package (instead of glfw-x11).

GLEW

To use GLEW with the Wayland backend, install the glew-wayland package (instead of glew).

EFL

EFL has complete Wayland support. To run a EFL application on Wayland, see Wayland project page.

winit

Winit is window handling library in Rust. It will default to the Wayland backend, but it is possible to override it to Xwayland by modifying an environment variable: WINIT_UNIX_BACKEND=x11.

Troubleshooting

Gamma

While Redshift doesn't support Wayland (without a patch) it is possible to apply the desired temperature in tty before starting a compositor. For example:

redshift -m drm -PO 3000

Otherwise some compositors feature this option during runtime:

LLVM assertion failure

If you get an LLVM assertion failure, you need to rebuild mesa without Gallium LLVM until this problem is fixed.

This may imply disabling some drivers which require LLVM. You may also try exporting the following, if having problems with hardware drivers:

$ export EGL_DRIVER=/usr/lib/egl/egl_gallium.so

Slow motion, graphical glitches, and crashes

Gnome-shell users may experience display issues when they switch to Wayland from X. One of the root cause might be the CLUTTER_PAINT=disable-clipped-redraws:disable-culling set by yourself for Xorg-based gnome-shell. Just try to remove it from /etc/environment or other rc files to see if everything goes back to normal.

Cannot open display: :0 with Electron-based applications

Make sure you haven't set GDK_BACKEND=wayland. Setting it globally will break Electron apps.

Screen recording

green-recorderAUR, obs-gnome-screencastAUR and obs-xdg-portal-gitAUR support screen recording on Wayland using GNOME screencast feature.

wf-recorder-gitAUR is a video recorder for wlroots-based compositors.

wlrobs-hgAUR is a obs-studio plugin that allows you to screen capture on wlroots-based compositors.

Remote display

  • (20200206) wlroots (used by sway) offers an VNC backend via wayvncAUR since version 0.10. RDP backend has been removed. [4].
  • (20180401) mutter has now remote desktop enabled at compile time, see [5] and gnome-remote-desktop for details.
  • There was a merge of FreeRDP into Weston in 2013, enabled via a compile flag. The weston package has it enabled since version 6.0.0.
  • waypipe-gitAUR is a transparent proxy for Wayland applications, with a wrapper command to run over SSH

Input grabbing in games, remote desktop and VM windows

In contrast to Xorg, Wayland does not allow exclusive input device grabbing, also known as active or explicit grab (e.g. keyboard, mouse), instead, it depends on the Wayland compositor to pass keyboard shortcuts and confine the pointer device to the application window.

This change in input grabbing breaks current applications' behavior, meaning:

  • Hotkey combinations and modifiers will be caught by the compositor and won't be sent to remote desktop and virtual machine windows.
  • The mouse pointer will not be restricted to the application's window which might cause a parallax effect where the location of the mouse pointer inside the window of the virtual machine or remote desktop is displaced from the host's mouse pointer.

Wayland solves this by adding protocol extensions for Wayland and XWayland. Support for these extensions is needed to be added to the Wayland compositors. In the case of native Wayland clients, the used widget toolkits (e.g GTK, Qt) needs to support these extensions or the applications themselves if no widget toolkit is being used. In the case of Xorg applications, no changes in the applications or widget toolkits are needed as the XWayland support is enough.

These extensions are already included in wayland-protocols, and supported by xorg-server-xwayland 1.20.

The related extensions are:

Supporting Wayland compositors:

Supporting widget toolkits:

  • GTK since release 3.22.18.

wlroots input inhibitor protocol

Input inhibitor is a Wayland protocol which was defined the by developers of Sway and wlroots and is overlapping Wayland's Compositor shortcuts inhibit protocol.
Sway and wlroots do not support the Compositor shortcuts inhibit and XWayland keyboard grabbing protocols, and it seems they are against adding support for the latter [6] [7].
No widget toolkit or application is known to support this protocol.

See also