GTK4 Layer Shell

https://docs.rs/gtk4-layer-shell
Admin
gtk4-layer-shell provides safe Rust bindings for the gtk4-layer-shell C library, allowing developers...
Tokens:16,588
Snippets:165
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Get Monitor for Layer Surface

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/lib.rs.html

Retrieves the monitor associated with the layer surface.

```rust
fn monitor(&self) -> Option<gdk::Monitor> {
    crate::auto::functions::monitor(self)
}
```

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

### Get Library Version

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/auto/functions.rs.html

Retrieves the major, minor, or micro version numbers of the linked GTK Layer Shell library.

```rust
pub fn major_version() -> u32 {
    assert_initialized_main_thread!();
    unsafe {
        ffi::gtk_layer_get_major_version()
    }
}
```

```rust
pub fn micro_version() -> u32 {
    assert_initialized_main_thread!();
    unsafe {
        ffi::gtk_layer_get_micro_version()
    }
}
```

```rust
pub fn minor_version() -> u32 {
    assert_initialized_main_thread!();
    unsafe {
        ffi::gtk_layer_get_minor_version()
    }
}
```

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

### Get Major Version Function Signature

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_get_major_version.html

The function signature for retrieving the major version of the library.

```rust
pub unsafe extern "C" fn gtk_layer_get_major_version() -> c_uint
```

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

### Get Minor Version Function Signature

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_get_minor_version.html

The function signature for retrieving the minor version of the gtk4-layer-shell library.

```rust
pub unsafe extern "C" fn gtk_layer_get_minor_version() -> c_uint
```

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

### Get Layer Surface Properties

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/auto/functions.rs.html

Functions to retrieve current state information for a layer surface, including anchoring, exclusive zones, keyboard modes, and layer placement.

```rust
pub fn is_anchor(window: &impl IsA<gtk::Window>, edge: Edge) -> bool {
    assert_initialized_main_thread!();
    unsafe {
        from_glib(ffi::gtk_layer_get_anchor(window.as_ref().to_glib_none().0, edge.into_glib()))
    }
}
```

```rust
pub fn exclusive_zone(window: &impl IsA<gtk::Window>) -> i32 {
    assert_initialized_main_thread!();
    unsafe {
        ffi::gtk_layer_get_exclusive_zone(window.as_ref().to_glib_none().0)
    }
}
```

```rust
pub fn keyboard_mode(window: &impl IsA<gtk::Window>) -> KeyboardMode {
    assert_initialized_main_thread!();
    unsafe {
        from_glib(ffi::gtk_layer_get_keyboard_mode(window.as_ref().to_glib_none().0))
    }
}
```

```rust
pub fn layer(window: &impl IsA<gtk::Window>) -> Layer {
    assert_initialized_main_thread!();
    unsafe {
        from_glib(ffi::gtk_layer_get_layer(window.as_ref().to_glib_none().0))
    }
}
```

```rust
pub fn margin(window: &impl IsA<gtk::Window>, edge: Edge) -> i32 {
    assert_initialized_main_thread!();
    unsafe {
        ffi::gtk_layer_get_margin(window.as_ref().to_glib_none().0, edge.into_glib())
    }
}
```

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

### Get GTK4 Layer Shell micro version

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_get_micro_version.html

Retrieves the micro version component of the library version as a C unsigned integer.

```rust
pub unsafe extern "C" fn gtk_layer_get_micro_version() -> c_uint
```

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

### Get exclusive zone function signature

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_get_exclusive_zone.html

The function signature for retrieving the exclusive zone of a GtkWindow.

```rust
pub unsafe extern "C" fn gtk_layer_get_exclusive_zone(
    window: *mut GtkWindow,
) -> c_int
```

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

### Get Namespace for Layer Surface

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/lib.rs.html

Returns the namespace property of the layer surface. Do not free the returned string as it does not return ownership.

```rust
fn namespace(&self) -> Option<glib::GString> {
    crate::auto::functions::namespace(self)
}
```

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

### init_for_window

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/auto/functions.rs.html

Initializes a GtkWindow to be a layer surface.

```APIDOC
## fn init_for_window(window: &impl IsA<gtk::Window>)

### Description
Sets the window up to be a layer surface once it is mapped. Must be called before the window is realized.

### Parameters
- **window** (&impl IsA<gtk::Window>) - Required - A GtkWindow to be turned into a layer surface.
```

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

### Initialize Layer Shell for Window

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/lib.rs.html

Prepares a GTK window to be a layer surface. This must be called before the window is realized.

```rust
fn init_layer_shell(&self) {
    crate::auto::functions::init_for_window(self);
}
```

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

### gtk_layer_init_for_window

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_init_for_window.html

Initializes the layer shell for the specified GtkWindow.

```APIDOC
## Function: gtk_layer_init_for_window

### Description
Initializes the layer shell for a given GtkWindow. This must be called before any other layer shell functions are used on the window.

### Signature
`pub unsafe extern "C" fn gtk_layer_init_for_window(window: *mut GtkWindow)`

### Parameters
- **window** (*mut GtkWindow) - The GtkWindow to initialize as a layer surface.
```

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

### init_layer_shell

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/lib.rs.html

Initializes a GTK window to be a layer surface. This must be called before the window is realized.

```APIDOC
## init_layer_shell

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

### Signature
`fn init_layer_shell(&self)`
```

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

### gtk_layer_init_for_window function signature

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_init_for_window.html

The function signature for initializing a GTK window for the layer shell protocol.

```rust
pub unsafe extern "C" fn gtk_layer_init_for_window(
    window: *mut GtkWindow,
)
```

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

### set_monitor

Source: https://docs.rs/gtk4-layer-shell/latest/gtk4_layer_shell/trait.LayerShell.html

Sets the output monitor for the window.

```APIDOC
## fn set_monitor(&self, monitor: Option<&Monitor>)

### Description
Sets the output for the window to be placed on, or None to let the compositor choose.

### Parameters
- **monitor** (Option<&Monitor>) - The output monitor or None.
```

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

### Define Initialization Macros

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/lib.rs.html

Macros used to ensure GTK is initialized on the main thread or to skip such checks.

