icon.h File Reference

#include <stdbool.h>
#include <stdint.h>
#include "wlclient.h"

Include dependency graph for icon.h:

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

Go to the source code of this file.

Typedefs
typedef struct _wlmcl_icon_t	wlmcl_icon_t

Functions
wlmcl_icon_t *	wlmcl_icon_create (wlmcl_client_t *wlclient_ptr)
void	wlmcl_icon_destroy (wlmcl_icon_t *icon_ptr)
bool	wlmcl_icon_supported (wlmcl_client_t *wlclient_ptr)
struct wl_surface *	wlmcl_icon_wl_surface (wlmcl_icon_t *icon_ptr)
void	wlmcl_icon_register_configure_callback (wlmcl_icon_t *icon_ptr, void(*callback)(void *ud_ptr, uint32_t width, uint32_t height), void *ud_ptr)
void	wlmcl_icon_register_position_callback (wlmcl_icon_t *icon_ptr, void(*callback)(double x, double y, void *ud_ptr), void *callback_ud_ptr)

Detailed Description

Copyright

Copyright (c) 2026 Philipp Kaeser (kaese.nosp@m.r@gu.nosp@m.bbe.c.nosp@m.h) Copyright 2023 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_icon_t

typedef struct _wlmcl_icon_t wlmcl_icon_t

Forward declaration of an icon's state.

Function Documentation

wlmcl_icon_create()

wlmcl_icon_t * wlmcl_icon_create

(

wlmcl_client_t *

wlclient_ptr

)

Creates an icon.

Parameters

wlclient_ptr

Returns

An icon state or NULL on error. The state must be free'd by calling wlmcl_icon_destroy.

wlmcl_icon_destroy()

void wlmcl_icon_destroy

(

wlmcl_icon_t *

icon_ptr

)

Destroys the icon.

Parameters

icon_ptr

wlmcl_icon_register_configure_callback()

void wlmcl_icon_register_configure_callback	(	wlmcl_icon_t *	icon_ptr,
		void(*)(void *ud_ptr, uint32_t width, uint32_t height)	callback,
		void *	ud_ptr
	)

Registers the callback to notify when the icon size is determined or updated.

Parameters

icon_ptr
callback
ud_ptr

wlmcl_icon_register_position_callback()

void wlmcl_icon_register_position_callback	(	wlmcl_icon_t *	icon_ptr,
		void(*)(double x, double y, void *ud_ptr)	callback,
		void *	callback_ud_ptr
	)

Registers the callback to notify the pointer position relative to the icon's surface.

Parameters

icon_ptr
callback
callback_ud_ptr

wlmcl_icon_supported()

bool wlmcl_icon_supported

(

wlmcl_client_t *

wlclient_ptr

)

Returns whether the icon protocol is supported on the client.

Parameters

wlclient_ptr

wlmcl_icon_wl_surface()

struct wl_surface * wlmcl_icon_wl_surface

(

wlmcl_icon_t *

icon_ptr

)

Returns the underlying Wayland surface of the icon.

Parameters

icon_ptr

Returns

The wl_surface pointer.