layer_surface.h File Reference

#include <stdbool.h>
#include <stdint.h>
#include "wlclient.h"
#include "wlr-layer-shell-unstable-v1-client-protocol.h"

Include dependency graph for layer_surface.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct _wlmcl_layer_surface_t	wlmcl_layer_surface_t

Functions
bool	wlmcl_layer_shell_register (wlmcl_client_t *wlclient_ptr, struct zwlr_layer_shell_v1 **layer_shell_ptr_ptr)
wlmcl_layer_surface_t *	wlmcl_layer_surface_create (struct zwlr_layer_shell_v1 *layer_shell_ptr, wlmcl_client_t *wlclient_ptr, uint32_t layer, const char *namespace_ptr)
void	wlmcl_layer_surface_destroy (wlmcl_layer_surface_t *layer_surface_ptr)
struct wl_surface *	wlmcl_layer_surface_wl_surface (wlmcl_layer_surface_t *layer_surface_ptr)
struct zwlr_layer_surface_v1 *	wlmcl_layer_surface_wlr_layer_surface (wlmcl_layer_surface_t *layer_surface_ptr)
void	wlmcl_layer_surface_register_configure_callback (wlmcl_layer_surface_t *layer_surface_ptr, void(*callback)(void *ud_ptr, uint32_t width, uint32_t height), void *ud_ptr)

Detailed Description

Copyright

Copyright (c) 2026 Philipp Kaeser (kaese.nosp@m.r@gu.nosp@m.bbe.c.nosp@m.h) Copyright 2026 Google LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Typedef Documentation

wlmcl_layer_surface_t

typedef struct _wlmcl_layer_surface_t wlmcl_layer_surface_t

Forward declaration: State of the layer surface.

Function Documentation

wlmcl_layer_shell_register()

bool wlmcl_layer_shell_register	(	wlmcl_client_t *	wlclient_ptr,
		struct zwlr_layer_shell_v1 **	layer_shell_ptr_ptr
	)

Registers the layer shell interface with the client.

Parameters

wlclient_ptr
layer_shell_ptr_ptr

Returns

true on success.

wlmcl_layer_surface_create()

wlmcl_layer_surface_t * wlmcl_layer_surface_create	(	struct zwlr_layer_shell_v1 *	layer_shell_ptr,
		wlmcl_client_t *	wlclient_ptr,
		uint32_t	layer,
		const char *	namespace_ptr
	)

Creates a layer surface.

Parameters

layer_shell_ptr
wlclient_ptr
layer	One of zwlr_layer_shell_v1_layer.
namespace_ptr	Namespace string.

Returns

State of the layer surface or NULL on error.

wlmcl_layer_surface_destroy()

void wlmcl_layer_surface_destroy

(

wlmcl_layer_surface_t *

layer_surface_ptr

)

Destroys the layer surface.

Parameters

layer_surface_ptr

wlmcl_layer_surface_register_configure_callback()

void wlmcl_layer_surface_register_configure_callback	(	wlmcl_layer_surface_t *	layer_surface_ptr,
		void(*)(void *ud_ptr, uint32_t width, uint32_t height)	callback,
		void *	ud_ptr
	)

Registers the callback to notify when the layer surface size/layout is determined or updated.

Parameters

layer_surface_ptr
callback
ud_ptr

wlmcl_layer_surface_wl_surface()

struct wl_surface * wlmcl_layer_surface_wl_surface

(

wlmcl_layer_surface_t *

layer_surface_ptr

)

Returns

wlmcl_layer_surface_t::wl_surface_ptr.

wlmcl_layer_surface_wlr_layer_surface()

struct zwlr_layer_surface_v1 * wlmcl_layer_surface_wlr_layer_surface

(

wlmcl_layer_surface_t *

layer_surface_ptr

)

Returns

wlmcl_layer_surface_t::layer_surface_ptr.