```rust
macro_rules! assert_initialized_main_thread {
    () => {
        if !::gtk::is_initialized_main_thread() {
            if ::gtk::is_initialized() {
                panic!("GTK may only be used from the main thread.");
            } else {
                panic!("GTK has not been initialized. Call `gtk::init` first.");
            }
        }
    };
}

/// No-op.
macro_rules! skip_assert_initialized {
    () => {};
}
```

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

### set_namespace

Source: https://docs.rs/gtk4-layer-shell/latest/gtk4_layer_shell/trait.LayerShell.html

Sets the namespace of the surface.

```APIDOC
## fn set_namespace(&self, name_space: Option<&str>)

### Description
Sets the namespace string for the surface, used for identification by the compositor.

### Parameters
- **name_space** (Option<&str>) - The namespace string.
```

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

### pub fn protocol_version() -> u32

Source: https://docs.rs/gtk4-layer-shell/latest/gtk4_layer_shell/fn.protocol_version.html

Returns the version of the zwlr_layer_shell_v1 protocol supported by the compositor. Note that this function may block for a Wayland roundtrip the first time it is called.

```APIDOC
## Function: protocol_version

### Description
Returns the version of the zwlr_layer_shell_v1 protocol supported by the compositor. If the protocol is not supported, it returns 0. This function may block for a Wayland roundtrip the first time it is called.

### Signature
`pub fn protocol_version() -> u32`

### Returns
- **u32**: The version of the zwlr_layer_shell_v1 protocol, or 0 if unsupported.
```

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

### Edge Enumeration and Glib Conversions

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/auto/enums.rs.html

Defines the screen edges and provides IntoGlib and FromGlib implementations for FFI compatibility.

```rust
1// This file was generated by gir (https://github.com/gtk-rs/gir)
2// from ..
3// from ../gir-files
4// DO NOT EDIT
5
6use crate::{ffi};
7use glib::{translate::*};
8
9#[derive(Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
10#[derive(Clone, Copy)]
11#[non_exhaustive]
12#[doc(alias = "GtkLayerShellEdge")]
13pub enum Edge {
14    /// The left edge of the screen.
15    #[doc(alias = "GTK_LAYER_SHELL_EDGE_LEFT")]
16    Left,
17    /// The right edge of the screen.
18    #[doc(alias = "GTK_LAYER_SHELL_EDGE_RIGHT")]
19    Right,
20    /// The top edge of the screen.
21    #[doc(alias = "GTK_LAYER_SHELL_EDGE_TOP")]
22    Top,
23    /// The bottom edge of the screen.
24    #[doc(alias = "GTK_LAYER_SHELL_EDGE_BOTTOM")]
25    Bottom,
26    /// Should not be used except to get the number of entries. (NOTE: may change in
27    /// future releases as more entries are added)
28    #[doc(alias = "GTK_LAYER_SHELL_EDGE_ENTRY_NUMBER")]
29    EntryNumber,
30#[doc(hidden)]
31    __Unknown(i32),
32}
33
34#[doc(hidden)]
35impl IntoGlib for Edge {
36    type GlibType = ffi::GtkLayerShellEdge;
37
38    #[inline]
39fn into_glib(self) -> ffi::GtkLayerShellEdge {
40match self {
41            Self::Left => ffi::GTK_LAYER_SHELL_EDGE_LEFT,
42            Self::Right => ffi::GTK_LAYER_SHELL_EDGE_RIGHT,
43            Self::Top => ffi::GTK_LAYER_SHELL_EDGE_TOP,
44            Self::Bottom => ffi::GTK_LAYER_SHELL_EDGE_BOTTOM,
45            Self::EntryNumber => ffi::GTK_LAYER_SHELL_EDGE_ENTRY_NUMBER,
46            Self::__Unknown(value) => value,
47}
48}
49}
50
51#[doc(hidden)]
52impl FromGlib<ffi::GtkLayerShellEdge> for Edge {
53    #[inline]
54unsafe fn from_glib(value: ffi::GtkLayerShellEdge) -> Self {
55        skip_assert_initialized!();
56        
57match value {
58            ffi::GTK_LAYER_SHELL_EDGE_LEFT => Self::Left,
59            ffi::GTK_LAYER_SHELL_EDGE_RIGHT => Self::Right,
60            ffi::GTK_LAYER_SHELL_EDGE_TOP => Self::Top,
61            ffi::GTK_LAYER_SHELL_EDGE_BOTTOM => Self::Bottom,
62            ffi::GTK_LAYER_SHELL_EDGE_ENTRY_NUMBER => Self::EntryNumber,
63            value => Self::__Unknown(value),
64}
65}
66}
```

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

### is_supported

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/auto/functions.rs.html

Checks if the current platform supports the layer shell protocol.

```APIDOC
## fn is_supported() -> bool

### Description
Returns true if the platform is Wayland and the compositor supports the zwlr_layer_shell_v1 protocol. May block for a Wayland roundtrip.
```

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

### gtk_layer_get_zwlr_layer_surface_v1

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_get_zwlr_layer_surface_v1.html

Retrieves the underlying zwlr_layer_surface_v1 pointer for a specified GtkWindow.

```APIDOC
## Function: gtk_layer_get_zwlr_layer_surface_v1

### Description
Retrieves the `zwlr_layer_surface_v1` associated with the provided `GtkWindow`.

### Signature
`pub unsafe extern "C" fn gtk_layer_get_zwlr_layer_surface_v1(window: *mut GtkWindow) -> *mut zwlr_layer_surface_v1`

### Parameters
- **window** (*mut GtkWindow) - A pointer to the GtkWindow instance.

### Returns
- ***mut zwlr_layer_surface_v1** - A pointer to the layer surface object.
```

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

### KeyboardMode Enumeration and Glib Conversions

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/auto/enums.rs.html

Defines keyboard focus modes for layer shell windows with necessary Glib conversion traits.

