Gtk4 Layer Shell

https://wmww.github.io/gtk4-layer-shell/
Admin
Gtk4 Layer Shell is a library that allows GTK4 applications to use Wayland protocol extensions,...
Tokens:13,816
Snippets:161
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get Layer Surface Monitor

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the monitor that the layer surface has requested to be placed on. Note: To get the actual monitor the surface is on, use gdk_display_get_monitor_at_surface(). Returns NULL if not set.

```c
GdkMonitor *
gtk_layer_get_monitor (_GtkWindow *window_);
```

--------------------------------

### get_xdg_surface_server_from_xdg_surface

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Function to get the xdg surface server from xdg surface.

```APIDOC
## get_xdg_surface_server_from_xdg_surface function

### Description
Function to get the xdg surface server from xdg surface.

### Module
xdg-surface-server
```

--------------------------------

### Lock the Screen

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Session-Lock.html

Attempts to acquire a lock on the screen. This should be called before assigning windows to monitors. The ::failed or ::locked signals will be emitted based on the outcome. Returns false on immediate failure, true if lock acquisition was successfully started.

```c
gboolean
gtk_session_lock_instance_lock (_GtkSessionLockInstance *self_);
```

--------------------------------

### gtk_layer_get_monitor

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the monitor that a layer surface has requested to be placed on. Note that to get the actual monitor the surface is on, `gdk_display_get_monitor_at_surface()` should be used.

```APIDOC
## gtk_layer_get_monitor

### Description
Retrieves the monitor that a layer surface has requested to be placed on. Note that to get the actual monitor the surface is on, `gdk_display_get_monitor_at_surface()` should be used.

### Parameters
#### Path Parameters
- **window** (_GtkWindow *) - A layer surface.

#### Returns
- **GdkMonitor *** - The monitor this surface will/has requested to be on. [transfer none][nullable]
```

--------------------------------

### Get Respect Close Behavior Status

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Checks if the behavior to forward the compositor's 'closed' event to GTK is currently enabled.

```c
gboolean
gtk_layer_get_respect_close (_GtkWindow *window_);
```

--------------------------------

### Get Layer Shell Protocol Version

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the version of the zwlr_layer_shell_v1 protocol supported by the compositor. Returns 0 if the protocol is not supported. This may block for a Wayland roundtrip on the first call.

```c
guint
gtk_layer_get_protocol_version ();
```

--------------------------------

### get_layer_shell_global_from_display

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Function to get the layer shell global from display.

```APIDOC
## get_layer_shell_global_from_display function

### Description
Function to get the layer shell global from display.

### Module
registry
```

--------------------------------

### Get Layer Shell Layer

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the current layer of a layer surface.

```c
GtkLayerShellLayer
gtk_layer_get_layer (_GtkWindow *window_);
```

--------------------------------

### get_session_lock_global_from_display

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Function to get the session lock global from display.

```APIDOC
## get_session_lock_global_from_display function

### Description
Function to get the session lock global from display.

### Module
registry
```

--------------------------------

### Get GTK Layer Shell Micro Version

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

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

```c
guint
gtk_layer_get_micro_version ();
```

--------------------------------

### Get Keyboard Mode for Layer Surface

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the current keyboard interactivity mode set for the layer surface.

```c
GtkLayerShellKeyboardMode
gtk_layer_get_keyboard_mode (_GtkWindow *window_);
```

--------------------------------

### GtkSessionLockInstance::monitor Signal Handler

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Session-Lock.html

This signal is emitted for each monitor when a lock starts and when new monitors are detected. It's typically used to assign a newly created window to a specific monitor using gtk_session_lock_instance_assign_window_to_monitor(). Windows assigned to a monitor are automatically unmapped and dereferenced when their monitor is removed or the screen is unlocked.

```c
void
user_function (GtkSessionLockInstance *self,
               GdkMonitor             *monitor,
               gpointer                user_data)
```

--------------------------------

### Get Layer Surface Margin

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the margin size for a specific edge of the layer surface.

```c
int
gtk_layer_get_margin (_GtkWindow *window_,
                      _GtkLayerShellEdge edge_);
```

--------------------------------

### Get Underlying Layer Surface Object

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the underlying zwlr_layer_surface_v1 Wayland object for a given layer surface window.

```c
struct zwlr_layer_surface_v1 *
gtk_layer_get_zwlr_layer_surface_v1 (_GtkWindow *window_);
```

--------------------------------

### Get GTK Layer Shell Minor Version

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the minor version number of the GTK Layer Shell library.

```c
guint
gtk_layer_get_minor_version ();
```

--------------------------------

### Get Layer Surface Namespace

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the namespace of a layer surface. The returned string should not be freed and may be invalidated by future calls. If the namespace is unset, it returns the default 'gtk4-layer-shell'. Never returns NULL.

```c
const char *
gtk_layer_get_namespace (_GtkWindow *window_);
```

--------------------------------

### Get Layer Surface Anchor

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Checks if the layer surface is currently anchored to a specific edge.

```c
gboolean
gtk_layer_get_anchor (_GtkWindow *window_,
                      _GtkLayerShellEdge edge_);
```

--------------------------------

### Get GTK Layer Shell Major Version

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the major version number of the GTK Layer Shell library.

```c
guint
gtk_layer_get_major_version ();
```

--------------------------------

### Get Exclusive Zone for Layer Surface

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the current exclusive zone setting for a layer surface. This value may be set manually or automatically by the compositor.

```c
int
gtk_layer_get_exclusive_zone (_GtkWindow *window_);
```

--------------------------------

### Get Exclusive Edge Enabled Status

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the status of whether an exclusive zone is enabled for a specified edge of the layer surface. This depends on the surface's anchors.

```c
gboolean
gtk_layer_get_exclusive_edge_enabled (_GtkWindow *window_,
                                      _GtkLayerShellEdge edge_);
```

