icon.h File Reference

#include <libbase/libbase.h>
#include <stdbool.h>
#include "libwlclient.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.

Functions
wlclient_icon_t *	wlclient_icon_create (wlclient_t *wlclient_ptr)
void	wlclient_icon_destroy (wlclient_icon_t *icon_ptr)
bool	wlclient_icon_supported (wlclient_t *wlclient_ptr)
void	wlclient_icon_register_ready_callback (wlclient_icon_t *icon_ptr, bool(*callback)(bs_gfxbuf_t *gfxbuf_ptr, void *ud_ptr), void *ud_ptr)
void	wlclient_icon_register_position_callback (wlclient_icon_t *icon_ptr, void(*callback)(double x, double y, void *ud_ptr), void *callback_ud_ptr)

Detailed Description

Copyright

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.

Function Documentation

wlclient_icon_create()

wlclient_icon_t * wlclient_icon_create

(

wlclient_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 wlclient_icon_destroy.

wlclient_icon_destroy()

void wlclient_icon_destroy

(

wlclient_icon_t *

icon_ptr

)

Destroys the icon.

Parameters

icon_ptr

wlclient_icon_register_position_callback()

void wlclient_icon_register_position_callback	(	wlclient_icon_t *	icon_ptr,
		void(*	callback )(double x, double y, void *ud_ptr),
		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

wlclient_icon_register_ready_callback()

void wlclient_icon_register_ready_callback	(	wlclient_icon_t *	icon_ptr,
		bool(*	callback )(bs_gfxbuf_t *gfxbuf_ptr, void *ud_ptr),
		void *	ud_ptr )

Sets a callback to invoke when the background buffer is ready for drawing.

See also

wlcl_dblbuf_register_ready_callback.

Parameters

icon_ptr
callback
ud_ptr

wlclient_icon_supported()

bool wlclient_icon_supported

(

wlclient_t *

wlclient_ptr

)

Returns whether the icon protocol is supported on the client.

Parameters

wlclient_ptr