```rust
68#[derive(Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
69#[derive(Clone, Copy)]
70#[non_exhaustive]
71#[doc(alias = "GtkLayerShellKeyboardMode")]
72pub enum KeyboardMode {
73    /// This window should not receive keyboard events.
74    #[doc(alias = "GTK_LAYER_SHELL_KEYBOARD_MODE_NONE")]
75    None,
76    /// This window should have exclusive focus if it is on the top or overlay layer.
77    #[doc(alias = "GTK_LAYER_SHELL_KEYBOARD_MODE_EXCLUSIVE")]
78    Exclusive,
79    /// The user should be able to focus and unfocues this window in an implementation
80    /// defined way. Not supported for protocol version < 4.
81    #[doc(alias = "GTK_LAYER_SHELL_KEYBOARD_MODE_ON_DEMAND")]
82    OnDemand,
83    /// Should not be used except to get the number of entries. (NOTE: may change in
84    /// future releases as more entries are added)
85    #[doc(alias = "GTK_LAYER_SHELL_KEYBOARD_MODE_ENTRY_NUMBER")]
86    EntryNumber,
87#[doc(hidden)]
88    __Unknown(i32),
89}
90
91#[doc(hidden)]
92impl IntoGlib for KeyboardMode {
93    type GlibType = ffi::GtkLayerShellKeyboardMode;
94
95    #[inline]
96fn into_glib(self) -> ffi::GtkLayerShellKeyboardMode {
97match self {
98            Self::None => ffi::GTK_LAYER_SHELL_KEYBOARD_MODE_NONE,
99            Self::Exclusive => ffi::GTK_LAYER_SHELL_KEYBOARD_MODE_EXCLUSIVE,
100            Self::OnDemand => ffi::GTK_LAYER_SHELL_KEYBOARD_MODE_ON_DEMAND,
101            Self::EntryNumber => ffi::GTK_LAYER_SHELL_KEYBOARD_MODE_ENTRY_NUMBER,
102            Self::__Unknown(value) => value,
103}
104}
105}
106
107#[doc(hidden)]
108impl FromGlib<ffi::GtkLayerShellKeyboardMode> for KeyboardMode {
109    #[inline]
110unsafe fn from_glib(value: ffi::GtkLayerShellKeyboardMode) -> Self {
111        skip_assert_initialized!();
112        
113match value {
114            ffi::GTK_LAYER_SHELL_KEYBOARD_MODE_NONE => Self::None,
115            ffi::GTK_LAYER_SHELL_KEYBOARD_MODE_EXCLUSIVE => Self::Exclusive,
116            ffi::GTK_LAYER_SHELL_KEYBOARD_MODE_ON_DEMAND => Self::OnDemand,
117            ffi::GTK_LAYER_SHELL_KEYBOARD_MODE_ENTRY_NUMBER => Self::EntryNumber,
118            value => Self::__Unknown(value),
119}
120}
121}
```

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

### Define zwlr_layer_surface_v1 type

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/src/gtk4_layer_shell_sys/manual.rs.html

Defines the zwlr_layer_surface_v1 type as a gpointer for FFI compatibility.

```rust
1use glib_sys::gpointer;
2
3pub type zwlr_layer_surface_v1 = gpointer;
```

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

### gtk_layer_get_namespace

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_get_namespace.html

Retrieves the namespace string for the specified GtkWindow.

```APIDOC
## Function: gtk_layer_get_namespace

### Description
Retrieves the layer shell namespace currently set for the provided GtkWindow.

### Signature
`pub unsafe extern "C" fn gtk_layer_get_namespace(window: *mut GtkWindow) -> *const c_char`

### Parameters
- **window** (*mut GtkWindow) - A pointer to the GtkWindow instance to query.

### Returns
- ***const c_char** - A pointer to the null-terminated string representing the namespace.
```

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

### Set Keyboard Interactivity Mode

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/lib.rs.html

Defines how the window receives keyboard events from the compositor.

```rust
fn set_keyboard_mode(&self, mode: KeyboardMode) {
    crate::auto::functions::set_keyboard_mode(self, mode);
}
```

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

### gtk_layer_get_zwlr_layer_surface_v1 Function Signature

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_get_zwlr_layer_surface_v1.html

The function signature for retrieving the layer surface from a GtkWindow.

```rust
pub unsafe extern "C" fn gtk_layer_get_zwlr_layer_surface_v1(
    window: *mut GtkWindow,
) -> *mut zwlr_layer_surface_v1
```

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

### protocol_version

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/auto/functions.rs.html

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

```APIDOC
## fn protocol_version() -> u32

### Description
Returns the version of the zwlr_layer_shell_v1 protocol supported by the compositor, or 0 if not supported. May block for a Wayland roundtrip.
```

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

### Version Functions

Source: https://docs.rs/gtk4-layer-shell/latest/gtk4_layer_shell/index.html

Functions to retrieve the major, minor, and micro version of the library.

```APIDOC
## major_version()
Returns the major version of the library.

## minor_version()
Returns the minor version of the library.

## micro_version()
Returns the micro version of the library.
```

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

### monitor

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/auto/functions.rs.html

Retrieves the monitor that the specified layer surface is requested to be on.

```APIDOC
## fn monitor(window: &impl IsA<gtk::Window>) -> Option<gdk::Monitor>

### Description
Returns the monitor this surface will or has requested to be on.

### Parameters
- **window** (&impl IsA<gtk::Window>) - Required - A layer surface.
```

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

### zwlr_layer_surface_v1

Source: https://docs.rs/gtk4-layer-shell/latest/gtk4_layer_shell/fn.zwlr_layer_surface_v1.html

Retrieves the underlying zwlr_layer_surface_v1 Wayland object from a GTK window.

```APIDOC
## zwlr_layer_surface_v1

### Description
Retrieves the underlying Wayland layer surface object associated with the provided GTK window.

### Signature
`pub fn zwlr_layer_surface_v1(window: &impl IsA<Window>) -> Option<*mut zwlr_layer_surface_v1>`

### Parameters
- **window** (&impl IsA<Window>) - The GTK window to retrieve the layer surface from.

### Returns
- **Option<*mut zwlr_layer_surface_v1>** - The underlying layer surface Wayland object, or None if not available.
```

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

### Set respect close property

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/auto/functions.rs.html

Configures whether the window respects the close event. Requires the v1_3 feature flag.

```rust
pub fn set_respect_close(window: &impl IsA<gtk::Window>, respect_close: bool) {
    assert_initialized_main_thread!();
    unsafe {
        ffi::gtk_layer_set_respect_close(window.as_ref().to_glib_none().0, respect_close.into_glib());
    }
}
```

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

### gtk_layer_set_anchor function signature

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_set_anchor.html

The C-style function signature for setting the anchor of a window.

```rust
pub unsafe extern "C" fn gtk_layer_set_anchor(
    window: *mut GtkWindow,
    edge: GtkLayerShellEdge,
    anchor_to_edge: gboolean,
)
```

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