--------------------------------

### xdg_surface_server_uninit

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Uninitializes an xdg_surface_server instance.

```APIDOC
## xdg_surface_server_uninit

### Description
Uninitializes an xdg_surface_server instance.

### Function Signature
void xdg_surface_server_uninit (struct xdg_surface_server *server);

### Parameters
* **server** (struct xdg_surface_server *) - The xdg_surface_server instance to uninitialize.
```

--------------------------------

### xdg_surface_server_send_configure

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Sends a configure event to the client for an xdg_surface.

```APIDOC
## xdg_surface_server_send_configure

### Description
Sends a configure event to the client for an xdg_surface.

### Function Signature
void xdg_surface_server_send_configure (struct xdg_surface_server *server, struct xdg_surface *xdg_surface, int32_t width, int32_t height);

### Parameters
* **server** (struct xdg_surface_server *) - The xdg_surface_server instance.
* **xdg_surface** (struct xdg_surface *) - The xdg_surface to configure.
* **width** (int32_t) - The new width for the surface.
* **height** (int32_t) - The new height for the surface.
```

--------------------------------

### gtk_layer_init_for_window

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Initializes a GtkWindow to be a layer surface once it is mapped. This must be called before the window is realized.

```APIDOC
## gtk_layer_init_for_window ()

### Description
Sets up a GtkWindow to be a layer surface once it is mapped. This function must be called before the window is realized.

### Parameters
- **window** (_GtkWindow *) - A GtkWindow to be turned into a layer surface.
```

--------------------------------

### Initialize Window for Layer Shell

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Initializes a GtkWindow to be a layer surface once mapped. This must be called before the window is realized.

```c
void
gtk_layer_init_for_window (_GtkWindow *window_);
```

--------------------------------

### Create a New Session Lock Instance

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Session-Lock.html

Allocates and initializes a new GtkSessionLockInstance. Multiple instances can exist, but only one can be locked at a time.

```c
GtkSessionLockInstance *
gtk_session_lock_instance_new ();
```

--------------------------------

### gtk_session_lock_instance_assign_window_to_monitor

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Assigns a window to a specific monitor within the session lock context.

```APIDOC
## gtk_session_lock_instance_assign_window_to_monitor

### Description
Assigns a window to a specific monitor.

### Function Signature
void gtk_session_lock_instance_assign_window_to_monitor (GtkSessionLockInstance *lock, GdkWindow *window, GdkMonitor *monitor);

### Parameters
* **lock** (GtkSessionLockInstance *) - The GtkSessionLockInstance.
* **window** (GdkWindow *) - The GdkWindow to assign.
* **monitor** (GdkMonitor *) - The GdkMonitor to assign the window to.
```

--------------------------------

### Set Default Window Size

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Use this to force a layer surface window to a specific size. If width or height is 0, the default is used. This call is ignored if the window is anchored to opposite edges.

```c
gtk_window_set_default_size(layer_gtk_window, width, height);
```

--------------------------------

### libwayland-shim Functions

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Utility functions for interacting with Wayland through a shim layer, managing client proxies and request hooks.

```APIDOC
## libwayland-shim Functions

### Description
Provides a shim layer for Wayland interactions, including client proxy management and request handling.

### Functions
- `libwayland_shim_clear_client_proxy_data(proxy, data)`
- `libwayland_shim_create_client_proxy(display)`
- `libwayland_shim_get_client_proxy_data(proxy)`
- `libwayland_shim_has_initialized()`
- `libwayland_shim_install_request_hook(display, hook)`
- `libwayland_shim_proxy_get_dispatcher(proxy)`
- `libwayland_shim_proxy_get_display(proxy)`
- `libwayland_shim_proxy_get_implementation(proxy)`
- `libwayland_shim_proxy_get_queue(proxy)`
- `libwayland_shim_proxy_get_user_data(proxy)`
- `libwayland_shim_proxy_invoke_dispatcher(proxy, event)`

### Macros
- `LIBWAYLAND_SHIM_DISPATCH_CLIENT_EVENT`
- `LIBWAYLAND_SHIM_FIRST_ARG`

### Types
- `libwayland_shim_destroy_handler_func_t` (user_function)
- `libwayland_shim_request_handler_func_t` (user_function)
```

--------------------------------

### Set Layer Surface Monitor

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Specifies the output (monitor) for the layer surface. Setting it to NULL allows the compositor to choose the monitor. If the window is mapped, it will be remapped for the change to take effect. Defaults to NULL.

```c
void
gtk_layer_set_monitor (_GtkWindow *window_,
                       _GdkMonitor *monitor_);
```

--------------------------------

### gtk_layer_get_protocol_version

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the version of the zwlr_layer_shell_v1 protocol supported by the compositor.

```APIDOC
## gtk_layer_get_protocol_version ()

### Description
Gets the version of the zwlr_layer_shell_v1 protocol supported by the compositor. This function may block for a Wayland roundtrip the first time it's called.

### Returns
guint - The version of the zwlr_layer_shell_v1 protocol supported by the compositor, or 0 if the protocol is not supported.
```

--------------------------------

### gtk_session_lock_instance_new

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Session-Lock.html

Creates a new instance of GtkSessionLockInstance, which is used to control locking the screen.

```APIDOC
## gtk_session_lock_instance_new ()

### Description
Creates a new session lock instance.

### Returns
A pointer to a new GtkSessionLockInstance.
```

--------------------------------

### gtk_session_lock_instance_assign_window_to_monitor

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Session-Lock.html

Assigns a GTK window to a specific monitor to be displayed as a lock surface. This must be called after `gtk_session_lock_lock()` and before the window is realized.

