Wayland features

Wayland Desktop features progress

This purpose of this page is to list the current missing or incomplete features in GNOME on Wayland to achieve a user experience on par with what is found on X11. But not all features listed here are equally important, there might even be some features listed which will not be implemented in Wayland eventually because they are not suitable.

This page is not meant to list known bugs or issues with existing features, nor how to debug Wayland issues, see How to debug Wayland problems for this.

It focuses primarily on GNOME because GNOME is the default desktop on Fedora Workstation, but features may need to be implemented at different levels not necessarily part of GNOME:

* kernel: drm, evdev, etc.
* libraries: underlying libraries, e.g. libinput, libwayland, etc.
* protocol: requires a new Wayland protocol or amending an existing protocol
* Xwayland: X11 compatibility
* mutter: Wayland compositor
* gtk+: toolkit, handles client side decorations in Wayland
* apps: requires new applications

Pending

accessibility: device controller

• mutter, at-spi-core, libei
• Completion: 25%

Orca has a feature called 'mouse review' which relies on the at-spi-registryd deviceeventcontroller interface to 'remote control' the pointer. To provide this functionality under Wayland, mutter needs to provide a device controller interface and at-spi-registryd needs to use it.

For QA and automated testing of the UI, there is gnome-ponytail-daemon which proxies mutter/gnome-shell internal API to an dogtail-like API.

For more complex usages such as Synergy or Barrier work is under way with libEI but that will require adding support in all the various relevant components (including Xwayland).

Restarting gnome-shell

• mutter, gnome-shell
• Completion: 0%
• See also: Remove X11 requirement in mutter
• See also: https://bugzilla.redhat.com/show_bug.cgi?id=1367666

Under X11, gnome-shell can be restarted at will without losing the current session (using Alt F2 → "r"). Similarly, the user session under X11 can survive a crash in gnome-shell as the session manager will automatically restart it.

Under Wayland, being the Wayland compositor as well, gnome-shell cannot be restarted without restarting the entire user session. Using Alt F2 → "r" states that "Restart is not available on Wayland".

As a result, if gnome-shell crashes under Wayland, the entire user session is terminated unexpectedly.

Complete

Outputs on secondary GPUs

• mutter
• Completion: 100%

Multi GPU setups are supported since circa GNOME 3.28

Hotplug USB devices

• mutter
• Completion: 100%

mutter 3.32 supports DisplayLink.

Remove X11 requirement in mutter

• mutter
• Completion: 100%

X11 is not longer a requirement for GNOME Shell/mutter with Wayland. Xwayland is started on-demand by default since GNOME 40 when an X11 client needs it and work is under way to have Xwayland shutting down automatically when all X11 clients have left.

See https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1794

Nvidia driver support

• mutter, Xwayland, nvidia drivers
• Completion: 100%

Hardware acceleration for GL and Vulkan is supported with Xwayland 21.1.2 and NVIDIA closed source driver series 470 using EGLStream.

Device and Driver information

• mutter, gnome-control-center
• Completion: 100% (TBD)

We want to show the same kind of GPU information in the Details pane of gnome-control-center that we get from GL_RENDERER under X11; currently, it just says "Wayland" there. I'm not entirely sure why this isn't done, glGetString(GL_RENDERER) works just fine under EGL.

Clipboard manager

• protocol, gtk+, mutter
• Completion: 100%

Under X11, gnome-settings-daemon offers an api to store the contents of the clipboard when the selection owner exits, and continues to make the clipboard contents available. Weston has a simple functionality, but without the optimization to only store the clipboard contents on exit. Mutter does not currently offer this.

accessibility: mouse

• mutter
• Completion: 100%

Mouse accessibility features such as hover-to-click are reimplemented in GNOME Shell/mutter.

remote display

• protocol, mutter
• Completion: 100%

Remote display, using pipewire.

Color temperature control

• protocol, mutter
• Completion: 100%

night-light, a similar feature to Redshift, has been merged into GNOME 3.24 and works on Wayland.

See also: https://bugzilla.redhat.com/show_bug.cgi?id=1285590 https://bugzilla.gnome.org/show_bug.cgi?id=741224

graphics tablet support

• libinput, protocol, libraries, gtk+, Xwayland
• Completion: 100%

Peter and Carlos are working on this.

libinput support has been merged in libinput 1.2.

protocol support has been included in wayland-protocols 1.3.

Support in mutter and gtk+ have been merged

Support for tablets in Xwayland has landed in git master, with downstream backports in xserver-1.19.x branch

Window size hints

• protocol, gtk+, mutter
• Completion: 100%
• See also: https://bugzilla.gnome.org/show_bug.cgi?id=764413

The wayland shell protocols lack the equivalent of ICCCM's WM_NORMAL_HINTS.

The resize increment is particularly useful for terminal emulators, which have to resize with character cell granularity. Mutter will display this information when resizing an X window, so this works for xterm, but not for gnome-terminal. We've just removed resize increments from GTK+, I don't think this should be added to Wayland.

Size hints have been added to the forthcoming xdg-shell v6. But that doesn't include size increments or aspect ratio, just min/max size.

min/max size support will be merged soon.