### gtk_layer_get_micro_version

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_get_micro_version.html

Retrieves the micro version of the gtk4-layer-shell library.

```APIDOC
## gtk_layer_get_micro_version

### Description
Returns the micro version number of the gtk4-layer-shell library currently in use.

### Signature
`pub unsafe extern "C" fn gtk_layer_get_micro_version() -> c_uint`

### Returns
- **c_uint** - The micro version number.
```

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

### is_supported

Source: https://docs.rs/gtk4-layer-shell/latest/gtk4_layer_shell/all.html

Checks if the current Wayland compositor supports the layer shell protocol.

```APIDOC
## Function: is_supported

### Description
Returns a boolean indicating whether the layer shell protocol is supported by the current compositor.

### Signature
`pub fn is_supported() -> bool`
```

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

### Version Information

Source: https://docs.rs/gtk4-layer-shell/latest/gtk4_layer_shell/all.html

Functions to retrieve the library and protocol version numbers.

```APIDOC
## Functions: major_version, minor_version, micro_version, protocol_version

### Description
These functions return the version components of the library or the supported protocol version.

### Signatures
- `pub fn major_version() -> u32`
- `pub fn minor_version() -> u32`
- `pub fn micro_version() -> u32`
- `pub fn protocol_version() -> u32`
```

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

### GTK_LAYER_SHELL_KEYBOARD_MODE_ENTRY_NUMBER definition

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/constant.GTK_LAYER_SHELL_KEYBOARD_MODE_ENTRY_NUMBER.html

The constant definition for the keyboard mode entry number.

```rust
pub const GTK_LAYER_SHELL_KEYBOARD_MODE_ENTRY_NUMBER: GtkLayerShellKeyboardMode = 3;
```

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

### GTK_LAYER_SHELL_KEYBOARD_MODE_ON_DEMAND definition

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/constant.GTK_LAYER_SHELL_KEYBOARD_MODE_ON_DEMAND.html

The constant definition for the on-demand keyboard mode within the gtk4-layer-shell-sys crate.

```rust
pub const GTK_LAYER_SHELL_KEYBOARD_MODE_ON_DEMAND: GtkLayerShellKeyboardMode = 2;
```

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

### GTK_LAYER_SHELL_LAYER_OVERLAY

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/constant.GTK_LAYER_SHELL_LAYER_OVERLAY.html

A constant representing the overlay layer in the GTK layer shell system.

```APIDOC
## GTK_LAYER_SHELL_LAYER_OVERLAY

### Description
Represents the overlay layer for a window managed by the GTK layer shell. This constant is of type `GtkLayerShellLayer` and has a value of 3.

### Signature
`pub const GTK_LAYER_SHELL_LAYER_OVERLAY: GtkLayerShellLayer = 3;`
```

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

### is_layer_window

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/auto/functions.rs.html

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

```APIDOC
## fn is_layer_window(window: &impl IsA<gtk::Window>) -> bool

### Description
Returns true if the window has been initialized as a layer surface.

### Parameters
- **window** (&impl IsA<gtk::Window>) - Required - A GtkWindow that may or may not have a layer surface.
```

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

### gtk_layer_set_monitor function signature

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_set_monitor.html

The function signature for setting the monitor on a GtkWindow, requiring unsafe blocks as it is an FFI call.

```rust
pub unsafe extern "C" fn gtk_layer_set_monitor(
    window: *mut GtkWindow,
    monitor: *mut GdkMonitor,
)
```

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

### pub fn minor_version() -> u32

Source: https://docs.rs/gtk4-layer-shell/latest/gtk4_layer_shell/fn.minor_version.html

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

```APIDOC
## minor_version

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

### Signature
`pub fn minor_version() -> u32`

### Returns
- **u32** - The minor version number of the library.
```

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

### gtk_layer_set_margin function signature

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_set_margin.html

The C-compatible function signature for setting window margins in the layer shell.

```rust
pub unsafe extern "C" fn gtk_layer_set_margin(
    window: *mut GtkWindow,
    edge: GtkLayerShellEdge,
    margin_size: c_int,
)
```

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

### protocol_version

Source: https://docs.rs/gtk4-layer-shell/latest/gtk4_layer_shell/index.html

Returns the version of the layer-shell protocol supported by the compositor. May block for a Wayland roundtrip the first time it is called.

```APIDOC
## protocol_version()

### Description
Returns the version of the layer-shell protocol supported by the compositor. This function may block for a Wayland roundtrip the first time it is called.
```

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

### gtk_layer_is_supported

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_is_supported.html

Checks whether the GTK4 layer shell protocol is supported by the current display server.

```APIDOC
## gtk_layer_is_supported

### Description
Checks if the GTK4 layer shell protocol is supported by the current display server. This function is part of the gtk4-layer-shell-sys crate.

### Signature
`pub unsafe extern "C" fn gtk_layer_is_supported() -> gboolean`

### Returns
- **gboolean** - Returns true if the layer shell protocol is supported, otherwise false.
```

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

### gtk_layer_get_monitor function signature

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_get_monitor.html

The unsafe C-style function signature for retrieving the GdkMonitor from a GtkWindow.

```rust
pub unsafe extern "C" fn gtk_layer_get_monitor(
    window: *mut GtkWindow,
) -> *mut GdkMonitor
```

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

### gtk_layer_set_monitor

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_set_monitor.html

Sets the monitor on which the layer surface should appear.

```APIDOC
## gtk_layer_set_monitor

### Description
Sets the monitor for a given GtkWindow to be used by the layer shell.

### Signature
`pub unsafe extern "C" fn gtk_layer_set_monitor(window: *mut GtkWindow, monitor: *mut GdkMonitor)`

### Parameters
- **window** (*mut GtkWindow) - The window to set the monitor for.
- **monitor** (*mut GdkMonitor) - The monitor to assign to the window.
```

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

### FFI Bindings for gtk4-layer-shell

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/src/gtk4_layer_shell_sys/lib.rs.html

This snippet contains the generated FFI definitions, including enums and external function declarations for interacting with the layer shell protocol.

