mirror of
https://gitlab.freedesktop.org/wayland/wayland.git
synced 2025-10-29 05:40:16 -04:00
cursor: Properly document wl_cursor_image and wl_cursor
Signed-off-by: Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
This commit is contained in:
parent
95a3272625
commit
c81cbae3f2
1 changed files with 24 additions and 5 deletions
|
|
@ -36,17 +36,36 @@ struct wl_cursor_theme;
|
||||||
struct wl_buffer;
|
struct wl_buffer;
|
||||||
struct wl_shm;
|
struct wl_shm;
|
||||||
|
|
||||||
|
/** A still image part of a cursor
|
||||||
|
*
|
||||||
|
* Use `wl_cursor_image_get_buffer()` to get the corresponding `struct
|
||||||
|
* wl_buffer` to attach to your `struct wl_surface`. */
|
||||||
struct wl_cursor_image {
|
struct wl_cursor_image {
|
||||||
uint32_t width; /* actual width */
|
/** Actual width */
|
||||||
uint32_t height; /* actual height */
|
uint32_t width;
|
||||||
uint32_t hotspot_x; /* hot spot x (must be inside image) */
|
|
||||||
uint32_t hotspot_y; /* hot spot y (must be inside image) */
|
/** Actual height */
|
||||||
uint32_t delay; /* animation delay to next frame (ms) */
|
uint32_t height;
|
||||||
|
|
||||||
|
/** Hot spot x (must be inside image) */
|
||||||
|
uint32_t hotspot_x;
|
||||||
|
|
||||||
|
/** Hot spot y (must be inside image) */
|
||||||
|
uint32_t hotspot_y;
|
||||||
|
|
||||||
|
/** Animation delay to next frame (ms) */
|
||||||
|
uint32_t delay;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/** A cursor, as returned by `wl_cursor_theme_get_cursor()` */
|
||||||
struct wl_cursor {
|
struct wl_cursor {
|
||||||
|
/** How many images there are in this cursor’s animation */
|
||||||
unsigned int image_count;
|
unsigned int image_count;
|
||||||
|
|
||||||
|
/** The array of still images composing this animation */
|
||||||
struct wl_cursor_image **images;
|
struct wl_cursor_image **images;
|
||||||
|
|
||||||
|
/** The name of this cursor */
|
||||||
char *name;
|
char *name;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue