From 8a9e3a84b560bdbae48b5d1e484f65d7a61071c3 Mon Sep 17 00:00:00 2001 From: Dylan Donnell Date: Mon, 6 Apr 2026 22:02:26 +0100 Subject: [PATCH] ext_background_effect_v1: add implementation --- .../wlr/types/wlr_ext_background_effect_v1.h | 50 ++++ protocol/meson.build | 1 + types/meson.build | 1 + types/wlr_ext_background_effect_v1.c | 241 ++++++++++++++++++ 4 files changed, 293 insertions(+) create mode 100644 include/wlr/types/wlr_ext_background_effect_v1.h create mode 100644 types/wlr_ext_background_effect_v1.c diff --git a/include/wlr/types/wlr_ext_background_effect_v1.h b/include/wlr/types/wlr_ext_background_effect_v1.h new file mode 100644 index 000000000..72b0dbc8e --- /dev/null +++ b/include/wlr/types/wlr_ext_background_effect_v1.h @@ -0,0 +1,50 @@ +/* + * This an unstable interface of wlroots. No guarantees are made regarding the + * future consistency of this API. + */ +#ifndef WLR_USE_UNSTABLE +#error "Add -DWLR_USE_UNSTABLE to enable unstable wlroots features" +#endif + +#ifndef WLR_TYPES_WLR_EXT_BACKGROUND_EFFECT_V1_H +#define WLR_TYPES_WLR_EXT_BACKGROUND_EFFECT_V1_H + +#include +#include +#include + +struct wlr_surface; + +struct wlr_ext_background_effect_surface_v1_state { + pixman_region32_t blur_region; +}; + +struct wlr_ext_background_effect_manager_v1 { + struct wl_global *global; + uint32_t capabilities; // bitmask of enum ext_background_effect_manager_v1_capability + + struct { + struct wl_signal destroy; + } events; + + void *data; + + struct { + struct wl_list resources; // wl_resource_get_link() + struct wl_listener display_destroy; + } WLR_PRIVATE; +}; + +struct wlr_ext_background_effect_manager_v1 *wlr_ext_background_effect_manager_v1_create( + struct wl_display *display, uint32_t version, uint32_t capabilities); + +/** + * Get the committed background effect state for a surface. + * + * Returns NULL if the client has not attached a background effect object to + * the surface. + */ +const struct wlr_ext_background_effect_surface_v1_state * +wlr_ext_background_effect_v1_get_surface_state(struct wlr_surface *surface); + +#endif diff --git a/protocol/meson.build b/protocol/meson.build index 30aeb68c6..4d667d94a 100644 --- a/protocol/meson.build +++ b/protocol/meson.build @@ -30,6 +30,7 @@ protocols = { 'content-type-v1': wl_protocol_dir / 'staging/content-type/content-type-v1.xml', 'cursor-shape-v1': wl_protocol_dir / 'staging/cursor-shape/cursor-shape-v1.xml', 'drm-lease-v1': wl_protocol_dir / 'staging/drm-lease/drm-lease-v1.xml', + 'ext-background-effect-v1': wl_protocol_dir / 'staging/ext-background-effect/ext-background-effect-v1.xml', 'ext-foreign-toplevel-list-v1': wl_protocol_dir / 'staging/ext-foreign-toplevel-list/ext-foreign-toplevel-list-v1.xml', 'ext-idle-notify-v1': wl_protocol_dir / 'staging/ext-idle-notify/ext-idle-notify-v1.xml', 'ext-image-capture-source-v1': wl_protocol_dir / 'staging/ext-image-capture-source/ext-image-capture-source-v1.xml', diff --git a/types/meson.build b/types/meson.build index 26958f048..bc3d32cd9 100644 --- a/types/meson.build +++ b/types/meson.build @@ -48,6 +48,7 @@ wlr_files += files( 'wlr_data_control_v1.c', 'wlr_drm.c', 'wlr_export_dmabuf_v1.c', + 'wlr_ext_background_effect_v1.c', 'wlr_ext_data_control_v1.c', 'wlr_ext_foreign_toplevel_list_v1.c', 'wlr_ext_image_copy_capture_v1.c', diff --git a/types/wlr_ext_background_effect_v1.c b/types/wlr_ext_background_effect_v1.c new file mode 100644 index 000000000..3bf214397 --- /dev/null +++ b/types/wlr_ext_background_effect_v1.c @@ -0,0 +1,241 @@ +#include +#include +#include +#include +#include +#include "ext-background-effect-v1-protocol.h" + +#define BACKGROUND_EFFECT_VERSION 1 + +struct wlr_ext_background_effect_surface_v1 { + struct wl_resource *resource; + struct wlr_surface *surface; + struct wlr_addon addon; + struct wlr_surface_synced synced; + struct wlr_ext_background_effect_surface_v1_state pending, current; +}; + +static const struct ext_background_effect_surface_v1_interface surface_impl; +static const struct ext_background_effect_manager_v1_interface manager_impl; + +static struct wlr_ext_background_effect_surface_v1 *surface_from_resource( + struct wl_resource *resource) { + assert(wl_resource_instance_of(resource, + &ext_background_effect_surface_v1_interface, &surface_impl)); + + return wl_resource_get_user_data(resource); +} + +static void surface_destroy(struct wlr_ext_background_effect_surface_v1 *surface) { + if (surface == NULL) { + return; + } + + wlr_surface_synced_finish(&surface->synced); + wlr_addon_finish(&surface->addon); + wl_resource_set_user_data(surface->resource, NULL); + free(surface); +} + +static void surface_handle_resource_destroy(struct wl_resource *resource) { + struct wlr_ext_background_effect_surface_v1 *surface = surface_from_resource(resource); + surface_destroy(surface); +} + +static void surface_handle_destroy(struct wl_client *client, struct wl_resource *resource) { + wl_resource_destroy(resource); +} + +static void surface_handle_set_blur_region(struct wl_client *client, struct wl_resource *resource, + struct wl_resource *region_resource) { + struct wlr_ext_background_effect_surface_v1 *surface = surface_from_resource(resource); + + if (surface == NULL) { + wl_resource_post_error(resource, + EXT_BACKGROUND_EFFECT_SURFACE_V1_ERROR_SURFACE_DESTROYED, + "The wl_surface object has been destroyed"); + return; + } + + if (region_resource != NULL) { + const pixman_region32_t *region = wlr_region_from_resource(region_resource); + pixman_region32_copy(&surface->pending.blur_region, region); + } else { + pixman_region32_clear(&surface->pending.blur_region); + } +} + +static const struct ext_background_effect_surface_v1_interface surface_impl = { + .destroy = surface_handle_destroy, + .set_blur_region = surface_handle_set_blur_region, +}; + +static void surface_synced_init_state(void *_state) { + struct wlr_ext_background_effect_surface_v1_state *state = _state; + pixman_region32_init(&state->blur_region); +} + +static void surface_synced_finish_state(void *_state) { + struct wlr_ext_background_effect_surface_v1_state *state = _state; + pixman_region32_fini(&state->blur_region); +} + +static void surface_synced_move_state(void *_dst, void *_src) { + struct wlr_ext_background_effect_surface_v1_state *dst = _dst; + struct wlr_ext_background_effect_surface_v1_state *src = _src; + + pixman_region32_copy(&dst->blur_region, &src->blur_region); +} + +static const struct wlr_surface_synced_impl surface_synced_impl = { + .state_size = sizeof(struct wlr_ext_background_effect_surface_v1_state), + .init_state = surface_synced_init_state, + .finish_state = surface_synced_finish_state, + .move_state = surface_synced_move_state, +}; + +static void surface_addon_destroy(struct wlr_addon *addon) { + struct wlr_ext_background_effect_surface_v1 *surface = wl_container_of(addon, surface, addon); + + surface_destroy(surface); +} + +static const struct wlr_addon_interface surface_addon_impl = { + .name = "ext_background_effect_surface_v1", + .destroy = surface_addon_destroy, +}; + +static struct wlr_ext_background_effect_surface_v1 *surface_from_wlr_surface( + struct wlr_surface *wlr_surface) { + struct wlr_addon *addon = wlr_addon_find(&wlr_surface->addons, NULL, &surface_addon_impl); + if (addon == NULL) { + return NULL; + } + + struct wlr_ext_background_effect_surface_v1 *surface = + wl_container_of(addon, surface, addon); + + return surface; +} + +static void manager_handle_destroy(struct wl_client *client, struct wl_resource *resource) { + wl_resource_destroy(resource); +} + +static void manager_handle_get_background_effect(struct wl_client *client, + struct wl_resource *manager_resource, uint32_t id, struct wl_resource *surface_resource) { + struct wlr_surface *wlr_surface = wlr_surface_from_resource(surface_resource); + + if (surface_from_wlr_surface(wlr_surface) != NULL) { + wl_resource_post_error(manager_resource, + EXT_BACKGROUND_EFFECT_MANAGER_V1_ERROR_BACKGROUND_EFFECT_EXISTS, + "The wl_surface object already has a ext_background_effect_surface_v1 object"); + return; + } + + struct wlr_ext_background_effect_surface_v1 *surface = calloc(1, sizeof(*surface)); + if (surface == NULL) { + wl_resource_post_no_memory(manager_resource); + return; + } + + if (!wlr_surface_synced_init(&surface->synced, wlr_surface, &surface_synced_impl, + &surface->pending, &surface->current)) { + free(surface); + wl_resource_post_no_memory(manager_resource); + return; + } + + uint32_t version = wl_resource_get_version(manager_resource); + surface->resource = + wl_resource_create(client, &ext_background_effect_surface_v1_interface, version, id); + + if (surface->resource == NULL) { + wlr_surface_synced_finish(&surface->synced); + free(surface); + wl_resource_post_no_memory(manager_resource); + return; + } + + wl_resource_set_implementation(surface->resource, &surface_impl, surface, + surface_handle_resource_destroy); + + surface->surface = wlr_surface; + wlr_addon_init(&surface->addon, &wlr_surface->addons, NULL, &surface_addon_impl); +} + +static const struct ext_background_effect_manager_v1_interface manager_impl = { + .destroy = manager_handle_destroy, + .get_background_effect = manager_handle_get_background_effect, +}; + +static void manager_handle_resource_destroy(struct wl_resource *resource) { + wl_list_remove(wl_resource_get_link(resource)); +} + +static void manager_bind(struct wl_client *wl_client, void *data, uint32_t version, uint32_t id) { + struct wlr_ext_background_effect_manager_v1 *manager = data; + + struct wl_resource *resource = wl_resource_create(wl_client, + &ext_background_effect_manager_v1_interface, version, id); + if (resource == NULL) { + wl_client_post_no_memory(wl_client); + return; + } + wl_resource_set_implementation(resource, &manager_impl, manager, + manager_handle_resource_destroy); + wl_list_insert(&manager->resources, wl_resource_get_link(resource)); + + ext_background_effect_manager_v1_send_capabilities(resource, manager->capabilities); +} + +static void handle_display_destroy(struct wl_listener *listener, void *data) { + struct wlr_ext_background_effect_manager_v1 *manager = + wl_container_of(listener, manager, display_destroy); + + wl_signal_emit_mutable(&manager->events.destroy, NULL); + assert(wl_list_empty(&manager->events.destroy.listener_list)); + + wl_global_destroy(manager->global); + wl_list_remove(&manager->display_destroy.link); + free(manager); +} + +struct wlr_ext_background_effect_manager_v1 *wlr_ext_background_effect_manager_v1_create( + struct wl_display *display, uint32_t version, uint32_t capabilities) { + assert(version <= BACKGROUND_EFFECT_VERSION); + + struct wlr_ext_background_effect_manager_v1 *manager = calloc(1, sizeof(*manager)); + if (manager == NULL) { + return NULL; + } + + manager->global = wl_global_create(display, &ext_background_effect_manager_v1_interface, version, + manager, manager_bind); + if (manager->global == NULL) { + free(manager); + return NULL; + } + + manager->capabilities = capabilities; + + wl_signal_init(&manager->events.destroy); + wl_list_init(&manager->resources); + + manager->display_destroy.notify = handle_display_destroy; + wl_display_add_destroy_listener(display, &manager->display_destroy); + + return manager; +} + +const struct wlr_ext_background_effect_surface_v1_state * +wlr_ext_background_effect_v1_get_surface_state(struct wlr_surface *wlr_surface) { + struct wlr_ext_background_effect_surface_v1 *surface = + surface_from_wlr_surface(wlr_surface); + + if (surface == NULL) { + return NULL; + } + + return &surface->current; +}