```APIDOC
## gtk_session_lock_instance_assign_window_to_monitor (_GtkSessionLockInstance *self_, _GtkWindow *window_, _GdkMonitor *monitor_)

### Description
This must be called with a different unrealized window once for each monitor immediately after calling `gtk_session_lock_lock()`. Hiding a window that is active on a monitor or not letting a window be resized by the library is not allowed (may result in a Wayland protocol error). The window will be unmapped and `gtk_window_destroy()` called on it when the current lock ends.

### Parameters
* **self** (_GtkSessionLockInstance *) - The instance to use.
* **window** (_GtkWindow *) - The GTK Window to use as a lock surface.
* **monitor** (_GdkMonitor *) - The monitor to show it on. [not nullable]
```

--------------------------------

### gtk_layer_is_supported

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

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

```APIDOC
## gtk_layer_is_supported ()

### Description
Checks if the platform is Wayland and the Wayland compositor supports the zwlr_layer_shell_v1 protocol. This function may block for a Wayland roundtrip the first time it's called.

### Returns
gboolean - `TRUE` if the platform is Wayland and Wayland compositor supports the zwlr_layer_shell_v1 protocol.
```

--------------------------------

### gtk_layer_set_monitor

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Sets the output monitor for a layer surface. Use `NULL` to let the compositor decide the monitor. If the window is currently mapped, it will be remapped for the change to take effect. The default value is `NULL`.

```APIDOC
## gtk_layer_set_monitor

### Description
Sets the output monitor for a layer surface. Use `NULL` to let the compositor decide the monitor. If the window is currently mapped, it will be remapped for the change to take effect. The default value is `NULL`.

### Parameters
#### Path Parameters
- **window** (_GtkWindow *) - A layer surface.
- **monitor** (_GdkMonitor *) - The output this layer surface will be placed on (`NULL` to let the compositor decide). [nullable]

### Parameters
#### Path Parameters
- **window** (_GtkWindow *) - A layer surface.
- **monitor** (_GdkMonitor *) - The output this layer surface will be placed on (`NULL` to let the compositor decide). [nullable]
```

--------------------------------

### gtk_layer_get_zwlr_layer_surface_v1

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the underlying zwlr_layer_surface_v1 Wayland object for a given layer surface window.

```APIDOC
## gtk_layer_get_zwlr_layer_surface_v1 ()

### Description
Gets the underlying `zwlr_layer_surface_v1` Wayland object for a given layer surface window.

### Parameters
- **window** (_GtkWindow *) - A layer surface.

### Returns
struct zwlr_layer_surface_v1 * - The underlying layer surface Wayland object. [nullable]
```

--------------------------------

### gtk_session_lock_instance_new

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Creates a new GtkSessionLockInstance. This is the primary function to initialize a session lock object.

```APIDOC
## gtk_session_lock_instance_new

### Description
Creates a new GtkSessionLockInstance.

### Function Signature
GtkSessionLockInstance* gtk_session_lock_instance_new (void);

### Returns
A pointer to the newly created GtkSessionLockInstance.
```

--------------------------------

### Set Layer Surface Anchor

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Configures whether the layer surface should be anchored to a specific edge. Anchoring to two perpendicular edges places it in a corner, while anchoring to opposite edges stretches it across the screen. Defaults to FALSE for all edges.

```c
void
gtk_layer_set_anchor (_GtkWindow *window_,
                      _GtkLayerShellEdge edge_,
                      _gboolean anchor_to_edge_);
```

--------------------------------

### Check Layer Shell Support

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Determines if the platform is Wayland and the Wayland compositor supports the zwlr_layer_shell_v1 protocol. This may block for a Wayland roundtrip on the first call.

```c
gboolean
gtk_layer_is_supported ();
```

--------------------------------

### gtk_session_lock_instance_lock

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Session-Lock.html

Locks the screen using the provided session lock instance. This should be called before assigning windows to monitors. It emits the ::failed signal on failure and the ::locked signal on success.

```APIDOC
## gtk_session_lock_instance_lock (_GtkSessionLockInstance *self_)

### Description
Locks the screen. This should be called before assigning any windows to monitors. If this function fails, the ::failed signal is emitted; if it succeeds, the ::locked signal is emitted. The ::failed signal may be emitted before the function returns (e.g., if another GtkSessionLockInstance holds a lock) or later (if another process holds a lock). The only case where neither signal is triggered is if the instance is already locked.

### Parameters
* **self** (_GtkSessionLockInstance *) - The instance to lock.

### Returns
`false` on immediate fail, `true` if lock acquisition was successfully started.
```

--------------------------------

### argument_details

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Struct for argument details in stolen-from-libwayland.

```APIDOC
## argument_details struct

### Description
Struct for argument details.

### Module
stolen-from-libwayland
```

--------------------------------

### gtk_session_lock_is_supported

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Checks if the session lock functionality is supported on the current system.

```APIDOC
## gtk_session_lock_is_supported

### Description
Checks if the session lock functionality is supported.

### Function Signature
bool gtk_session_lock_is_supported (void);

### Returns
`true` if session lock is supported, `false` otherwise.
```

--------------------------------

### gtk_layer_get_monitor

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the monitor of the layer surface.

```APIDOC
## gtk_layer_get_monitor ()

### Description
Gets the monitor of the layer surface.

### Returns
GdkMonitor * - The current monitor.
```

--------------------------------

### gtk_layer_set_monitor

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Sets the monitor for the layer surface.

```APIDOC
## gtk_layer_set_monitor ()

### Description
Sets the monitor for the layer surface.

### Parameters
- **monitor** (GdkMonitor *) - The monitor to set.
```

--------------------------------

### Assign Window to Monitor

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Session-Lock.html

Assigns a GTK window to a specific monitor for the lock screen. This must be called with a different unrealized window for each monitor immediately after calling gtk_session_lock_lock(). The window will be unmapped and destroyed when the lock ends.

