Wayland: Difference between revisions

(10 intermediate revisions by 5 users not shown)

Line 1:

[https://wayland.freedesktop.org/ Wayland] is a modern display server protocol intended as a replacement for the legacy [[Xorg | X11]] system.

For additional details, see {{NixOS Manual|anchor=#sec-wayland|name=NixOS Manual: Chapter - Wayland}}.

== Checking for Wayland ==

To check if you are using Wayland, run the following command ~~{{Commands|~~$ echo $XDG_SESSION_TYPE}} If {{ic|wayland}} is returned, you are running Wayland

To check if you are using Wayland, run the following command

$ echo $XDG_SESSION_TYPE

</syntaxhighlight>

If {{ic|wayland}} is returned, you are running Wayland

== Setup ==

Line 31:

Line 39:

=== X and Wayland support ===

* [https://github.com/NixOS/nixpkgs/blob/nixos-23.11/pkgs/desktops/gnome/core/mutter/default.nix Mutter] is the default [[GNOME]] Desktop Environment~~/Compositor~~.

* [https://github.com/NixOS/nixpkgs/blob/nixos-23.11/pkgs/desktops/gnome/core/mutter/default.nix Mutter] is the default compositor for [[GNOME]] Desktop Environment.

* [https://github.com/NixOS/nixpkgs/blob/nixos-23.11/pkgs/desktops/plasma-5/default.nix ~~Plasma~~] is the default [[KDE]] Desktop Environment~~/Compositor~~.

* [https://github.com/NixOS/nixpkgs/blob/nixos-23.11/pkgs/desktops/plasma-5/kwin/default.nix KWin] is the default compositor for [[KDE]] Desktop Environment.

== Applications ==

Not all apps support running natively on Wayland. To work around this, ~~XWayland~~ should be enabled. {{Note|Enabling XWayland varies slightly from Compositor to Compositor, and may already be enabled. Consult your Compositor's documentation and/or nix file for how to enable}}

Not all apps support running natively on Wayland. To work around this, Xwayland should be enabled. {{Note|Enabling XWayland varies slightly from Compositor to Compositor, and may already be enabled. Consult your Compositor's documentation and/or nix file for how to enable}}

=== Electron and Chromium ===

Ozone Wayland (which uses Wayland native instead of Xwayland) support in [[Chromium]] and [[Electron]] based applications can be enabled by setting the environment variable "<code>NIXOS_OZONE_WL</code>" with <code>NIXOS_OZONE_WL=1</code> ''(also see [https://github.com/NixOS/nixpkgs/commit/b2eb5f62a7fd94ab58acafec9f64e54f97c508a6 commit])''

As of NixOS 25.05 ("Warbler"), if <code>XDG_SESSION_TYPE</code> is unset or set to "wayland", [https://issues.chromium.org/issues/40083534#comment599 chromium and electron apps will default to wayland native]. This ignores the <code>DISPLAY</code> environment variable.

==== ~~Electron and Chromium~~ ====

==== Declaratively (permanent) ====

~~~~

===== NixOS =====

~~As of NixOS 22.05 ("Quokka"), you can enable Ozone Wayland support in [[Chromium]] and [[Electron]] based applications by setting the environment variable <code>NIXOS_OZONE_WL~~=1</~~code>~~. ~~For example, in a {{ic~~|~~configuration.~~nix}}:

{{File|3=environment.sessionVariables.NIXOS_OZONE_WL = "1";|name=/etc/nixos/configuration.nix|lang=nix}}

==== Imperatively (each time an application is launched) ====

~~environment.sessionVariables.~~NIXOS_OZONE_WL = "1";

Example: to launch <code>code</code> ''({{Nixpkg|pkgs/applications/editors/vscode/vscode.nix|vscode}})''

$ NIXOS_OZONE_WL=1 code

</syntaxhighlight>

~~This allows these applications~~ to ~~run without Xwayland~~.

== Virtualization ==

To have wayland work inside of [[QEMU]], you may need to pass <code>-vga qxl</code>.

== See also ==

* [[Xorg]]

[[Category:Desktop]]

@@ Line 1: / Line 1: @@
 {{Expansion|Verify accuracy of article}}
+[https://wayland.freedesktop.org/ Wayland] is a modern display server protocol intended as a replacement for the legacy [[Xorg | X11]] system.
+For additional details, see {{NixOS Manual|anchor=#sec-wayland|name=NixOS Manual: Chapter - Wayland}}.
 == Checking for Wayland ==
-To check if you are using Wayland, run the following command {{Commands|$ echo $XDG_SESSION_TYPE}} If {{ic|wayland}} is returned, you are running Wayland
+To check if you are using Wayland, run the following command
+<syntaxhighlight lang=console>
+$ echo $XDG_SESSION_TYPE
+</syntaxhighlight>
+If {{ic|wayland}} is returned, you are running Wayland
 == Setup ==
@@ Line 31: / Line 39: @@
 === X and Wayland support ===
-* [https://github.com/NixOS/nixpkgs/blob/nixos-23.11/pkgs/desktops/gnome/core/mutter/default.nix Mutter] is the default [[GNOME]] Desktop Environment/Compositor.
+* [https://github.com/NixOS/nixpkgs/blob/nixos-23.11/pkgs/desktops/gnome/core/mutter/default.nix Mutter] is the default compositor for [[GNOME]] Desktop Environment.
-* [https://github.com/NixOS/nixpkgs/blob/nixos-23.11/pkgs/desktops/plasma-5/default.nix Plasma] is the default [[KDE]] Desktop Environment/Compositor.
+* [https://github.com/NixOS/nixpkgs/blob/nixos-23.11/pkgs/desktops/plasma-5/kwin/default.nix KWin] is the default compositor for [[KDE]] Desktop Environment.
 == Applications ==
-Not all apps support running natively on Wayland. To work around this, XWayland should be enabled. {{Note|Enabling XWayland varies slightly from Compositor to Compositor, and may already be enabled. Consult your Compositor's documentation and/or nix file for how to enable}}
+Not all apps support running natively on Wayland. To work around this, Xwayland should be enabled. {{Note|Enabling XWayland varies slightly from Compositor to Compositor, and may already be enabled. Consult your Compositor's documentation and/or nix file for how to enable}}
+=== Electron and Chromium ===
+Ozone Wayland (which uses Wayland native instead of Xwayland) support in [[Chromium]] and [[Electron]] based applications can be enabled by setting the environment variable "<code>NIXOS_OZONE_WL</code>" with <code>NIXOS_OZONE_WL=1</code> ''(also see [https://github.com/NixOS/nixpkgs/commit/b2eb5f62a7fd94ab58acafec9f64e54f97c508a6 commit])''
+As of NixOS 25.05 ("Warbler"), if <code>XDG_SESSION_TYPE</code> is unset or set to "wayland", [https://issues.chromium.org/issues/40083534#comment599 chromium and electron apps will default to wayland native]. This ignores the <code>DISPLAY</code> environment variable.
-==== Electron and Chromium ====
+==== Declaratively (permanent) ====
-<!-- I kept getting META error when trying {{ic|NIXOS_OZONE_WL=1}}, and replacing the equals with &equals; didn't work either — does anyone know how to markup this correctly? -->
+===== NixOS =====
-As of NixOS 22.05 ("Quokka"), you can enable Ozone Wayland support in [[Chromium]] and [[Electron]] based applications by setting the environment variable <code>NIXOS_OZONE_WL=1</code>. For example, in a {{ic|configuration.nix}}:
+{{File|3=environment.sessionVariables.NIXOS_OZONE_WL = "1";|name=/etc/nixos/configuration.nix|lang=nix}}
-<syntaxhighlight lang="nix">
+==== Imperatively (each time an application is launched) ====
-environment.sessionVariables.NIXOS_OZONE_WL = "1";
+Example: to launch <code>code</code> ''({{Nixpkg|pkgs/applications/editors/vscode/vscode.nix|vscode}})''
+<syntaxhighlight lang="console">
+$ NIXOS_OZONE_WL=1 code
 </syntaxhighlight>
-This allows these applications to run without Xwayland.
+== Virtualization ==
+To have wayland work inside of [[QEMU]], you may need to pass <code>-vga qxl</code>.
+== See also ==
+* [[Xorg]]
+[[Category:Desktop]]