```rust
1// This file was generated by gir (https://github.com/gtk-rs/gir)
2// from ..
3// from ../gir-files
4// DO NOT EDIT
5
6#![allow(non_camel_case_types, non_upper_case_globals, non_snake_case)]
7#![allow(clippy::approx_constant, clippy::type_complexity, clippy::unreadable_literal, clippy::upper_case_acronyms)]
8#![cfg_attr(docsrs, feature(doc_cfg))]
9
10use glib_sys as glib;
11use gdk4_sys as gdk;
12use gtk4_sys as gtk;
13
14mod manual;
15
16pub use manual::*;
17
18#[allow(unused_imports)]
19use std::ffi::{c_int, c_char, c_uchar, c_float, c_uint, c_double,
20    c_short, c_ushort, c_long, c_ulong, c_void};
21#[allow(unused_imports)]
22use libc::{size_t, ssize_t, time_t, off_t, intptr_t, uintptr_t, FILE};
23#[cfg(unix)]
24#[allow(unused_imports)]
25use libc::{dev_t, gid_t, pid_t, socklen_t, uid_t};
26
27#[allow(unused_imports)]
28use glib::{gboolean, gconstpointer, gpointer, GType};
29
30// Enums
31pub type GtkLayerShellEdge = c_int;
32pub const GTK_LAYER_SHELL_EDGE_LEFT: GtkLayerShellEdge = 0;
33pub const GTK_LAYER_SHELL_EDGE_RIGHT: GtkLayerShellEdge = 1;
34pub const GTK_LAYER_SHELL_EDGE_TOP: GtkLayerShellEdge = 2;
35pub const GTK_LAYER_SHELL_EDGE_BOTTOM: GtkLayerShellEdge = 3;
36pub const GTK_LAYER_SHELL_EDGE_ENTRY_NUMBER: GtkLayerShellEdge = 4;
37
38pub type GtkLayerShellKeyboardMode = c_int;
39pub const GTK_LAYER_SHELL_KEYBOARD_MODE_NONE: GtkLayerShellKeyboardMode = 0;
40pub const GTK_LAYER_SHELL_KEYBOARD_MODE_EXCLUSIVE: GtkLayerShellKeyboardMode = 1;
41pub const GTK_LAYER_SHELL_KEYBOARD_MODE_ON_DEMAND: GtkLayerShellKeyboardMode = 2;
42pub const GTK_LAYER_SHELL_KEYBOARD_MODE_ENTRY_NUMBER: GtkLayerShellKeyboardMode = 3;
43
44pub type GtkLayerShellLayer = c_int;
45pub const GTK_LAYER_SHELL_LAYER_BACKGROUND: GtkLayerShellLayer = 0;
46pub const GTK_LAYER_SHELL_LAYER_BOTTOM: GtkLayerShellLayer = 1;
47pub const GTK_LAYER_SHELL_LAYER_TOP: GtkLayerShellLayer = 2;
48pub const GTK_LAYER_SHELL_LAYER_OVERLAY: GtkLayerShellLayer = 3;
49pub const GTK_LAYER_SHELL_LAYER_ENTRY_NUMBER: GtkLayerShellLayer = 4;
50
51unsafe extern "C" {
52
53    //=========================================================================
54    // Other functions
55    //=========================================================================
56    pub fn gtk_layer_auto_exclusive_zone_enable(window: *mut gtk::GtkWindow);
57    pub fn gtk_layer_auto_exclusive_zone_is_enabled(window: *mut gtk::GtkWindow) -> gboolean;
58    pub fn gtk_layer_get_anchor(window: *mut gtk::GtkWindow, edge: GtkLayerShellEdge) -> gboolean;
59    pub fn gtk_layer_get_exclusive_zone(window: *mut gtk::GtkWindow) -> c_int;
60    pub fn gtk_layer_get_keyboard_mode(window: *mut gtk::GtkWindow) -> GtkLayerShellKeyboardMode;
61    pub fn gtk_layer_get_layer(window: *mut gtk::GtkWindow) -> GtkLayerShellLayer;
62    pub fn gtk_layer_get_major_version() -> c_uint;
63    pub fn gtk_layer_get_margin(window: *mut gtk::GtkWindow, edge: GtkLayerShellEdge) -> c_int;
64    pub fn gtk_layer_get_micro_version() -> c_uint;
65    pub fn gtk_layer_get_minor_version() -> c_uint;
66    pub fn gtk_layer_get_monitor(window: *mut gtk::GtkWindow) -> *mut gdk::GdkMonitor;
67    pub fn gtk_layer_get_namespace(window: *mut gtk::GtkWindow) -> *const c_char;
68    pub fn gtk_layer_get_protocol_version() -> c_uint;
69    #[cfg(feature = "v1_3")]
70    #[cfg_attr(docsrs, doc(cfg(feature = "v1_3")))]
71    pub fn gtk_layer_get_respect_close(window: *mut gtk::GtkWindow) -> gboolean;
72    pub fn gtk_layer_get_zwlr_layer_surface_v1(window: *mut gtk::GtkWindow) -> *mut zwlr_layer_surface_v1;
73    pub fn gtk_layer_init_for_window(window: *mut gtk::GtkWindow);
74    pub fn gtk_layer_is_layer_window(window: *mut gtk::GtkWindow) -> gboolean;
75    pub fn gtk_layer_is_supported() -> gboolean;
76    pub fn gtk_layer_set_anchor(window: *mut gtk::GtkWindow, edge: GtkLayerShellEdge, anchor_to_edge: gboolean);
77    pub fn gtk_layer_set_exclusive_zone(window: *mut gtk::GtkWindow, exclusive_zone: c_int);
78    pub fn gtk_layer_set_keyboard_mode(window: *mut gtk::GtkWindow, mode: GtkLayerShellKeyboardMode);
79    pub fn gtk_layer_set_layer(window: *mut gtk::GtkWindow, layer: GtkLayerShellLayer);
80    pub fn gtk_layer_set_margin(window: *mut gtk::GtkWindow, edge: GtkLayerShellEdge, margin_size: c_int);
81    pub fn gtk_layer_set_monitor(window: *mut gtk::GtkWindow, monitor: *mut gdk::GdkMonitor);
82    pub fn gtk_layer_set_namespace(window: *mut gtk::GtkWindow, name_space: *const c_char);
83    #[cfg(feature = "v1_3")]
84    #[cfg_attr(docsrs, doc(cfg(feature = "v1_3")))]
85    pub fn gtk_layer_set_respect_close(window: *mut gtk::GtkWindow, respect_close: gboolean);
86
87}
```

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