```c
void
gtk_session_lock_instance_assign_window_to_monitor
                               (_GtkSessionLockInstance *self_,
                                _GtkWindow *window_,
                                _GdkMonitor *monitor_);
```

--------------------------------

### ext_session_lock_manager_v1

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Struct for the ext_session_lock_manager_v1 interface in registry.

```APIDOC
## ext_session_lock_manager_v1 struct

### Description
Struct for the ext_session_lock_manager_v1 interface.

### Module
registry
```

--------------------------------

### gtk_layer_get_namespace

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the namespace for the layer surface.

```APIDOC
## gtk_layer_get_namespace ()

### Description
Gets the namespace for the layer surface.

### Returns
const char * - The namespace string.
```

--------------------------------

### gtk_layer_set_namespace

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Sets the namespace for the layer surface.

```APIDOC
## gtk_layer_set_namespace ()

### Description
Sets the namespace for the layer surface.

### Parameters
- **namespace** (const char *) - The namespace string.
```

--------------------------------

### gtk_layer_set_keyboard_mode

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Configures how a layer surface should receive keyboard events from the compositor. Refer to GtkLayerShellKeyboardMode for detailed options.

```APIDOC
## gtk_layer_set_keyboard_mode

### Description
Sets if/when _`window`_ should receive keyboard events from the compositor. To control mouse/touch interactivity use input regions.

### Parameters
#### Path Parameters
- **window** (_GtkWindow_) - A layer surface.
- **mode** (_GtkLayerShellKeyboardMode_) - The type of keyboard interactivity requested. Default is `GTK_LAYER_SHELL_KEYBOARD_MODE_NONE`.

### Returns
void
```

--------------------------------

### gtk_layer_auto_exclusive_zone_enable

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Enables automatic exclusive zone management for the layer surface.

```APIDOC
## gtk_layer_auto_exclusive_zone_enable ()

### Description
Enables automatic exclusive zone management for the layer surface.
```

--------------------------------

### zwlr_layer_shell_v1

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Represents the zwlr_layer_shell_v1 interface from the Wayland layer-shell protocol.

```APIDOC
## zwlr_layer_shell_v1

### Description
Interface for the Wayland layer-shell protocol.

### Remarks
This struct is part of the Wayland protocol for layer surfaces, allowing applications to manage surfaces that appear on specific layers (e.g., background, top).

### Related Functions
(No specific functions are listed in the source for direct invocation on this struct, but it's a core Wayland interface.)
```

--------------------------------

### Unlock the Screen

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Session-Lock.html

Unlocks the screen if the current instance holds the lock, emitting the ::unlocked signal. Has no effect if the instance does not hold the lock.

```c
void
gtk_session_lock_instance_unlock (_GtkSessionLockInstance *self_);
```

--------------------------------

### gtk_layer_set_keyboard_mode

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Sets the keyboard mode for the layer surface.

```APIDOC
## gtk_layer_set_keyboard_mode ()

### Description
Sets the keyboard mode for the layer surface.

### Parameters
- **mode** (GtkLayerShellKeyboardMode) - The keyboard mode to set.
```

--------------------------------

### Set Keyboard Mode for Layer Surface

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Configures how and when the layer surface receives keyboard events from the compositor. Mouse and touch interactivity should be managed via input regions.

```c
void
gtk_layer_set_keyboard_mode (_GtkWindow *window_,
                             _GtkLayerShellKeyboardMode mode_);
```

--------------------------------

### Session Lock Failed Signal

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Session-Lock.html

Signal emitted when the screen lock could not be acquired. This is a 'Run First' signal.

```c
void
user_function (GtkSessionLockInstance *self,
               gpointer                user_data)
```

--------------------------------

### GTK4 Layer Shell Functions

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

This section details the functions available in the GTK4 Layer Shell API for managing layer surfaces. These functions allow developers to control various aspects of how a window behaves as a layer surface.

```APIDOC
## GTK4 Layer Shell Functions

### Description
Provides functions to interact with the GTK4 Layer Shell for Wayland.

### Functions
- `gtk_layer_auto_exclusive_zone_enable(window)`
- `gtk_layer_auto_exclusive_zone_is_enabled(window)`
- `gtk_layer_get_anchor(window)`
- `gtk_layer_get_exclusive_edge_enabled(window)`
- `gtk_layer_get_exclusive_zone(window)`
- `gtk_layer_get_keyboard_mode(window)`
- `gtk_layer_get_layer(window)`
- `gtk_layer_get_margin(window)`
- `gtk_layer_get_monitor(window)`
- `gtk_layer_get_namespace(window)`
- `gtk_layer_get_respect_close(window)`
- `gtk_layer_get_zwlr_layer_surface_v1(window)`
- `gtk_layer_init_for_window(window)`
- `gtk_layer_is_layer_window(window)`
- `gtk_layer_is_supported()`
- `gtk_layer_set_anchor(window, anchor_all)`
- `gtk_layer_set_exclusive_edge_enabled(window, enabled)`
- `gtk_layer_set_exclusive_zone(window, zone)`
- `gtk_layer_set_keyboard_mode(window, mode)`
- `gtk_layer_set_layer(window, layer)`
- `gtk_layer_set_margin(window, margin)`
- `gtk_layer_set_monitor(window, monitor)`
- `gtk_layer_set_namespace(window, name_space)`
- `gtk_layer_set_respect_close(window, respect_close)`

### Version Information
- `gtk_layer_get_major_version()`
- `gtk_layer_get_minor_version()`
- `gtk_layer_get_micro_version()`
- `gtk_layer_get_protocol_version()`

### Enums
- `GtkLayerShellEdge`
- `GtkLayerShellKeyboardMode`
- `GtkLayerShellLayer`
```

--------------------------------

### layer-surface Functions

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

This section details the functions available for managing layer surfaces directly, often used in conjunction with Wayland protocols.

