Linking against this library and libwayland

If you link against libwayland you must link this library before libwayland. See linking.md for details.

Setting Window Size

If you wish to force your layer surface window to be a different size than it is by default:

1

gtk_window_set_default_size (layer_gtk_window, width, height);

If width or height is 0, the default is used for that axis. If the window is anchored to opposite edges of the output (see gtk_layer_set_anchor()), the size requested here is ignored. If you later wish to use the default window size repeat the call with both width and height as 0.

gtk_layer_get_major_version ()

guint
gtk_layer_get_major_version ();

gtk_layer_get_minor_version ()

guint
gtk_layer_get_minor_version ();

gtk_layer_get_micro_version ()

guint
gtk_layer_get_micro_version ();

gtk_layer_is_supported ()

gboolean
gtk_layer_is_supported ();

May block for a Wayland roundtrip the first time it's called.

gtk_layer_get_protocol_version ()

guint
gtk_layer_get_protocol_version ();

May block for a Wayland roundtrip the first time it's called.

gtk_layer_init_for_window ()

void
gtk_layer_init_for_window (GtkWindow *window);

Set the window up to be a layer surface once it is mapped. this must be called before the window is realized.

gtk_layer_is_layer_window ()

gboolean
gtk_layer_is_layer_window (GtkWindow *window);

gtk_layer_get_zwlr_layer_surface_v1 ()

struct zwlr_layer_surface_v1 *
gtk_layer_get_zwlr_layer_surface_v1 (GtkWindow *window);

gtk_layer_set_namespace ()

void
gtk_layer_set_namespace (GtkWindow *window,
                         char const*name_space);

Set the "namespace" of the surface.

No one is quite sure what this is for, but it probably should be something generic ("panel", "osk", etc). The name_space string is copied, and caller maintains ownership of original. If the window is currently mapped, it will get remapped so the change can take effect.

Default is "gtk4-layer-shell" (which will be used if set to NULL)

gtk_layer_get_namespace ()

const char *
gtk_layer_get_namespace (GtkWindow *window);

NOTE: this function does not return ownership of the string. Do not free the returned string. Future calls into the library may invalidate the returned string.

gtk_layer_set_layer ()

void
gtk_layer_set_layer (GtkWindow *window,
                     GtkLayerShellLayer layer);

Set the "layer" on which the surface appears (controls if it is over top of or below other surfaces). The layer may be changed on-the-fly in the current version of the layer shell protocol, but on compositors that only support an older version the window is remapped so the change can take effect.

Default is GTK_LAYER_SHELL_LAYER_TOP

gtk_layer_get_layer ()

GtkLayerShellLayer
gtk_layer_get_layer (GtkWindow *window);

gtk_layer_set_monitor ()

void
gtk_layer_set_monitor (GtkWindow *window,
                       GdkMonitor *monitor);

Set the output for the window to be placed on, or NULL to let the compositor choose. If the window is currently mapped, it will get remapped so the change can take effect.

Default is NULL

gtk_layer_get_monitor ()

GdkMonitor *
gtk_layer_get_monitor (GtkWindow *window);

NOTE: To get which monitor the surface is actually on, use gdk_display_get_monitor_at_window().

gtk_layer_set_anchor ()

void
gtk_layer_set_anchor (GtkWindow *window,
                      GtkLayerShellEdge edge,
                      gboolean anchor_to_edge);

Set whether window should be anchored to edge .

Default is FALSE for each GtkLayerShellEdge

gtk_layer_get_anchor ()

gboolean
gtk_layer_get_anchor (GtkWindow *window,
                      GtkLayerShellEdge edge);

gtk_layer_set_margin ()

void
gtk_layer_set_margin (GtkWindow *window,
                      GtkLayerShellEdge edge,
                      int margin_size);

Set the margin for a specific edge of a window . Effects both surface's distance from the edge and its exclusive zone size (if auto exclusive zone enabled).

Default is 0 for each GtkLayerShellEdge

gtk_layer_get_margin ()

int
gtk_layer_get_margin (GtkWindow *window,
                      GtkLayerShellEdge edge);

gtk_layer_set_exclusive_zone ()

void
gtk_layer_set_exclusive_zone (GtkWindow *window,
                              int exclusive_zone);

Has no effect unless the surface is anchored to an edge. Requests that the compositor does not place other surfaces within the given exclusive zone of the anchored edge. For example, a panel can request to not be covered by maximized windows. See wlr-layer-shell-unstable-v1.xml for details.

Default is 0

gtk_layer_get_exclusive_zone ()

int
gtk_layer_get_exclusive_zone (GtkWindow *window);

gtk_layer_auto_exclusive_zone_enable ()

void
gtk_layer_auto_exclusive_zone_enable (GtkWindow *window);

When auto exclusive zone is enabled, exclusive zone is automatically set to the size of the window + relevant margin. To disable auto exclusive zone, just set the exclusive zone to 0 or any other fixed value.

NOTE: you can control the auto exclusive zone by changing the margin on the non-anchored edge. This behavior is specific to gtk4-layer-shell and not part of the underlying protocol

gtk_layer_auto_exclusive_zone_is_enabled ()

gboolean
gtk_layer_auto_exclusive_zone_is_enabled
                               (GtkWindow *window);

gtk_layer_set_keyboard_mode ()

void
gtk_layer_set_keyboard_mode (GtkWindow *window,
                             GtkLayerShellKeyboardMode mode);

Sets if/when window should receive keyboard events from the compositor, see GtkLayerShellKeyboardMode for details.

Default is GTK_LAYER_SHELL_KEYBOARD_MODE_NONE

gtk_layer_get_keyboard_mode ()

GtkLayerShellKeyboardMode
gtk_layer_get_keyboard_mode (GtkWindow *window);

enum GtkLayerShellLayer

enum GtkLayerShellEdge

enum GtkLayerShellKeyboardMode