### Retrieve the underlying layer surface

Source: https://docs.rs/gtk4-layer-shell/latest/gtk4_layer_shell/fn.zwlr_layer_surface_v1.html

Returns the underlying zwlr_layer_surface_v1 Wayland object for the specified window.

```rust
pub fn zwlr_layer_surface_v1(
    window: &impl IsA<Window>,
) -> Option<*mut zwlr_layer_surface_v1>
```

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

### gtk_layer_get_respect_close function signature

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/x86_64-unknown-linux-gnu/gtk4_layer_shell_sys/fn.gtk_layer_get_respect_close.html

The C-compatible function signature for retrieving the respect close property of a window.

```rust
pub unsafe extern "C" fn gtk_layer_get_respect_close(
    window: *mut GtkWindow,
) -> gboolean
```

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

### namespace

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/auto/functions.rs.html

Retrieves the namespace property of the layer surface.

```APIDOC
## fn namespace(window: &impl IsA<gtk::Window>) -> Option<glib::GString>

### Description
Returns a reference to the namespace property. If unset, returns the default namespace ("gtk4-layer-shell").

### Parameters
- **window** (&impl IsA<gtk::Window>) - Required - A layer surface.
```

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

### gtk_layer_set_keyboard_mode function signature

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_set_keyboard_mode.html

The function signature for setting the keyboard mode on a GtkWindow.

```rust
pub unsafe extern "C" fn gtk_layer_set_keyboard_mode(
    window: *mut GtkWindow,
    mode: GtkLayerShellKeyboardMode,
)
```

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

### Version Functions

Source: https://docs.rs/gtk4-layer-shell/latest/index.html

Functions to retrieve the major, minor, micro, and protocol versions of the layer shell library.

```APIDOC
## fn major_version()
## fn minor_version()
## fn micro_version()
## fn protocol_version()

### Description
Returns the respective version numbers of the layer shell library or protocol. Note that protocol_version may block for a Wayland roundtrip the first time it is called.
```

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

### gtk_layer_get_protocol_version

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_get_protocol_version.html

Retrieves the protocol version of the layer shell.

```APIDOC
## gtk_layer_get_protocol_version

### Description
Returns the version of the layer shell protocol supported by the compositor.

### Signature
`pub unsafe extern "C" fn gtk_layer_get_protocol_version() -> c_uint`

### Returns
- **c_uint** - The protocol version number.
```

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

### set_keyboard_mode

Source: https://docs.rs/gtk4-layer-shell/latest/gtk4_layer_shell/trait.LayerShell.html

Sets if/when the window should receive keyboard events from the compositor.

```APIDOC
## fn set_keyboard_mode(&self, mode: KeyboardMode)

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

### Parameters
- **mode** (KeyboardMode) - The type of keyboard interactivity requested.
```

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

### gtk_layer_get_minor_version

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_get_minor_version.html

Retrieves the minor version of the gtk4-layer-shell library.

```APIDOC
## gtk_layer_get_minor_version

### Description
Returns the minor version number of the gtk4-layer-shell library.

### Signature
`pub unsafe extern "C" fn gtk_layer_get_minor_version() -> c_uint`

### Returns
- **c_uint** - The minor version number.
```

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

### micro_version()

Source: https://docs.rs/gtk4-layer-shell/latest/gtk4_layer_shell/fn.micro_version.html

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

```APIDOC
## Function: micro_version

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

### Signature
`pub fn micro_version() -> u32`

### Returns
- **u32** - The micro/patch version number of the library.
```

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

### gtk_layer_get_monitor

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_get_monitor.html

Retrieves the monitor that the window is currently associated with.

```APIDOC
## gtk_layer_get_monitor

### Description
Retrieves the GdkMonitor associated with the specified GtkWindow.

### Signature
`pub unsafe extern "C" fn gtk_layer_get_monitor(window: *mut GtkWindow) -> *mut GdkMonitor`

### Parameters
- **window** (*mut GtkWindow) - The GtkWindow to query.
```

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

### gtk_layer_get_protocol_version function signature

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_get_protocol_version.html

The function signature for retrieving the protocol version, defined as an unsafe extern C function.

```rust
pub unsafe extern "C" fn gtk_layer_get_protocol_version() -> c_uint
```

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

### layer

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/auto/functions.rs.html

Retrieves the current layer of a layer surface.

```APIDOC
## layer(window: &impl IsA<gtk::Window>) -> Layer

### Description
Returns the current layer assigned to the specified window.

### Parameters
- **window** (impl IsA<gtk::Window>) - Required - The layer surface window.
```

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

### FFI Signature for gtk_layer_is_supported

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_is_supported.html

The C-compatible function signature used to determine if the current environment supports the layer shell protocol.

```rust
pub unsafe extern "C" fn gtk_layer_is_supported() -> gboolean
```

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

### GTK_LAYER_SHELL_KEYBOARD_MODE_ON_DEMAND

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/constant.GTK_LAYER_SHELL_KEYBOARD_MODE_ON_DEMAND.html

A constant representing the 'on demand' keyboard mode for the GTK layer shell.

```APIDOC
## Constant: GTK_LAYER_SHELL_KEYBOARD_MODE_ON_DEMAND

### Description
Represents the 'on demand' keyboard mode for the GTK layer shell, used to configure how the layer surface handles keyboard focus.

### Type
`GtkLayerShellKeyboardMode`

### Value
`2`
```

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

### GTK_LAYER_SHELL_LAYER_TOP constant definition

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/constant.GTK_LAYER_SHELL_LAYER_TOP.html

The constant definition for the top layer in the layer shell system.

```rust
pub const GTK_LAYER_SHELL_LAYER_TOP: GtkLayerShellLayer = 2;
```

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

### GTK_LAYER_SHELL_KEYBOARD_MODE_NONE

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/constant.GTK_LAYER_SHELL_KEYBOARD_MODE_NONE.html

The constant value representing the NONE keyboard mode for the GTK layer shell.

```APIDOC
## GTK_LAYER_SHELL_KEYBOARD_MODE_NONE

### Description
Represents the keyboard mode where no keyboard focus is requested for the layer surface.

### Definition
`pub const GTK_LAYER_SHELL_KEYBOARD_MODE_NONE: GtkLayerShellKeyboardMode = 0;`
```

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