```APIDOC
## layer-surface Functions

### Description
Functions for direct manipulation of layer surfaces.

### Functions
- `layer_surface_auto_exclusive_zone_enable(layer_surface)`
- `layer_surface_get_namespace(layer_surface)`
- `layer_surface_install_hook(layer_surface, callback, user_data)`
- `layer_surface_invalidate_preferred_size(layer_surface)`
- `layer_surface_make(display, output)`
- `layer_surface_set_anchor(layer_surface, anchor_all)`
- `layer_surface_set_exclusive_edges(layer_surface, exclusive_edges)`
- `layer_surface_set_exclusive_zone(layer_surface, zone)`
- `layer_surface_set_keyboard_mode(layer_surface, mode)`
- `layer_surface_set_layer(layer_surface, layer)`
- `layer_surface_set_margin(layer_surface, margin)`
- `layer_surface_set_name_space(layer_surface, name_space)`
- `layer_surface_set_output(layer_surface, output)`
- `layer_surface_set_respect_close(layer_surface, respect_close)`
- `layer_surface_uninit(layer_surface)`

### Types
- `layer_surface_hook_callback_t` (user_function)
- `layer_surface_t` (struct)
```

--------------------------------

### gtk_layer_get_layer

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the layer of the layer surface.

```APIDOC
## gtk_layer_get_layer ()

### Description
Gets the layer of the layer surface.

### Returns
GtkLayerShellLayer - The current layer.
```

--------------------------------

### GTK4_SESSION_LOCK_EXPORT

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Macro related to GTK4 Session Lock.

```APIDOC
## GTK4_SESSION_LOCK_EXPORT macro

### Description
Macro related to GTK4 Session Lock.

### Module
GTK4 Session Lock
```

--------------------------------

### gtk_layer_is_layer_window

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Checks if a GtkWindow has been initialized as a layer surface.

```APIDOC
## gtk_layer_is_layer_window ()

### Description
Checks if the provided GtkWindow has been initialized as a layer surface.

### Parameters
- **window** (_GtkWindow *) - A GtkWindow that may or may not have a layer surface.

### Returns
gboolean - `TRUE` if the window has been initialized as a layer surface.
```

--------------------------------

### Set Layer Surface Namespace

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Sets the namespace for a layer surface. The namespace helps identify the purpose of the surface (e.g., 'panel', 'osk'). The string is copied. If the window is mapped, it will be remapped for the change to take effect. Defaults to 'gtk4-layer-shell' if NULL.

```c
void
gtk_layer_set_namespace (_GtkWindow *window_,
                         _char const*name_space_);
```

--------------------------------

### lock-surface Functions

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Functions for managing lock surfaces, used for exclusive screen locking or presentation.

```APIDOC
## lock-surface Functions

### Description
API for managing lock surfaces.

### Functions
- `lock_surface_install_hook(lock_surface, callback, user_data)`
- `lock_surface_make(display)`
- `lock_surface_map(lock_surface)`
- `lock_surface_uninit(lock_surface)`

### Types
- `lock_surface_hook_callback_t` (user_function)
- `lock_surface_t` (struct)
```

--------------------------------

### GtkLayerShellKeyboardMode Enum

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Specifies how a GTK window should handle keyboard input and focus.

```c
enum GtkLayerShellKeyboardMode
{
  GTK_LAYER_SHELL_KEYBOARD_MODE_NONE,
  GTK_LAYER_SHELL_KEYBOARD_MODE_EXCLUSIVE,
  GTK_LAYER_SHELL_KEYBOARD_MODE_ON_DEMAND,
  GTK_LAYER_SHELL_KEYBOARD_MODE_ENTRY_NUMBER
};
```

--------------------------------

### gtk_session_lock_instance_unlock

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Session-Lock.html

Unlocks the screen if it is currently locked by this instance. Otherwise, it has no effect.

```APIDOC
## gtk_session_lock_instance_unlock (_GtkSessionLockInstance *self_)

### Description
If the screen is locked by this instance, it unlocks it and fires the ::unlocked signal. Otherwise, it has no effect.

### Parameters
* **self** (_GtkSessionLockInstance *) - The instance to unlock.
```

--------------------------------

### gtk_layer_set_layer

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Sets the layer for the layer surface.

```APIDOC
## gtk_layer_set_layer ()

### Description
Sets the layer for the layer surface.

### Parameters
- **layer** (GtkLayerShellLayer) - The layer to set.
```

--------------------------------

### GtkLayerShellKeyboardMode Enum

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Determines how a window interacts with keyboard input and focus.

```APIDOC
## enum GtkLayerShellKeyboardMode

### Description
Determines how a window interacts with keyboard input and focus.

### 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)
```

--------------------------------

### gtk_layer_auto_exclusive_zone_enable

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Enables automatic adjustment of the exclusive zone based on the window's size. When enabled, the exclusive zone is automatically set to the size of the window plus any relevant margin.

```APIDOC
## gtk_layer_auto_exclusive_zone_enable

### Description
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.

### Parameters
#### Path Parameters
- **window** (_GtkWindow_) - A layer surface.

### Returns
void
```

--------------------------------

### GtkSessionLockInstance Type Definition

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Session-Lock.html

Defines the GtkSessionLockInstance structure, which is used to control the locking of the screen. Multiple instances can exist, but only one can be locked at a time.

```c
typedef struct _GtkSessionLockInstance GtkSessionLockInstance;
```

--------------------------------

### gtk_layer_get_layer

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the current layer of a layer surface.

```APIDOC
## gtk_layer_get_layer

### Description
Retrieves the current layer of a layer surface.

### Parameters
#### Path Parameters
- **window** (_GtkWindow *) - A layer surface.

#### Returns
- **GtkLayerShellLayer** - The current layer.
```

--------------------------------

### ::monitor signal

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Session-Lock.html

