Merge pull request #107096 from ArchercatNEO/xdg-toplevel-icon

Wayland: Implement the xdg-toplevel-icon-v1 protocol
This commit is contained in:
Thaddeus Crews
2025-09-22 08:50:10 -05:00
7 changed files with 358 additions and 0 deletions

View File

@@ -64,6 +64,9 @@ objects = [
generate_from_xml(
"xdg_system_bell", "#thirdparty/wayland-protocols/staging/xdg-system-bell/xdg-system-bell-v1.xml"
),
generate_from_xml(
"xdg_toplevel_icon", "#thirdparty/wayland-protocols/staging/xdg-toplevel-icon/xdg-toplevel-icon-v1.xml"
),
# Unstable protocols
generate_from_xml(
"idle_inhibit", "#thirdparty/wayland-protocols/unstable/idle-inhibit/idle-inhibit-unstable-v1.xml"

View File

@@ -185,6 +185,7 @@ bool DisplayServerWayland::has_feature(Feature p_feature) const {
case FEATURE_CURSOR_SHAPE:
case FEATURE_CUSTOM_CURSOR_SHAPE:
case FEATURE_WINDOW_TRANSPARENCY:
case FEATURE_ICON:
case FEATURE_HIDPI:
case FEATURE_SWAP_BUFFERS:
case FEATURE_KEEP_SCREEN_ON:
@@ -1831,6 +1832,11 @@ void DisplayServerWayland::swap_buffers() {
#endif
}
void DisplayServerWayland::set_icon(const Ref<Image> &p_icon) {
MutexLock mutex_lock(wayland_thread.mutex);
wayland_thread.set_icon(p_icon);
}
void DisplayServerWayland::set_context(Context p_context) {
MutexLock mutex_lock(wayland_thread.mutex);

View File

@@ -342,6 +342,8 @@ public:
virtual void release_rendering_thread() override;
virtual void swap_buffers() override;
virtual void set_icon(const Ref<Image> &p_icon) override;
virtual void set_context(Context p_context) override;
virtual bool is_window_transparency_available() const override;

View File

@@ -30,6 +30,8 @@
#include "wayland_thread.h"
#include "core/config/engine.h"
#ifdef WAYLAND_ENABLED
#ifdef __FreeBSD__
@@ -574,6 +576,12 @@ void WaylandThread::_wl_registry_on_global(void *data, struct wl_registry *wl_re
return;
}
if (strcmp(interface, xdg_toplevel_icon_manager_v1_interface.name) == 0) {
registry->xdg_toplevel_icon_manager = (struct xdg_toplevel_icon_manager_v1 *)wl_registry_bind(wl_registry, name, &xdg_toplevel_icon_manager_v1_interface, 1);
registry->xdg_toplevel_icon_manager_name = name;
return;
}
if (strcmp(interface, xdg_activation_v1_interface.name) == 0) {
registry->xdg_activation = (struct xdg_activation_v1 *)wl_registry_bind(wl_registry, name, &xdg_activation_v1_interface, 1);
registry->xdg_activation_name = name;
@@ -818,6 +826,25 @@ void WaylandThread::_wl_registry_on_global_remove(void *data, struct wl_registry
return;
}
if (name == registry->xdg_toplevel_icon_manager_name) {
if (registry->xdg_toplevel_icon_manager) {
xdg_toplevel_icon_manager_v1_destroy(registry->xdg_toplevel_icon_manager);
registry->xdg_toplevel_icon_manager = nullptr;
}
if (registry->wayland_thread->xdg_icon) {
xdg_toplevel_icon_v1_destroy(registry->wayland_thread->xdg_icon);
}
if (registry->wayland_thread->icon_buffer) {
wl_buffer_destroy(registry->wayland_thread->icon_buffer);
}
registry->xdg_toplevel_icon_manager_name = 0;
return;
}
if (name == registry->xdg_activation_name) {
if (registry->xdg_activation) {
xdg_activation_v1_destroy(registry->xdg_activation);
@@ -3521,6 +3548,13 @@ void WaylandThread::window_create(DisplayServer::WindowID p_window_id, int p_wid
ws.libdecor_frame = libdecor_decorate(libdecor_context, ws.wl_surface, (struct libdecor_frame_interface *)&libdecor_frame_interface, &ws);
libdecor_frame_map(ws.libdecor_frame);
if (registry.xdg_toplevel_icon_manager) {
xdg_toplevel *toplevel = libdecor_frame_get_xdg_toplevel(ws.libdecor_frame);
if (toplevel != nullptr) {
xdg_toplevel_icon_manager_v1_set_icon(registry.xdg_toplevel_icon_manager, toplevel, xdg_icon);
}
}
decorated = true;
}
#endif
@@ -3541,6 +3575,10 @@ void WaylandThread::window_create(DisplayServer::WindowID p_window_id, int p_wid
decorated = true;
}
if (registry.xdg_toplevel_icon_manager) {
xdg_toplevel_icon_manager_v1_set_icon(registry.xdg_toplevel_icon_manager, ws.xdg_toplevel, xdg_icon);
}
}
ws.frame_callback = wl_surface_frame(ws.wl_surface);
@@ -4093,6 +4131,81 @@ void WaylandThread::window_set_app_id(DisplayServer::WindowID p_window_id, const
}
}
void WaylandThread::set_icon(const Ref<Image> &p_icon) {
ERR_FAIL_COND(p_icon.is_null());
Size2i icon_size = p_icon->get_size();
ERR_FAIL_COND(icon_size.width != icon_size.height);
if (!registry.xdg_toplevel_icon_manager) {
return;
}
if (xdg_icon) {
xdg_toplevel_icon_v1_destroy(xdg_icon);
}
if (icon_buffer) {
wl_buffer_destroy(icon_buffer);
}
// NOTE: The stride is the width of the icon in bytes.
uint32_t icon_stride = icon_size.width * 4;
uint32_t data_size = icon_stride * icon_size.height;
// We need a shared memory object file descriptor in order to create a
// wl_buffer through wl_shm.
int fd = WaylandThread::_allocate_shm_file(data_size);
ERR_FAIL_COND(fd == -1);
uint32_t *buffer_data = (uint32_t *)mmap(nullptr, data_size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
// Create the Wayland buffer.
struct wl_shm_pool *shm_pool = wl_shm_create_pool(registry.wl_shm, fd, data_size);
icon_buffer = wl_shm_pool_create_buffer(shm_pool, 0, icon_size.width, icon_size.height, icon_stride, WL_SHM_FORMAT_ARGB8888);
wl_shm_pool_destroy(shm_pool);
// Fill the cursor buffer with the image data.
for (uint32_t index = 0; index < (uint32_t)(icon_size.width * icon_size.height); index++) {
int row_index = index / icon_size.width;
int column_index = (index % icon_size.width);
buffer_data[index] = p_icon->get_pixel(column_index, row_index).to_argb32();
// Wayland buffers, unless specified, require associated alpha, so we'll just
// associate the alpha in-place.
uint8_t *pixel_data = (uint8_t *)&buffer_data[index];
pixel_data[0] = pixel_data[0] * pixel_data[3] / 255;
pixel_data[1] = pixel_data[1] * pixel_data[3] / 255;
pixel_data[2] = pixel_data[2] * pixel_data[3] / 255;
}
xdg_icon = xdg_toplevel_icon_manager_v1_create_icon(registry.xdg_toplevel_icon_manager);
xdg_toplevel_icon_v1_add_buffer(xdg_icon, icon_buffer, icon_size.width);
if (Engine::get_singleton()->is_editor_hint() || Engine::get_singleton()->is_project_manager_hint()) {
// Setting a name allows the godot icon to be overridden by a system theme.
// We only want the project manager and editor to get themed,
// Games will get icons with the protocol and themed icons with .desktop entries.
// NOTE: should be synced with the icon name in misc/dist/linuxbsd/Godot.desktop
xdg_toplevel_icon_v1_set_name(xdg_icon, "godot");
}
for (KeyValue<DisplayServer::WindowID, WindowState> &pair : windows) {
WindowState &ws = pair.value;
#ifdef LIBDECOR_ENABLED
if (ws.libdecor_frame) {
xdg_toplevel *toplevel = libdecor_frame_get_xdg_toplevel(ws.libdecor_frame);
ERR_FAIL_NULL(toplevel);
xdg_toplevel_icon_manager_v1_set_icon(registry.xdg_toplevel_icon_manager, toplevel, xdg_icon);
}
#endif
if (ws.xdg_toplevel) {
xdg_toplevel_icon_manager_v1_set_icon(registry.xdg_toplevel_icon_manager, ws.xdg_toplevel, xdg_icon);
}
}
}
DisplayServer::WindowMode WaylandThread::window_get_mode(DisplayServer::WindowID p_window_id) const {
ERR_FAIL_COND_V(!windows.has(p_window_id), DisplayServer::WINDOW_MODE_WINDOWED);
const WindowState &ws = windows[p_window_id];
@@ -4345,6 +4458,10 @@ Error WaylandThread::init() {
WARN_PRINT("FIFO protocol not found! Frame pacing will be degraded.");
}
if (!registry.xdg_toplevel_icon_manager_name) {
WARN_PRINT("xdg-toplevel-icon protocol not found! Cannot set window icon.");
}
// Wait for seat capabilities.
wl_display_roundtrip(wl_display);
@@ -5012,6 +5129,18 @@ void WaylandThread::destroy() {
xdg_system_bell_v1_destroy(registry.xdg_system_bell);
}
if (registry.xdg_toplevel_icon_manager) {
xdg_toplevel_icon_manager_v1_destroy(registry.xdg_toplevel_icon_manager);
if (xdg_icon) {
xdg_toplevel_icon_v1_destroy(xdg_icon);
}
if (icon_buffer) {
wl_buffer_destroy(icon_buffer);
}
}
if (registry.xdg_decoration_manager) {
zxdg_decoration_manager_v1_destroy(registry.xdg_decoration_manager);
}

View File

@@ -70,6 +70,7 @@
#include "wayland/protocol/xdg_foreign_v2.gen.h"
#include "wayland/protocol/xdg_shell.gen.h"
#include "wayland/protocol/xdg_system_bell.gen.h"
#include "wayland/protocol/xdg_toplevel_icon.gen.h"
// NOTE: Deprecated.
#include "wayland/protocol/xdg_foreign_v1.gen.h"
@@ -197,6 +198,9 @@ public:
struct xdg_system_bell_v1 *xdg_system_bell = nullptr;
uint32_t xdg_system_bell_name = 0;
struct xdg_toplevel_icon_manager_v1 *xdg_toplevel_icon_manager = nullptr;
uint32_t xdg_toplevel_icon_manager_name = 0;
struct xdg_activation_v1 *xdg_activation = nullptr;
uint32_t xdg_activation_name = 0;
@@ -543,6 +547,9 @@ private:
List<Ref<Message>> messages;
xdg_toplevel_icon_v1 *xdg_icon = nullptr;
wl_buffer *icon_buffer = nullptr;
String cursor_theme_name;
int unscaled_cursor_size = 24;
@@ -1023,6 +1030,8 @@ public:
void beep() const;
void set_icon(const Ref<Image> &p_icon);
void window_create(DisplayServer::WindowID p_window_id, int p_width, int p_height);
void window_create_popup(DisplayServer::WindowID p_window_id, DisplayServer::WindowID p_parent_id, Rect2i p_rect);
void window_destroy(DisplayServer::WindowID p_window_Id);