### pub fn major_version() -> u32

Source: https://docs.rs/gtk4-layer-shell/latest/gtk4_layer_shell/fn.major_version.html

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

```APIDOC
## major_version

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

### Signature
`pub fn major_version() -> u32`

### Returns
- **u32** - The major version number of the library.
```

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

### GTK_LAYER_SHELL_KEYBOARD_MODE_NONE Definition

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/constant.GTK_LAYER_SHELL_KEYBOARD_MODE_NONE.html

The constant definition for the keyboard mode indicating no keyboard interaction.

```rust
pub const GTK_LAYER_SHELL_KEYBOARD_MODE_NONE: GtkLayerShellKeyboardMode = 0;
```

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

### set_respect_close

Source: https://docs.rs/gtk4-layer-shell/latest/gtk4_layer_shell/trait.LayerShell.html

Configures whether to forward the .closed event to GTK.

```APIDOC
## fn set_respect_close(&self, respect_close: bool)

### Description
Configures if the .closed event should be forwarded to GTK. Requires crate feature v1_3.

### Parameters
- **respect_close** (bool) - Whether to forward the event.
```

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

### gtk_layer_get_keyboard_mode function signature

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_get_keyboard_mode.html

The function signature for retrieving the keyboard mode from a GtkWindow.

```rust
pub unsafe extern "C" fn gtk_layer_get_keyboard_mode(
    window: *mut GtkWindow,
) -> GtkLayerShellKeyboardMode
```

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

### gtk_layer_get_layer

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_get_layer.html

Retrieves the layer shell layer for the specified GtkWindow.

```APIDOC
## gtk_layer_get_layer

### Description
Retrieves the current layer shell layer assigned to the provided GtkWindow.

### Signature
`pub unsafe extern "C" fn gtk_layer_get_layer(window: *mut GtkWindow) -> GtkLayerShellLayer`

### Parameters
- **window** (*mut GtkWindow) - Required - A pointer to the GtkWindow instance to query.

### Returns
- **GtkLayerShellLayer** - The layer currently assigned to the window.
```

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

### Implement TryFromGlib for Layer

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/lib.rs.html

Converts a GtkLayerShellLayer FFI value into a Rust Layer enum, returning an error if the variant is unknown.

```rust
impl TryFromGlib<ffi::GtkLayerShellLayer> for Layer {
    type Error = glib::translate::GlibNoneError;

    unsafe fn try_from_glib(value: ffi::GtkLayerShellLayer) -> Result<Self, Self::Error> {
        let layer = unsafe { Self::from_glib(value) };
        // If we got an unknown variant, return an error; otherwise, return the value.
        match layer {
            Layer::__Unknown(_) => Err(glib::translate::GlibNoneError),
            _ => Ok(layer),
        }
    }
}
```

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

### LayerShell Trait Methods

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/lib.rs.html

Provides methods for interacting with layer-shell surfaces, such as managing exclusive zones, anchoring, and keyboard modes.

```rust
pub trait LayerShell: IsA<gtk::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 gtk-layer-shell and not part of the underlying protocol
    /// ## `window`
    /// A layer surface.
    #[doc(alias = "gtk_layer_auto_exclusive_zone_enable")]
    fn auto_exclusive_zone_enable(&self) {
        crate::auto::functions::auto_exclusive_zone_enable(self);
    }

    /// ## `window`
    /// A layer surface.
    ///
    /// # Returns
    ///
    /// if the surface's exclusive zone is set to change based on the window's size
    #[doc(alias = "gtk_layer_auto_exclusive_zone_is_enabled")]
    fn auto_exclusive_zone_is_enabled(&self) -> bool {
        crate::auto::functions::auto_exclusive_zone_is_enabled(self)
    }

    /// ## `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.
    #[doc(alias = "gtk_layer_get_anchor")]
    #[doc(alias = "get_anchor")]
    fn is_anchor(&self, edge: Edge) -> bool {
        crate::auto::functions::is_anchor(self, edge)
    }

    /// ## `window`
    /// A layer surface.
    ///
    /// # Returns
    ///
    /// the window's exclusive zone (which may have been set manually or automatically)
    #[doc(alias = "gtk_layer_get_exclusive_zone")]
    #[doc(alias = "get_exclusive_zone")]
    fn exclusive_zone(&self) -> i32 {
        crate::auto::functions::exclusive_zone(self)
    }

    /// ## `window`
    /// A layer surface.
    ///
    /// # Returns
    ///
    /// current keyboard interactivity mode for `window`.
    #[doc(alias = "gtk_layer_get_keyboard_mode")]
    #[doc(alias = "get_keyboard_mode")]
    fn keyboard_mode(&self) -> KeyboardMode {
        crate::auto::functions::keyboard_mode(self)
    }

    /// ## `window`
    /// A layer surface.
    ///
    /// # Returns
    ///
    /// the current layer.
    #[doc(alias = "gtk_layer_get_layer")]
    #[doc(alias = "get_layer")]
    fn layer(&self) -> Layer {
        crate::auto::functions::layer(self)
    }

    /// ## `window`
    /// A layer surface.
    /// ## `edge`
    /// the margin edge to get
    ///
    /// # Returns
    ///
    /// the size of the margin for the given edge.
    #[doc(alias = "gtk_layer_get_margin")]
    #[doc(alias = "get_margin")]
    fn margin(&self, edge: Edge) -> i32 {
        crate::auto::functions::margin(self, edge)
    }
}
```

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

### gtk_layer_set_keyboard_mode

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_set_keyboard_mode.html

Sets the keyboard mode for the specified GTK window.

```APIDOC
## gtk_layer_set_keyboard_mode

### Description
Sets the keyboard mode for a given GTK window using the layer shell protocol.

### Signature
`pub unsafe extern "C" fn gtk_layer_set_keyboard_mode(window: *mut GtkWindow, mode: GtkLayerShellKeyboardMode)`

### Parameters
- **window** (*mut GtkWindow) - The window to set the keyboard mode for.
- **mode** (GtkLayerShellKeyboardMode) - The keyboard mode to apply.
```

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

### gtk_layer_auto_exclusive_zone_enable

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_auto_exclusive_zone_enable.html

Enables the auto-exclusive zone for the specified GtkWindow. This is an unsafe C-FFI function.

```APIDOC
## Function: gtk_layer_auto_exclusive_zone_enable