The ::monitor signal is emitted for each monitor present when a lock begins, and whenever a new monitor is detected during the lock. It is typically used to assign a newly created window to a specific monitor using gtk_session_lock_instance_assign_window_to_monitor().

```APIDOC
## ::monitor signal

### Description
The ::monitor signal is fired once for each monitor that exists when a lock is started, and then whenever a new monitor is detected during the lock. You generally want to call `gtk_session_lock_instance_assign_window_to_monitor()` once in the handler for this signal with a newly created window and the given monitor.
This API does not directly tell you when a monitor is removed (GTK APIs can be used for that), however the window you send to `gtk_session_lock_instance_assign_window_to_monitor()` will be automatically unmapped and dereferenced when its monitor is removed or the screen is unlocked.

### Parameters
* **self** (GtkSessionLockInstance) - The GtkSessionLockInstance.
* **monitor** (GdkMonitor) - The GdkMonitor that exists or was added.
* **user_data** (gpointer) - User data set when the signal handler was connected.

### Flags
Run First

### Since
1.2
```

--------------------------------

### gtk_layer_get_keyboard_mode

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the current keyboard interactivity mode for a layer surface.

```APIDOC
## gtk_layer_get_keyboard_mode

### Description
Retrieves the current keyboard interactivity mode for a layer surface.

### Parameters
#### Path Parameters
- **window** (_GtkWindow_) - A layer surface.

### Returns
GtkLayerShellKeyboardMode - The current keyboard interactivity mode for _`window`_.
```

--------------------------------

### gtk_layer_set_anchor

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Sets the anchor for the layer surface.

```APIDOC
## gtk_layer_set_anchor ()

### Description
Sets the anchor for the layer surface.

### Parameters
- **anchor** (GtkLayerShellAnchor) - The anchor to set.
```

--------------------------------

### DEFAULT_RESPECT_CLOSE_REQUEST

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Macro for default respect close request in layer-surface.

```APIDOC
## DEFAULT_RESPECT_CLOSE_REQUEST macro

### Description
Macro for default respect close request.

### Module
layer-surface
```

--------------------------------

### gtk_layer_get_keyboard_mode

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the keyboard mode of the layer surface.

```APIDOC
## gtk_layer_get_keyboard_mode ()

### Description
Gets the keyboard mode of the layer surface.

### Returns
GtkLayerShellKeyboardMode - The current keyboard mode.
```

--------------------------------

### gtk_layer_set_anchor

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Sets whether a window should be anchored to a specific edge. Anchoring two perpendicular edges anchors the surface to a corner, while anchoring two opposite edges stretches the window across the screen in that direction. The default is `FALSE` for each edge.

```APIDOC
## gtk_layer_set_anchor

### Description
Sets whether a window should be anchored to a specific edge. Anchoring two perpendicular edges anchors the surface to a corner, while anchoring two opposite edges stretches the window across the screen in that direction. The default is `FALSE` for each edge.

### Parameters
#### Path Parameters
- **window** (_GtkWindow *) - A layer surface.
- **edge** (_GtkLayerShellEdge) - A GtkLayerShellEdge this layer surface may be anchored to.
- **anchor_to_edge** (_gboolean) - Whether or not to anchor this layer surface to `edge`.

### Parameters
#### Path Parameters
- **window** (_GtkWindow *) - A layer surface.
- **edge** (_GtkLayerShellEdge) - A GtkLayerShellEdge this layer surface may be anchored to.
- **anchor_to_edge** (_gboolean) - Whether or not to anchor this layer surface to `edge`.
```

--------------------------------

### gtk_layer_get_anchor

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the anchor of the layer surface.

```APIDOC
## gtk_layer_get_anchor ()

### Description
Gets the anchor of the layer surface.

### Returns
gboolean - `TRUE` if the anchor is set.
```

--------------------------------

### gtk_session_lock_is_supported

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Session-Lock.html

Checks if the Session Lock Wayland protocol is supported on the current platform. This function may block for a Wayland roundtrip on its first call.

```APIDOC
## gtk_session_lock_is_supported ()

### Description
Checks if the platform is Wayland and the Wayland compositor supports the Session Lock protocol.

### Returns
`TRUE` if the platform is Wayland and Wayland compositor supports the Session Lock protocol.
```

--------------------------------

### Check if Window is Layer Window

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Determines if a GtkWindow has been initialized as a layer surface.

```c
gboolean
gtk_layer_is_layer_window (_GtkWindow *window_);
```

--------------------------------

### gtk_session_lock_instance_lock

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Locks the session using the provided GtkSessionLockInstance. This function is used to initiate the session locking process.

```APIDOC
## gtk_session_lock_instance_lock

### Description
Locks the session using the provided GtkSessionLockInstance.

### Function Signature
void gtk_session_lock_instance_lock (GtkSessionLockInstance *lock);

### Parameters
* **lock** (GtkSessionLockInstance *) - The GtkSessionLockInstance to use for locking the session.
```

--------------------------------

### xdg_surface_server_get_xdg_surface

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Retrieves the xdg_surface associated with a given Wayland object.

```APIDOC
## xdg_surface_server_get_xdg_surface

### Description
Retrieves the xdg_surface associated with a Wayland object.

### Function Signature
struct xdg_surface* xdg_surface_server_get_xdg_surface (struct wl_object *object);

### Parameters
* **object** (struct wl_object *) - The Wayland object.

### Returns
A pointer to the xdg_surface, or NULL if not found.
```

--------------------------------

### gtk_layer_get_micro_version

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

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

```APIDOC
## gtk_layer_get_micro_version ()

### Description
Gets the micro/patch version number of the GTK Layer Shell library.

### Returns
guint - The micro/patch version number.
```

--------------------------------

### gtk_layer_get_namespace

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the namespace of a layer surface. This function returns a reference to the namespace property. If the namespace is not set, it returns the default namespace ('gtk4-layer-shell'). The returned string should not be freed by the caller, as future library calls may invalidate it.

