incomplete and outdated documentation on GDK wayland
The documentation on wayland-specific gdk functions, such as gdk_wayland_window_set_use_custom_surface
and gdk_wayland_window_get_wl_surface
, is incomplete.
There is no documentation at all on how to use gdk_wayland_window_set_use_custom_surface
at https://developer.gnome.org/gdk3/stable/gdk3-Wayland-Interaction.html. Only the source code gives some information, albeit with an incomplete code snippet:
GdkWindow *window;
struct wl_surface *surface;
struct input_panel_surface *ip_surface;
window = gtk_widget_get_window (widget);
gdk_wayland_window_set_custom_surface (window);
surface = gdk_wayland_window_get_wl_surface (window);
ip_surface = input_panel_get_input_panel_surface (input_panel, surface);
input_panel_surface_set_panel (ip_surface);
Note that gdk_wayland_window_set_custom_surface
is a non-existing function, now named gdk_wayland_window_set_use_custom_surface
. There are other undefined functions and data types (input_panel_
) which are used out of context.
The documentation should be extended with proper API documentation and concrete examples of how these functions are supposed to be used to access and use the underlying Wayland surfaces.