### Description
Enables the auto-exclusive zone for the provided GtkWindow. This allows the layer shell to automatically adjust the exclusive zone based on the window's size and position.

### Signature
`pub unsafe extern "C" fn gtk_layer_auto_exclusive_zone_enable(window: *mut GtkWindow)`

### Parameters
- **window** (*mut GtkWindow) - Required - A pointer to the GtkWindow instance to enable the auto-exclusive zone for.
```

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

### Define zwlr_layer_surface_v1 type alias

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/type.zwlr_layer_surface_v1.html

Represents the zwlr_layer_surface_v1 type as a raw pointer.

```rust
pub type zwlr_layer_surface_v1 = gpointer;
```

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

### Version Functions

Source: https://docs.rs/gtk4-layer-shell/latest/gtk4_layer_shell

Functions to retrieve the major, minor, and micro version numbers of the library.

```APIDOC
## Functions: major_version, minor_version, micro_version

### Description
These functions return the respective version components of the gtk4_layer_shell library.

### Signatures
- `pub fn major_version() -> u32`
- `pub fn minor_version() -> u32`
- `pub fn micro_version() -> u32`
```

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

### Check if Window is Layer Surface

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/lib.rs.html

Determines if the provided window has been initialized as a layer surface.

```rust
fn is_layer_window(&self) -> bool {
    crate::auto::functions::is_layer_window(self)
}
```

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

### GTK_LAYER_SHELL_EDGE_BOTTOM Constant Definition

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/constant.GTK_LAYER_SHELL_EDGE_BOTTOM.html

The constant definition for the bottom edge enumeration value.

```rust
pub const GTK_LAYER_SHELL_EDGE_BOTTOM: GtkLayerShellEdge = 3;
```

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

### set_anchor

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/lib.rs.html

Configures the anchoring of a layer surface to specific screen edges.

```APIDOC
## set_anchor

### Description
Set whether the 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.

### Signature
`fn set_anchor(&self, edge: Edge, anchor_to_edge: bool)`
```

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

### set_layer

Source: https://docs.rs/gtk4-layer-shell/latest/gtk4_layer_shell/trait.LayerShell.html

Sets the layer on which the surface appears.

```APIDOC
## fn set_layer(&self, layer: Layer)

### Description
Controls if the surface is over top of or below other surfaces.

### Parameters
- **layer** (Layer) - The layer on which this surface appears.
```

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

### gtk_layer_get_keyboard_mode

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_get_keyboard_mode.html

Retrieves the keyboard mode for the specified GtkWindow.

```APIDOC
## gtk_layer_get_keyboard_mode

### Description
Retrieves the current keyboard mode for a given GtkWindow. This function is part of the gtk4-layer-shell-sys library.

### Signature
`pub unsafe extern "C" fn gtk_layer_get_keyboard_mode(window: *mut GtkWindow) -> GtkLayerShellKeyboardMode`

### Parameters
- **window** (*mut GtkWindow) - The GtkWindow to query.

### Returns
- **GtkLayerShellKeyboardMode** - The current keyboard mode associated with the window.
```

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

### GTK_LAYER_SHELL_LAYER_BOTTOM Constant Definition

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/constant.GTK_LAYER_SHELL_LAYER_BOTTOM.html

The constant definition for the bottom layer in the GTK layer shell system.

```rust
pub const GTK_LAYER_SHELL_LAYER_BOTTOM: GtkLayerShellLayer = 1;
```

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

### gtk_layer_get_respect_close

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_get_respect_close.html

Retrieves the respect close status for the specified GtkWindow.

```APIDOC
## gtk_layer_get_respect_close

### Signature
`pub unsafe extern "C" fn gtk_layer_get_respect_close(window: *mut GtkWindow) -> gboolean`

### Description
Retrieves the current 'respect close' setting for the provided GtkWindow. This function is available when the `v1_3` crate feature is enabled.

### Parameters
- **window** (*mut GtkWindow) - A pointer to the GtkWindow instance to query.

### Returns
- **gboolean** - Returns a boolean value indicating the current respect close status.
```

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

### Set Anchor for Layer Surface

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/lib.rs.html

Configures whether the window should be anchored to a specific edge.

```rust
fn set_anchor(&self, edge: Edge, anchor_to_edge: bool) {
    crate::auto::functions::set_anchor(self, edge, anchor_to_edge);
}
```

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

### GTK_LAYER_SHELL_LAYER_ENTRY_NUMBER

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/constant.GTK_LAYER_SHELL_LAYER_ENTRY_NUMBER.html

The constant defines the layer value for the entry layer, which is set to 4.

```APIDOC
## Constant: GTK_LAYER_SHELL_LAYER_ENTRY_NUMBER

### Description
Represents the layer index for the entry layer in the GTK Layer Shell system.

### Value
`4`

### Type
`GtkLayerShellLayer`
```

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

### gtk_layer_auto_exclusive_zone_enable function signature

Source: https://docs.rs/gtk4-layer-shell-sys/0.6.0/gtk4_layer_shell_sys/fn.gtk_layer_auto_exclusive_zone_enable.html

The function signature for enabling the auto exclusive zone on a GtkWindow.

```rust
pub unsafe extern "C" fn gtk_layer_auto_exclusive_zone_enable(
    window: *mut GtkWindow,
)
```

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

### Layer Enumeration Definition

Source: https://docs.rs/gtk4-layer-shell/latest/src/gtk4_layer_shell/auto/enums.rs.html

Defines the available layers for the layer shell protocol.

```rust
123#[derive(Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
124#[derive(Clone, Copy)]
125#[non_exhaustive]
126#[doc(alias = "GtkLayerShellLayer")]
127pub enum Layer {
128    /// The background layer.
129    #[doc(alias = "GTK_LAYER_SHELL_LAYER_BACKGROUND")]
130    Background,
131    /// The bottom layer.
132    #[doc(alias = "GTK_LAYER_SHELL_LAYER_BOTTOM")]
133    Bottom,
134    /// The top layer.
135    #[doc(alias = "GTK_LAYER_SHELL_LAYER_TOP")]
136    Top,
137    /// The overlay layer.

```
Tokens:
Raw