```APIDOC
## gtk_layer_get_namespace

### Description
Retrieves the namespace of a layer surface. This function returns a reference to the namespace property. If the namespace is not set, it returns the default namespace ('gtk4-layer-shell'). The returned string should not be freed by the caller, as future library calls may invalidate it.

### Parameters
#### Path Parameters
- **window** (_GtkWindow *) - A layer surface.

#### Returns
- **const char *** - A reference to the namespace property. If namespace is unset, returns the default namespace("gtk4-layer-shell"). Never returns `NULL`. [transfer none][not nullable]
```

--------------------------------

### gtk_layer_set_margin

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Sets the margin for the layer surface.

```APIDOC
## gtk_layer_set_margin ()

### Description
Sets the margin for the layer surface.

### Parameters
- **margin** (int) - The margin to set.
```

--------------------------------

### gtk_layer_set_respect_close

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Sets whether the layer surface should respect the close request.

```APIDOC
## gtk_layer_set_respect_close ()

### Description
Sets whether the layer surface should respect the close request.

### Parameters
- **respect_close** (gboolean) - `TRUE` to respect close requests, `FALSE` otherwise.
```

--------------------------------

### gtk_layer_get_respect_close

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Checks if the layer surface respects the close request.

```APIDOC
## gtk_layer_get_respect_close ()

### Description
Checks if the layer surface respects the close request.

### Returns
gboolean - `TRUE` if close requests are respected.
```

--------------------------------

### GtkLayerShellLayer Enum

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Defines the different layers a GTK window can occupy. Use these to control stacking order.

```c
enum GtkLayerShellLayer
{
  GTK_LAYER_SHELL_LAYER_BACKGROUND,
  GTK_LAYER_SHELL_LAYER_BOTTOM,
  GTK_LAYER_SHELL_LAYER_TOP,
  GTK_LAYER_SHELL_LAYER_OVERLAY,
  GTK_LAYER_SHELL_LAYER_ENTRY_NUMBER
};
```

--------------------------------

### gtk_layer_set_namespace

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Sets the 'namespace' of a layer surface. This is a string that helps identify the purpose of the surface, like 'panel' or 'osk'. The string is copied, and the caller retains ownership. If the window is mapped, it will be remapped for the change to take effect. The default namespace is 'gtk4-layer-shell'.

```APIDOC
## gtk_layer_set_namespace

### Description
Sets the 'namespace' of a layer surface. This is a string that helps identify the purpose of the surface, like 'panel' or 'osk'. The string is copied, and the caller retains ownership. If the window is mapped, it will be remapped for the change to take effect. The default namespace is 'gtk4-layer-shell'.

### Parameters
#### Path Parameters
- **window** (_GtkWindow *) - A layer surface.
- **name_space** (const char *) - The namespace of this layer surface. [transfer none][nullable]

### Parameters
#### Path Parameters
- **window** (_GtkWindow *) - A layer surface.
- **name_space** (const char *) - The namespace of this layer surface. [transfer none][nullable]
```

--------------------------------

### gtk_layer_get_minor_version

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the minor version number of the GTK Layer Shell library.

```APIDOC
## gtk_layer_get_minor_version ()

### Description
Gets the minor version number of the GTK Layer Shell library.

### Returns
guint - The minor version number.
```

--------------------------------

### gtk_session_lock_instance_is_locked

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Session-Lock.html

Checks if the provided session lock instance currently holds a lock on the screen.

```APIDOC
## gtk_session_lock_instance_is_locked (_GtkSessionLockInstance *self_)

### Description
Returns whether this instance currently holds a lock.

### Parameters
* **self** (_GtkSessionLockInstance *) - The instance.

### Returns
`TRUE` if the instance currently holds a lock, `FALSE` otherwise.
```

--------------------------------

### ::unlocked signal

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Session-Lock.html

The ::unlocked signal is emitted when the session is unlocked. This can occur due to a call to gtk_session_lock_instance_unlock() or by the compositor.

```APIDOC
## ::unlocked signal

### Description
The ::unlocked signal is fired when the session is unlocked, which may have been caused by a call to `gtk_session_lock_instance_unlock()` or by the compositor.

### Parameters
* **self** (GtkSessionLockInstance) - The GtkSessionLockInstance.
* **user_data** (gpointer) - User data set when the signal handler was connected.

### Flags
Run First
```

--------------------------------

### gtk_session_lock_instance_unlock

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Unlocks the session using the provided GtkSessionLockInstance. This function is called when the session should be unlocked.

```APIDOC
## gtk_session_lock_instance_unlock

### Description
Unlocks the session using the provided GtkSessionLockInstance.

### Function Signature
void gtk_session_lock_instance_unlock (GtkSessionLockInstance *lock);

### Parameters
* **lock** (GtkSessionLockInstance *) - The GtkSessionLockInstance to use for unlocking the session.
```

--------------------------------

### GtkLayerShellEdge Enum

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Specifies the edges of the screen for positioning or anchoring layer shell windows.

```APIDOC
## enum GtkLayerShellEdge

### Description
Specifies the edges of the screen for positioning or anchoring layer shell windows.

### 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)
```

--------------------------------

### GtkLayerShellEdge Enum

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Defines the edges of the screen for positioning or anchoring GTK windows.

```c
enum GtkLayerShellEdge
{
  GTK_LAYER_SHELL_EDGE_LEFT,
  GTK_LAYER_SHELL_EDGE_RIGHT,
  GTK_LAYER_SHELL_EDGE_TOP,
  GTK_LAYER_SHELL_EDGE_BOTTOM,
  GTK_LAYER_SHELL_EDGE_ENTRY_NUMBER
};
```

--------------------------------

### gtk_layer_get_margin

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the margin of the layer surface.

