xref: /aosp_15_r20/external/wayland/cursor/xcursor.h (revision 84e872a0dc482bffdb63672969dd03a827d67c73)
1 /*
2  * Copyright © 2002 Keith Packard
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining
5  * a copy of this software and associated documentation files (the
6  * "Software"), to deal in the Software without restriction, including
7  * without limitation the rights to use, copy, modify, merge, publish,
8  * distribute, sublicense, and/or sell copies of the Software, and to
9  * permit persons to whom the Software is furnished to do so, subject to
10  * the following conditions:
11  *
12  * The above copyright notice and this permission notice (including the
13  * next paragraph) shall be included in all copies or substantial
14  * portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
20  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23  * SOFTWARE.
24  */
25 
26 #ifndef XCURSOR_H
27 #define XCURSOR_H
28 
29 #include <stdint.h>
30 
31 struct xcursor_image {
32 	uint32_t version; /* version of the image data */
33 	uint32_t size; /* nominal size for matching */
34 	uint32_t width; /* actual width */
35 	uint32_t height; /* actual height */
36 	uint32_t xhot; /* hot spot x (must be inside image) */
37 	uint32_t yhot; /* hot spot y (must be inside image) */
38 	uint32_t delay; /* animation delay to next frame (ms) */
39 	uint32_t *pixels; /* pointer to pixels */
40 };
41 
42 /*
43  * Other data structures exposed by the library API
44  */
45 struct xcursor_images {
46 	int nimage; /* number of images */
47 	struct xcursor_image **images; /* array of XcursorImage pointers */
48 	char *name; /* name used to load images */
49 };
50 
51 void
52 xcursor_images_destroy(struct xcursor_images *images);
53 
54 void
55 xcursor_load_theme(const char *theme, int size,
56 		   void (*load_callback)(struct xcursor_images *, void *),
57 		   void *user_data);
58 #endif
59