wlmaker
Loading...
Searching...
No Matches
icon.h File Reference
#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.

Typedefs

typedef bool(* wlclient_icon_gfxbuf_callback_t) (wlclient_icon_t *icon_ptr, bs_gfxbuf_t *gfxbuf_ptr, void *ud_ptr)
 

Functions

wlclient_icon_twlclient_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_callback_when_ready (wlclient_icon_t *icon_ptr, wlclient_icon_gfxbuf_callback_t callback, void *ud_ptr)
 

Detailed Description

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

◆ wlclient_icon_gfxbuf_callback_t

typedef bool(* wlclient_icon_gfxbuf_callback_t) (wlclient_icon_t *icon_ptr, bs_gfxbuf_t *gfxbuf_ptr, void *ud_ptr)

Type of the callback for wlclient_icon_callback_when_ready.

Parameters
icon_ptr
gfxbuf_ptr
ud_ptr

Function Documentation

◆ wlclient_icon_callback_when_ready()

void wlclient_icon_callback_when_ready ( wlclient_icon_t * icon_ptr,
wlclient_icon_gfxbuf_callback_t callback,
void * ud_ptr )

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

If the background buffer is already ready, the callback will get executed right away. Otherwise, the callback will be registered for the icon, and executed as the background buffer becomes available.

The callback will be invoked once only. If repeated calls are desired, the callee should call wlclient_icon_callback_when_ready again from within the callback method.

Only one callback may be active at any time. Any further invocation will replace the already-registered callback. To unregister a callback, call the function with callback == NULL.

Parameters
icon_ptr
callback
ud_ptr

◆ 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_supported()

bool wlclient_icon_supported ( wlclient_t * wlclient_ptr)

Returns whether the icon protocol is supported on the client.

Parameters
wlclient_ptr