GTK4 Layer Shell

GTK4 Layer Shell — A library to use the Layer Shell Wayland protocol with GTK4

Functions

Types and Values

Description

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.

Functions

gtk_layer_get_major_version ()

guint
gtk_layer_get_major_version ();

Returns

the major version number of the GTK Layer Shell library


gtk_layer_get_minor_version ()

guint
gtk_layer_get_minor_version ();

Returns

the minor version number of the GTK Layer Shell library


gtk_layer_get_micro_version ()

guint
gtk_layer_get_micro_version ();

Returns

the micro/patch version number of the GTK Layer Shell library


gtk_layer_is_supported ()

gboolean
gtk_layer_is_supported ();

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

Returns

TRUE if the platform is Wayland and Wayland compositor supports the zwlr_layer_shell_v1 protocol.


gtk_layer_get_protocol_version ()

guint
gtk_layer_get_protocol_version ();

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

Returns

version of the zwlr_layer_shell_v1 protocol supported by the compositor or 0 if the protocol is not supported.


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.

Parameters

window

A GtkWindow to be turned into a layer surface.

 

gtk_layer_is_layer_window ()

gboolean
gtk_layer_is_layer_window (GtkWindow *window);

Parameters

window

A GtkWindow that may or may not have a layer surface.

 

Returns

if window has been initialized as a layer surface.


gtk_layer_get_zwlr_layer_surface_v1 ()

struct zwlr_layer_surface_v1 *
gtk_layer_get_zwlr_layer_surface_v1 (GtkWindow *window);

Parameters

window

A layer surface.

 

Returns

The underlying layer surface Wayland object


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)

Parameters

window

A layer surface.

 

name_space

The namespace of this layer surface.

 

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.

Parameters

window

A layer surface.

 

Returns

a reference to the namespace property. If namespace is unset, returns the default namespace ("gtk4-layer-shell"). Never returns NULL.


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

Parameters

window

A layer surface.

 

layer

The layer on which this surface appears.

 

gtk_layer_get_layer ()

GtkLayerShellLayer
gtk_layer_get_layer (GtkWindow *window);

Parameters

window

A layer surface.

 

Returns

the current layer.


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

Parameters

window

A layer surface.

 

monitor

The output this layer surface will be placed on (NULL to let the compositor decide).

 

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().

Parameters

window

A layer surface.

 

Returns

the monitor this surface will/has requested to be on, can be NULL.

[transfer none]


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 .

  • If two perpendicular edges are anchored, the surface with be anchored to that corner

  • If two opposite edges are anchored, the window will be stretched across the screen in that direction

Default is FALSE for each GtkLayerShellEdge

Parameters

window

A layer surface.

 

edge

A GtkLayerShellEdge this layer surface may be anchored to.

 

anchor_to_edge

Whether or not to anchor this layer surface to edge .

 

gtk_layer_get_anchor ()

gboolean
gtk_layer_get_anchor (GtkWindow *window,
                      GtkLayerShellEdge edge);

Parameters

window

A layer surface.

 

edge

the edge to which the surface may or may not be anchored

 

Returns

if this surface is anchored to the given 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

Parameters

window

A layer surface.

 

edge

The GtkLayerShellEdge for which to set the margin.

 

margin_size

The margin for edge to be set.

 

gtk_layer_get_margin ()

int
gtk_layer_get_margin (GtkWindow *window,
                      GtkLayerShellEdge edge);

Parameters

window

A layer surface.

 

edge

the margin edge to get

 

Returns

the size of the margin for the given 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

Parameters

window

A layer surface.

 

exclusive_zone

The size of the exclusive zone.

 

gtk_layer_get_exclusive_zone ()

int
gtk_layer_get_exclusive_zone (GtkWindow *window);

Parameters

window

A layer surface.

 

Returns

the window's exclusive zone (which may have been set manually or automatically)


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

Parameters

window

A layer surface.

 

gtk_layer_auto_exclusive_zone_is_enabled ()

gboolean
gtk_layer_auto_exclusive_zone_is_enabled
                               (GtkWindow *window);

Parameters

window

A layer surface.

 

Returns

if the surface's exclusive zone is set to change based on the window's size


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

Parameters

window

A layer surface.

 

mode

The type of keyboard interactivity requested.

 

gtk_layer_get_keyboard_mode ()

GtkLayerShellKeyboardMode
gtk_layer_get_keyboard_mode (GtkWindow *window);

Parameters

window

A layer surface.

 

Returns

current keyboard interactivity mode for window .

Types and Values

enum GtkLayerShellLayer

Members

GTK_LAYER_SHELL_LAYER_BACKGROUND

The background layer.

 

GTK_LAYER_SHELL_LAYER_BOTTOM

The bottom layer.

 

GTK_LAYER_SHELL_LAYER_TOP

The top layer.

 

GTK_LAYER_SHELL_LAYER_OVERLAY

The overlay layer.

 

GTK_LAYER_SHELL_LAYER_ENTRY_NUMBER

Should not be used except to get the number of entries. (NOTE: may change in future releases as more entries are added)

 

enum GtkLayerShellEdge

Members

GTK_LAYER_SHELL_EDGE_LEFT

The left edge of the screen.

 

GTK_LAYER_SHELL_EDGE_RIGHT

The right edge of the screen.

 

GTK_LAYER_SHELL_EDGE_TOP

The top edge of the screen.

 

GTK_LAYER_SHELL_EDGE_BOTTOM

The bottom edge of the screen.

 

GTK_LAYER_SHELL_EDGE_ENTRY_NUMBER

Should not be used except to get the number of entries. (NOTE: may change in future releases as more entries are added)

 

enum GtkLayerShellKeyboardMode

Members

GTK_LAYER_SHELL_KEYBOARD_MODE_NONE

This window should not receive keyboard events.

 

GTK_LAYER_SHELL_KEYBOARD_MODE_EXCLUSIVE

This window should have exclusive focus if it is on the top or overlay layer.

 

GTK_LAYER_SHELL_KEYBOARD_MODE_ON_DEMAND

The user should be able to focus and unfocues this window in an implementation defined way. Not supported for protocol version < 4.

 

GTK_LAYER_SHELL_KEYBOARD_MODE_ENTRY_NUMBER

Should not be used except to get the number of entries. (NOTE: may change in future releases as more entries are added)