on-screen keyboard

• protocol, mutter
• Completion: 100%

The on-screen keyboard in gnome-shell currently does not work under Wayland. That needs to be fixed as a starting point. Doing a better job on OSK requires moving away from a key event based protocol to something more like a text protocol, which is where this task overlaps with input methods.

Carlos has been working on this.

Optional surface IDs

• protocol, gtk+, mutter
• Completion: 100%

This will be useful for xdg-app portals, so the portal can place dialogs relative to application surfaces. Jonas has a protocol proposal and an implementation.

All branches are ready to be merged.

Recording screencast

• mutter, apps
• Completion: 100%

Not sure what's missing here, unless you want to define a Wayland protocol for this. Recording screencasts using gnome-shell's D-Bus api works just fine today in a Wayland session.

Live screencasts using third-party applications (such as video meeting or screen sharing from a web browser) are out of scope for this feature, and rather fall under "remote display".

dnd actions

• gtk+, mutter, xwayland
• Completion: 100%

Carlos has a protocol proposal, and working implementations.
See https://bugzilla.gnome.org/show_bug.cgi?id=755625

Protocol additions for this have been merged. Mutter implementation of wl_data_offer v3 has been merged. GTK+ support for this has been merged too.

dnd: root window drops

• protocol, gtk+, mutter
• Completion: 100%

We need some way to transfer drop status information to the drag source.

Carlos is working on this here.

kinetic scrolling

• gtk+, mutter
• Completion: 100%

Peter has a protocol proposal and a working implementation.
See https://bugzilla.gnome.org/show_bug.cgi?id=756729

The Wayland protocol additions (pointer axis, etc) have landed. The mutter implementation has landed. The GTK+ support has landed upstream as well.

relative/locking pointer confinement

• protocol, libraries
• Completion: 100%
• Note: Required for games
• See also:
  http://lists.freedesktop.org/archives/wayland-devel/2014-December/018653.html
  http://lists.freedesktop.org/archives/wayland-devel/2015-October/024726.html

Jonas has a protocol and implementations. Will land in Wayland 1.10.
See https://bugzilla.gnome.org/show_bug.cgi?id=744104

Merged in mutter 3.19.90

hi-dpi support

• protocol, gtk+, mutter
• Completion: 100%

This should be complete, modulo bugs. Some additional discussions around this topic in upstream bug 93315

BLOCKER: startup notification

• protocol, libraries, gtk+, mutter
• Completion: 100% (TBD)

Carlos has branches with a minimal implementation that adds a new request to the private gtk-shell interface between gtk+ and mutter.

This work has been merged for 3.19.91

touch proxy for xwayland

• protocol, gtk+, mutter, Xwayland
• Completion: 100%

This should be complete, modulo bugs.

BLOCKER: primary selection

• protocol, gtk+, mutter, Xwayland
• Completion: 100%
• See also: https://wiki.gnome.org/Initiatives/Wayland/PrimarySelection

Lyude has a protocol suggestion and a working weston implementation.
See http://lists.freedesktop.org/archives/wayland-devel/2015-December/026084.html for the protocol.

Carlos has taken this over; he has mutter and gtk+ branches, and is now trying to finalize an agreed-on protocol. The branches have been merged now (including xwayland). Proper wayland protocol upstreaming is still pending

input methods

• protocol, gtk+, mutter
• Completion: 100%

The default input method setup in GTK+ is entirely client-side (display server send key events, the ibus module sends them over D-Bus to IBus...). This basically works under Wayland as it does under X, with the one exception that there is a problem with the placement of the candidate window. Rui is going to fix this for 3.19.90 [1]

accessibility: screen reader

• Completion: 90%

Screen reading (orca) works more or less the same as under X: all the accessibility traffic goes over D-Bus (the a11y bus, to be precise). One part that doesn't work is what orca calls 'mouse review', since it relies on the device event controller functionality of at-spi-registryd.

Other dnd features

• gtk+, mutter
• Completion: 100%

Need to complete support for

• Drag icons (DONE)
• Hotspots (DONE)
• Reliable drag end determination (DONE)
• Cancel animation (DONE)

Protocol additions for drag end and cancel animation have been merged.

attached modal dialogs

• applications
• Completion: 95%
• Note: Not sure if that should be seen as a bug or a feature. gtk+ rightfully sets "set_parent" in its wayland backend for transient windows, and it works in both gnome-shell and weston, but some apps don't use transient relationship and rely on the window manager to treat dialogs as transients for all windows of the same group. Those apps need to be fixed.
• See also:
  http://lists.freedesktop.org/archives/wayland-devel/2012-December/006637.html,
  http://lists.freedesktop.org/archives/wayland-devel/2015-November/025726.html

I believe this was fixed in upstream bug 745720

For transients without parent, there is upstream bug 759161

GTK+ now has reasonable support for this. Applications need to set transient parents on their dialogs and popups.

bell support

• mutter, protocol, gtk+
• Completion: 95%

X has XkbBell to create various beeps in connection to a window. Most of this could be done client-side, but the ability to reconfigure this to use a visual bell makes it something that needs to be provided by the compositor.

