dwl-patches overhaul

Eliminated wiki. Individual patches have a README.md explanation in their own subdirectory. Simplified submission of new patches and maintenance of existing patches. Instructions page (README.md autodisplayed) is now at https://codeberg.org/dwl/dwl-patches/
2026-06-22 07:52:43 +00:00 · 2024-04-24 20:20:07 -05:00
parent d6b051f5b8
commit 9c5d5d85f3
183 changed files with 1434 additions and 4 deletions
@@ -0,0 +1,80 @@
+### Description
+Implement https://github.com/wlrfx/scenefx (commit de4ec10e1ff9347b5833f00f8615d760d9378c99) in DWL.
+
+```c
+/* available options */
+
+static const int opacity = 0; /* flag to enable opacity */
+static const float opacity_inactive = 0.5;
+static const float opacity_active = 1.0;
+
+static const int shadow = 1; /* flag to enable shadow */
+static const int shadow_only_floating = 0; /* only apply shadow to floating windows */
+static const struct wlr_render_color shadow_color = COLOR(0x0000FFff);
+static const struct wlr_render_color shadow_color_focus = COLOR(0xFF0000ff);
+static const int shadow_blur_sigma = 20;
+static const int shadow_blur_sigma_focus = 40;
+static const char *const shadow_ignore_list[] = { "xdg-desktop-portal-gtk", NULL }; /* list of app-id to ignore */
+
+static const int corner_radius = 0; /* 0 disables corner_radius */
+
+static const int blur = 1; /* flag to enable blur */
+static const int blur_optimized = 1;
+static const int blur_ignore_transparent = 1;
+static const struct blur_data blur_data = {
+	.radius = 5,
+	.num_passes = 3,
+	.noise = 0.02,
+	.brightness = 0.9,
+	.contrast = 0.9,
+	.saturation = 1.1,
+};
+```
+
+> **NOTE:** If you are using nix, I have packaged scenefx https://github.com/wochap/nix-config/blob/main/packages/scenefx/default.nix
+
+> **NOTE:** Some GTK apps are being cut off when they have shadows enabled. You can use the `shadow_ignore_list` option to prevent shadows from being rendered on those apps
+
+> **NOTE:** Blur doesn't work on windows with opacity set (opacity_active, opacity_inactive)
+
+> **NOTE:** In DWL's Makefile `scenefx` must be placed before wlroots, e.g. `PKGS = scenefx wlroots wayland-server ...`
+
+**IMPORTANT:** This patch requires you to build DWL with the dependencies of WLROOTS:
+* **scenefx**
+* libGL
+* libcap
+* libinput
+* libpng
+* libxkbcommon
+* mesa
+* pixman
+* seatd
+* vulkan-loader
+* wayland
+* wayland-protocols
+* xorg.libX11
+* xorg.xcbutilerrors
+* xorg.xcbutilimage
+* xorg.xcbutilrenderutil
+* xorg.xcbutilwm
+* xwayland (optional)
+* ffmpeg
+* hwdata
+* libliftoff
+* libdisplay-info
+
+<details>
+<summary>Preview</summary>
+<pre>
+<img src="https://i.imgur.com/4kFhSaS.png"/>
+<img src="https://i.imgur.com/9ZQAUXx.png"/>
+</pre>
+</details>
+
+### Download
+- [git branch](https://codeberg.org/wochap/dwl/src/branch/v0.5/scenefx)
+- [2024-04-11](https://codeberg.org/dwl/dwl-patches/raw/commit/6e3a57ffd16dafa31900b7e89e51672bd7bcc1e8/scenefx/scenefx.patch)
+- [v0.5](https://codeberg.org/dwl/dwl-patches/raw/commit/7a5c3420822074c544fa102e030b7c30aa6b6be8/scenefx/scenefx.patch)
+
+### Authors
+- [wochap](https://codeberg.org/wochap)
@@ -0,0 +1,390 @@
+From 781efcce5f0bc28c2cad7bc3214b927ba87594ae Mon Sep 17 00:00:00 2001
+From: wochap <gean.marroquin@gmail.com>
+Date: Thu, 11 Apr 2024 15:04:01 -0500
+Subject: [PATCH] implement wlrfx/scenefx
+
+add options for blur, shadows, opacity and corner radius
+---
+ Makefile     |   2 +-
+ client.h     |  11 +++-
+ config.def.h |  28 ++++++++-
+ dwl.c        | 167 +++++++++++++++++++++++++++++++++++++++++++++++++--
+ 4 files changed, 198 insertions(+), 10 deletions(-)
+
+diff --git a/Makefile b/Makefile
+index a67fdd3..bc8e9a1 100644
+--- a/Makefile
+++ b/Makefile
+@@ -9,7 +9,7 @@ DWLDEVCFLAGS = -g -pedantic -Wall -Wextra -Wdeclaration-after-statement -Wno-unu
+ 	-Werror=strict-prototypes -Werror=implicit -Werror=return-type -Werror=incompatible-pointer-types -Wfloat-conversion
+ 
+ # CFLAGS / LDFLAGS
+-PKGS      = wlroots wayland-server xkbcommon libinput $(XLIBS)
+PKGS      = scenefx wlroots wayland-server xkbcommon libinput $(XLIBS)
+ DWLCFLAGS = `$(PKG_CONFIG) --cflags $(PKGS)` $(DWLCPPFLAGS) $(DWLDEVCFLAGS) $(CFLAGS)
+ LDLIBS    = `$(PKG_CONFIG) --libs $(PKGS)` $(LIBS)
+ 
+diff --git a/client.h b/client.h
+index 800b867..fd7c4c9 100644
+--- a/client.h
+++ b/client.h
+@@ -131,7 +131,7 @@ client_get_appid(Client *c)
+ 	return c->surface.xdg->toplevel->app_id;
+ }
+ 
+-static inline void
+static inline int
+ client_get_clip(Client *c, struct wlr_box *clip)
+ {
+ 	struct wlr_box xdg_geom = {0};
+@@ -144,12 +144,19 @@ client_get_clip(Client *c, struct wlr_box *clip)
+ 
+ #ifdef XWAYLAND
+ 	if (client_is_x11(c))
+-		return;
+		return 1;
+ #endif
+ 
+ 	wlr_xdg_surface_get_geometry(c->surface.xdg, &xdg_geom);
+ 	clip->x = xdg_geom.x;
+ 	clip->y = xdg_geom.y;
+
+	if (xdg_geom.width <= c->geom.width - (int)c->bw
+			&& xdg_geom.height <= c->geom.height - (int)c->bw) {
+		return 0;
+	}
+
+	return 1;
+ }
+ 
+ static inline void
+diff --git a/config.def.h b/config.def.h
+index 8847e58..4ff6bf0 100644
+--- a/config.def.h
+++ b/config.def.h
+@@ -12,7 +12,33 @@ static const float bordercolor[]           = COLOR(0x444444ff);
+ static const float focuscolor[]            = COLOR(0x005577ff);
+ static const float urgentcolor[]           = COLOR(0xff0000ff);
+ /* This conforms to the xdg-protocol. Set the alpha to zero to restore the old behavior */
+-static const float fullscreen_bg[]         = {0.1f, 0.1f, 0.1f, 1.0f}; /* You can also use glsl colors */
+static const float fullscreen_bg[]         = {0.1f, 0.1f, 0.1f, 0.0f}; /* You can also use glsl colors */
+
+static const int opacity = 0; /* flag to enable opacity */
+static const float opacity_inactive = 0.5;
+static const float opacity_active = 1.0;
+
+static const int shadow = 1; /* flag to enable shadow */
+static const int shadow_only_floating = 0; /* only apply shadow to floating windows */
+static const struct wlr_render_color shadow_color = COLOR(0x0000FFff);
+static const struct wlr_render_color shadow_color_focus = COLOR(0xFF0000ff);
+static const int shadow_blur_sigma = 20;
+static const int shadow_blur_sigma_focus = 40;
+static const char *const shadow_ignore_list[] = { "xdg-desktop-portal-gtk", NULL }; /* list of app-id to ignore */
+
+static const int corner_radius = 0; /* 0 disables corner_radius */
+
+static const int blur = 1; /* flag to enable blur */
+static const int blur_optimized = 1;
+static const int blur_ignore_transparent = 1;
+static const struct blur_data blur_data = {
+	.radius = 5,
+	.num_passes = 3,
+	.noise = (float)0.02,
+	.brightness = (float)0.9,
+	.contrast = (float)0.9,
+	.saturation = (float)1.1,
+};
+ 
+ /* tagging - TAGCOUNT must be no greater than 31 */
+ #define TAGCOUNT (9)
+diff --git a/dwl.c b/dwl.c
+index bf763df..d038a5b 100644
+--- a/dwl.c
+++ b/dwl.c
+@@ -9,6 +9,10 @@
+ #include <stdlib.h>
+ #include <sys/wait.h>
+ #include <time.h>
+#include <scenefx/fx_renderer/fx_renderer.h>
+#include <scenefx/types/fx/blur_data.h>
+#include <scenefx/types/fx/shadow_data.h>
+#include <scenefx/types/wlr_scene.h>
+ #include <unistd.h>
+ #include <wayland-server-core.h>
+ #include <wlr/backend.h>
+@@ -40,7 +44,6 @@
+ #include <wlr/types/wlr_primary_selection.h>
+ #include <wlr/types/wlr_primary_selection_v1.h>
+ #include <wlr/types/wlr_relative_pointer_v1.h>
+-#include <wlr/types/wlr_scene.h>
+ #include <wlr/types/wlr_screencopy_v1.h>
+ #include <wlr/types/wlr_seat.h>
+ #include <wlr/types/wlr_server_decoration.h>
+@@ -139,6 +142,10 @@ typedef struct {
+ 	uint32_t tags;
+ 	int isfloating, isurgent, isfullscreen;
+ 	uint32_t resize; /* configure serial of a pending resize */
+
+	float opacity;
+	int corner_radius;
+	struct shadow_data shadow_data;
+ } Client;
+ 
+ typedef struct {
+@@ -347,6 +354,9 @@ static Monitor *xytomon(double x, double y);
+ static void xytonode(double x, double y, struct wlr_surface **psurface,
+ 		Client **pc, LayerSurface **pl, double *nx, double *ny);
+ static void zoom(const Arg *arg);
+static int in_shadow_ignore_list(const char *str);
+static void iter_xdg_scene_buffers(struct wlr_scene_buffer *buffer, int sx, int sy, void *user_data);
+static void iter_xdg_scene_buffers_shadow(struct wlr_scene_buffer *buffer, int sx, int sy, void *user_data);
+ 
+ /* variables */
+ static const char broken[] = "broken";
+@@ -469,6 +479,14 @@ applyrules(Client *c)
+ 					mon = m;
+ 			}
+ 		}
+		if (shadow && shadow_only_floating) {
+			if (c->isfloating && !in_shadow_ignore_list(appid)) {
+				c->shadow_data.enabled = 1;
+			} else {
+				c->shadow_data.enabled = 0;
+			}
+			wlr_scene_node_for_each_buffer(&c->scene_surface->node, iter_xdg_scene_buffers_shadow, c);
+		}
+ 	}
+ 	setmon(c, mon, newtags);
+ }
+@@ -977,6 +995,13 @@ createnotify(struct wl_listener *listener, void *data)
+ 	wlr_xdg_toplevel_set_wm_capabilities(xdg_surface->toplevel,
+ 			WLR_XDG_TOPLEVEL_WM_CAPABILITIES_FULLSCREEN);
+ 
+	c->opacity = opacity;
+	c->corner_radius = corner_radius;
+	c->shadow_data = shadow_data_get_default();
+	c->shadow_data.enabled = shadow_only_floating != 1 && !in_shadow_ignore_list(client_get_appid(c));
+	c->shadow_data.blur_sigma = shadow_blur_sigma;
+	c->shadow_data.color = shadow_color;
+
+ 	LISTEN(&xdg_surface->events.destroy, &c->destroy, destroynotify);
+ 	LISTEN(&xdg_surface->surface->events.commit, &c->commit, commitnotify);
+ 	LISTEN(&xdg_surface->surface->events.map, &c->map, mapnotify);
+@@ -1267,8 +1292,21 @@ focusclient(Client *c, int lift)
+ 
+ 		/* Don't change border color if there is an exclusive focus or we are
+ 		 * handling a drag operation */
+-		if (!exclusive_focus && !seat->drag)
+		if (!exclusive_focus && !seat->drag) {
+ 			client_set_border_color(c, focuscolor);
+			if (shadow) {
+				c->shadow_data.blur_sigma = shadow_blur_sigma_focus;
+				c->shadow_data.color = shadow_color_focus;
+			}
+			if (opacity) {
+				c->opacity = opacity_active;
+			}
+			if (opacity) {
+				wlr_scene_node_for_each_buffer(&c->scene_surface->node, iter_xdg_scene_buffers, c);
+			} else if (shadow) {
+				wlr_scene_node_for_each_buffer(&c->scene_surface->node, iter_xdg_scene_buffers_shadow, c);
+			}
+		}
+ 	}
+ 
+ 	/* Deactivate old client if focus is changing */
+@@ -1286,6 +1324,18 @@ focusclient(Client *c, int lift)
+ 		 * and probably other clients */
+ 		} else if (old_c && !client_is_unmanaged(old_c) && (!c || !client_wants_focus(c))) {
+ 			client_set_border_color(old_c, bordercolor);
+			if (shadow) {
+				old_c->shadow_data.blur_sigma = shadow_blur_sigma;
+				old_c->shadow_data.color = shadow_color;
+			}
+			if (opacity) {
+				old_c->opacity = opacity_inactive;
+			}
+			if (opacity) {
+				wlr_scene_node_for_each_buffer(&old_c->scene_surface->node, iter_xdg_scene_buffers, old_c);
+			} else if (shadow) {
+				wlr_scene_node_for_each_buffer(&old_c->scene_surface->node, iter_xdg_scene_buffers_shadow, old_c);
+			}
+ 
+ 			client_activate_surface(old, 0);
+ 		}
+@@ -1580,6 +1630,8 @@ mapnotify(struct wl_listener *listener, void *data)
+ 
+ 	client_get_geometry(c, &c->geom);
+ 
+	wlr_scene_node_for_each_buffer(&c->scene_surface->node, iter_xdg_scene_buffers, c);
+
+ 	/* Handle unmanaged clients first so we can return prior create borders */
+ 	if (client_is_unmanaged(c)) {
+ 		/* Unmanaged clients always are floating */
+@@ -1614,6 +1666,14 @@ mapnotify(struct wl_listener *listener, void *data)
+ 	 * try to apply rules for them */
+ 	if ((p = client_get_parent(c))) {
+ 		c->isfloating = 1;
+		if (shadow && shadow_only_floating) {
+			if (!in_shadow_ignore_list(client_get_appid(c))) {
+				c->shadow_data.enabled = 1;
+			} else {
+				c->shadow_data.enabled = 0;
+			}
+			wlr_scene_node_for_each_buffer(&c->scene_surface->node, iter_xdg_scene_buffers_shadow, c);
+		}
+ 		setmon(c, p->mon, p->tags);
+ 	} else {
+ 		applyrules(c);
+@@ -2036,6 +2096,7 @@ resize(Client *c, struct wlr_box geo, int interact)
+ {
+ 	struct wlr_box *bbox = interact ? &sgeom : &c->mon->w;
+ 	struct wlr_box clip;
+	int should_clip;
+ 	client_set_bounds(c, geo.width, geo.height);
+ 	c->geom = geo;
+ 	applybounds(c, bbox);
+@@ -2054,8 +2115,12 @@ resize(Client *c, struct wlr_box geo, int interact)
+ 	/* this is a no-op if size hasn't changed */
+ 	c->resize = client_set_size(c, c->geom.width - 2 * c->bw,
+ 			c->geom.height - 2 * c->bw);
+-	client_get_clip(c, &clip);
+-	wlr_scene_subsurface_tree_set_clip(&c->scene_surface->node, &clip);
+	should_clip = client_get_clip(c, &clip);
+	if (should_clip) {
+		wlr_scene_subsurface_tree_set_clip(&c->scene_surface->node, &clip);
+	} else {
+		wlr_scene_subsurface_tree_set_clip(&c->scene_surface->node, NULL);
+	}
+ }
+ 
+ void
+@@ -2149,6 +2214,14 @@ setfloating(Client *c, int floating)
+ {
+ 	Client *p = client_get_parent(c);
+ 	c->isfloating = floating;
+	if (shadow && shadow_only_floating) {
+		if (c->isfloating && !in_shadow_ignore_list(client_get_appid(c))) {
+			c->shadow_data.enabled = 1;
+		} else {
+			c->shadow_data.enabled = 0;
+		}
+		wlr_scene_node_for_each_buffer(&c->scene_surface->node, iter_xdg_scene_buffers_shadow, c);
+	}
+ 	if (!c->mon)
+ 		return;
+ 	wlr_scene_node_reparent(&c->scene->node, layers[c->isfullscreen ||
+@@ -2300,11 +2373,15 @@ setup(void)
+ 	drag_icon = wlr_scene_tree_create(&scene->tree);
+ 	wlr_scene_node_place_below(&drag_icon->node, &layers[LyrBlock]->node);
+ 
+	if (blur) {
+		wlr_scene_set_blur_data(scene, blur_data);
+	}
+
+ 	/* Autocreates a renderer, either Pixman, GLES2 or Vulkan for us. The user
+ 	 * can also specify a renderer using the WLR_RENDERER env var.
+ 	 * The renderer is responsible for defining the various pixel formats it
+ 	 * supports for shared memory, this configures that for clients. */
+-	if (!(drw = wlr_renderer_autocreate(backend)))
+	if (!(drw = fx_renderer_create(backend)))
+ 		die("couldn't create renderer");
+ 
+ 	/* Create shm, drm and linux_dmabuf interfaces by ourselves.
+@@ -2818,8 +2895,14 @@ urgent(struct wl_listener *listener, void *data)
+ 	c->isurgent = 1;
+ 	printstatus();
+ 
+-	if (client_surface(c)->mapped)
+	if (client_surface(c)->mapped) {
+ 		client_set_border_color(c, urgentcolor);
+		if (shadow) {
+			c->shadow_data.blur_sigma = shadow_blur_sigma_focus;
+			c->shadow_data.color = shadow_color_focus;
+			wlr_scene_node_for_each_buffer(&c->scene_surface->node, iter_xdg_scene_buffers_shadow, c);
+		}
+	}
+ }
+ 
+ void
+@@ -2929,6 +3012,78 @@ zoom(const Arg *arg)
+ 	arrange(selmon);
+ }
+ 
+int
+in_shadow_ignore_list(const char *str) {
+	for (int i = 0; shadow_ignore_list[i] != NULL; i++) {
+		if (strcmp(shadow_ignore_list[i], str) == 0) {
+			return 1;
+		}
+	}
+	return 0;
+}
+
+void 
+iter_xdg_scene_buffers(struct wlr_scene_buffer *buffer, int sx, int sy, void *user_data) 
+{
+	Client *c = user_data;
+	struct wlr_scene_surface * scene_surface = wlr_scene_surface_try_from_buffer(buffer);
+	struct wlr_xdg_surface *xdg_surface;
+
+	if (!scene_surface) {
+		return;
+	}
+
+	xdg_surface = wlr_xdg_surface_try_from_wlr_surface(scene_surface->surface);
+
+	if (c &&
+			xdg_surface &&
+			xdg_surface->role == WLR_XDG_SURFACE_ROLE_TOPLEVEL) {
+		// TODO: Be able to set whole decoration_data instead of calling
+		// each individually?
+		if (opacity) {
+			wlr_scene_buffer_set_opacity(buffer, c->opacity);
+		}
+
+		if (!wlr_subsurface_try_from_wlr_surface(xdg_surface->surface)) {
+			if (corner_radius > 0) {
+				wlr_scene_buffer_set_corner_radius(buffer, c->corner_radius);
+			}
+
+			if (shadow) {
+				wlr_scene_buffer_set_shadow_data(buffer, c->shadow_data);
+			}
+
+			if (blur) {
+				wlr_scene_buffer_set_backdrop_blur(buffer, 1);
+				wlr_scene_buffer_set_backdrop_blur_optimized(buffer, blur_optimized);
+				wlr_scene_buffer_set_backdrop_blur_ignore_transparent(buffer, blur_ignore_transparent);
+			}
+		}
+	}
+}
+
+void 
+iter_xdg_scene_buffers_shadow(struct wlr_scene_buffer *buffer, int sx, int sy, void *user_data) 
+{
+	Client *c = user_data;
+	struct wlr_scene_surface * scene_surface = wlr_scene_surface_try_from_buffer(buffer);
+	struct wlr_xdg_surface *xdg_surface;
+
+	if (!scene_surface) {
+		return;
+	}
+
+	xdg_surface = wlr_xdg_surface_try_from_wlr_surface(scene_surface->surface);
+
+	if (c &&
+			xdg_surface &&
+			xdg_surface->role == WLR_XDG_SURFACE_ROLE_TOPLEVEL) {
+		if (!wlr_subsurface_try_from_wlr_surface(xdg_surface->surface)) {
+			wlr_scene_buffer_set_shadow_data(buffer, c->shadow_data);
+		}
+	}
+}
+
+ #ifdef XWAYLAND
+ void
+ activatex11(struct wl_listener *listener, void *data)
+-- 
+2.43.2