```APIDOC
## gtk_layer_get_margin ()

### Description
Gets the margin of the layer surface.

### Returns
int - The current margin.
```

--------------------------------

### GtkLayerShellLayer Enum

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Defines the different layers a window can be placed on in the layer shell. These layers determine the stacking order of windows.

```APIDOC
## enum GtkLayerShellLayer

### Description
Defines the different layers a window can be placed on in the layer shell. These layers determine the stacking order of windows.

### 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)
```

--------------------------------

### Check if Session Lock is Supported

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Session-Lock.html

Determines if the current platform is Wayland and the compositor supports the Session Lock protocol. This function may block for a Wayland roundtrip on its first call.

```c
gboolean
gtk_session_lock_is_supported ();
```

--------------------------------

### gtk_layer_get_margin

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the margin size for a given edge of a layer surface.

```APIDOC
## gtk_layer_get_margin

### Description
Retrieves the margin size for a given edge of a layer surface.

### Parameters
#### Path Parameters
- **window** (_GtkWindow *) - A layer surface.
- **edge** (_GtkLayerShellEdge) - The margin edge to get.

#### Returns
- **int** - The size of the margin for the given edge.
```

--------------------------------

### session_lock_lock

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Initiates a session lock. This is a convenience function that may use a default session lock instance.

```APIDOC
## session_lock_lock

### Description
Locks the session. This is a convenience function.

### Function Signature
void session_lock_lock (void);

### Remarks
This function may internally use a default GtkSessionLockInstance.
```

--------------------------------

### gtk_layer_get_major_version

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Retrieves the major version number of the GTK Layer Shell library.

```APIDOC
## gtk_layer_get_major_version ()

### Description
Gets the major version number of the GTK Layer Shell library.

### Returns
guint - The major version number.
```

--------------------------------

### Set Respect Close Behavior for Layer Surface

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Determines if the compositor's 'closed' event should trigger a GTK 'close-request' signal. Useful for handling window destruction events gracefully.

```c
void
gtk_layer_set_respect_close (_GtkWindow *window_,
                             _gboolean respect_close_);
```

--------------------------------

### Set Layer Shell Layer

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Sets the layer on which the surface appears, controlling its stacking order relative to other surfaces. On older compositors, the window may be remapped for the change to take effect. Defaults to GTK_LAYER_SHELL_LAYER_TOP.

```c
void
gtk_layer_set_layer (_GtkWindow *window_,
                     _GtkLayerShellLayer layer_);
```

--------------------------------

### Enable Auto Exclusive Zone for Layer Surface

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Enables automatic adjustment of the exclusive zone based on the window's size and relevant margins. To disable, set the exclusive zone to 0.

```c
void
gtk_layer_auto_exclusive_zone_enable (_GtkWindow *window_);
```

--------------------------------

### GTK4 Layer Shell Export Macro

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Session-Lock.html

A macro definition used for exporting symbols from the GTK4 Layer Shell library.

```c
#define             GTK4_LAYER_SHELL_EXPORT
```

--------------------------------

### gtk_session_lock_instance_is_locked

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Checks if the session is currently locked using the provided GtkSessionLockInstance.

```APIDOC
## gtk_session_lock_instance_is_locked

### Description
Checks if the session is currently locked.

### Function Signature
bool gtk_session_lock_instance_is_locked (GtkSessionLockInstance *lock);

### Parameters
* **lock** (GtkSessionLockInstance *) - The GtkSessionLockInstance to check.

### Returns
`true` if the session is locked, `false` otherwise.
```

--------------------------------

### gtk_layer_set_exclusive_zone

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Sets the exclusive zone for the layer surface.

```APIDOC
## gtk_layer_set_exclusive_zone ()

### Description
Sets the exclusive zone for the layer surface.

### Parameters
- **zone** (int) - The exclusive zone to set.
```

--------------------------------

### Check if Screen is Locked

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Session-Lock.html

Returns whether the current GtkSessionLockInstance holds an active lock on the screen.

```c
gboolean
gtk_session_lock_instance_is_locked (_GtkSessionLockInstance *self_);
```

--------------------------------

### geom_size_t

Source: https://wmww.github.io/gtk4-layer-shell/api-index-full.html

Struct for geometry size in layer-surface.

```APIDOC
## geom_size_t struct

### Description
Struct for geometry size.

### Module
layer-surface
```

--------------------------------

### gtk_layer_set_layer

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Sets the layer on which a surface appears, controlling its stacking order relative to other surfaces. On compositors supporting older versions of the layer shell protocol, the window may be remapped for the change to take effect. The default layer is GTK_LAYER_SHELL_LAYER_TOP.

```APIDOC
## gtk_layer_set_layer

### Description
Sets the layer on which a surface appears, controlling its stacking order relative to other surfaces. On compositors supporting older versions of the layer shell protocol, the window may be remapped for the change to take effect. The default layer is GTK_LAYER_SHELL_LAYER_TOP.

### Parameters
#### Path Parameters
- **window** (_GtkWindow *) - A layer surface.
- **layer** (_GtkLayerShellLayer) - The layer on which this surface appears.

### Parameters
#### Path Parameters
- **window** (_GtkWindow *) - A layer surface.
- **layer** (_GtkLayerShellLayer) - The layer on which this surface appears.
```

--------------------------------

### gtk_layer_auto_exclusive_zone_is_enabled

Source: https://wmww.github.io/gtk4-layer-shell/gtk4-layer-shell-GTK4-Layer-Shell.html

Checks if automatic exclusive zone management is enabled for the layer surface.

```APIDOC
## gtk_layer_auto_exclusive_zone_is_enabled ()

### Description
Checks if automatic exclusive zone management is enabled for the layer surface.

### Returns
gboolean - `TRUE` if automatic exclusive zone is enabled.
```
Tokens:
Raw