AcoSail/wayland
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

shm: document wl_shm_buffer

Browse Source 
The main motivation is to make it clear when a wl_shm_buffer is
destroyed.

Signed-off-by: Simon Ser <contact@emersion.fr>
This commit is contained in:
Simon Ser 2021-07-13 15:52:31 +02:00
parent b7153f2273
commit 8899310fc8
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/wayland-shm.c
View File

@ -66,6 +66,15 @@ struct wl_shm_pool {
bool sigbus_is_impossible; bool sigbus_is_impossible;
}; };
/** \class wl_shm_buffer
*
* \brief A SHM buffer
*
* wl_shm_buffer provides a helper for accessing the contents of a wl_buffer
* resource created via the wl_shm interface.
*
* A wl_shm_buffer becomes invalid as soon as its #wl_resource is destroyed.
*/
struct wl_shm_buffer { struct wl_shm_buffer {
struct wl_resource *resource; struct wl_resource *resource;
int32_t width, height; int32_t width, height;