Jonas wrote a quick protocol, that for now is private between GTK+ and mutter. This has been merged for 3.19.92. Left to do: agree on proper Wayland protocol for this and make xwayland use it.

accessibility: visual bell

• protocol, gtk+, mutter
• Completion: 100%

X has bell functionality as part of its protocol.

Jonas has added Wayland protocol to do this, for now private between GTK+ and mutter.

Xfree86-VidModeExtension in Xwayland

• protocol, Xwayland
• Completion: 100%
• Note: Some games check for this extension and would refuse to start without. There are patches contributed but these are incomplete and not satisfactory. Beside, this is the same a current XRandR support, i.e. read-only, Xwayland apps cannot control the output configuration.
• See also:
  https://bugs.freedesktop.org/show_bug.cgi?id=87806,
  http://lists.x.org/archives/xorg-devel/2015-September/047460.html,
  http://lists.x.org/archives/xorg-devel/2015-October/047559.html
• Series of patches sent for review: https://patchwork.freedesktop.org/series/3118/

XVideo extension in Xwayland

• Xwayland
• Completion: 100%

Technically the extension is present, but no adaptors are exposed. This should be wired up to the subsurface protocol if possible.

Initial implementation by Olivier has landed.

clipboard proxy for xwayland

• Xwayland
• Completion: 100%

This should be working, modulo bugs.

Presenting windows

• protocol, gtk+, mutter
• Completion: 90%

We need some way to implement gtk_window_present(), which applications reply on.

Jonas added protocol to do this (for now private between gtk+ and mutter).

output rotation

• mutter
• Completion: 100%
• Note: Wayland protocol already supports output transformation, supported by Xwayland and weston can use it.
• See also: https://bugzilla.gnome.org/show_bug.cgi?id=745079

Support for hw rotation (as exposed by the graphics driver has landed upstream). Unfortunately, this support is less common in hw than one would think, so a software fallback is still needed.

Support for hw independent rotation has been merged into mutter.

Active grabs in Wayland and Xwayland

• protocol, mutter, Xwayland
• Completion: 100%
• https://bugs.freedesktop.org/show_bug.cgi?id=96547
• https://bugzilla.gnome.org/show_bug.cgi?id=752956
• https://bugzilla.redhat.com/show_bug.cgi?id=1285770
• https://bugs.freedesktop.org/show_bug.cgi?id=97333
• https://lists.freedesktop.org/archives/wayland-devel/2016-August/030863.html

Under X11, applications can have active grabs on either the pointer or the keyboard. Applications such as virtual machine viewers use this feature.

By design (and on purpose), Wayland doesn't allow clients to have an active grab so it's a bit complicated for Xwayland to translate these to the Wayland compositor.

A possibility would be to use a Wayland protocol to inform the compositor that a Wayland or Xwayland application requests an active grab. The compositor would then either allow or deny the grab, possibly inform/ask the user and provide visual feedback when a grab is active.

Both shortcuts-inhibitor and Xwayland-grab protocols are in wayland-protocols 1.9 Support for shortcuts-inhibitor protocol for Wayland native is in GNOME-3.26 (mutter, gnome-shell, gtk+) Support for Xwayland grabs is in Xserver master, support in mutter has landed in GNOME-3.27.

See also: https://bugzilla.gnome.org/show_bug.cgi?id=783342

accessibility: keyboard

• clutter, mutter
• Completion: 100%

Under X, key repeat and AccessX features (sticky keys, slow keys, bounce keys, toggle keys, etc) are implemented in the X server. Under Wayland, GTK+ currently implements key repeat on the client-side. There is a branch which adds the AccessX features, but implementing these client-side is not ideal, and leads to some regressions.

Slow keys, sticky keys, bounce keys, toggle keys and mouse keys support implemented, patches attached to bug https://bugzilla.gnome.org/show_bug.cgi?id=788564 pending reviews.

See: https://bugzilla.gnome.org/show_bug.cgi?id=788564

Dropped

XRandR control of Wayland outputs

• protocol, Xwayland
• Completion: 50% (TBD)
• Note: There is a "read-only" XRandR support in Xwayland, but it cannot send request back to the Wayland compositor so X11 applications have no control over the output configurations.
• See also: https://bugzilla.redhat.com/show_bug.cgi?id=1289714

[otaylor] We SHOULD NOT implement this. It's a vehicle for a game to mess up the user's system. The conceptual equivalent in Wayland is for an app to ask for it's buffer to be scaled or modeset fullscreen - and that needs to be implemented in Mutter - but I don't see providing to Xwayland apps; anything running under X11 I think just has to live with the screen's current configuration.

For legacy games which relied on XRandR to adjust the screen size to their capacity, Xwayland emulates that using a viewport to scale the (fullscreen, unreparented) window so it appears as if the resolution was changed.

screensaver control

• protocol, mutter, Xwayland, apps
• Completion: 0% (TBD)
• See also:
  https://bugs.freedesktop.org/show_bug.cgi?id=89440,
  http://lists.freedesktop.org/archives/wayland-devel/2015-November/025582.html

Not sure that anything is needed here. GNOME has been doing screensaver control entirely over D-Bus for many years.