| 1 | /* |
|---|
| 2 | * Copyright © 2012 Intel Corporation |
|---|
| 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 WAYLAND_CURSOR_H |
|---|
| 27 | #define WAYLAND_CURSOR_H |
|---|
| 28 | |
|---|
| 29 | #include <stdint.h> |
|---|
| 30 | |
|---|
| 31 | #ifdef __cplusplus |
|---|
| 32 | extern "C" { |
|---|
| 33 | #endif |
|---|
| 34 | |
|---|
| 35 | struct wl_cursor_theme; |
|---|
| 36 | struct wl_buffer; |
|---|
| 37 | struct wl_shm; |
|---|
| 38 | |
|---|
| 39 | /** A still image part of a cursor |
|---|
| 40 | * |
|---|
| 41 | * Use `wl_cursor_image_get_buffer()` to get the corresponding `struct |
|---|
| 42 | * wl_buffer` to attach to your `struct wl_surface`. */ |
|---|
| 43 | struct wl_cursor_image { |
|---|
| 44 | /** Actual width */ |
|---|
| 45 | uint32_t width; |
|---|
| 46 | |
|---|
| 47 | /** Actual height */ |
|---|
| 48 | uint32_t height; |
|---|
| 49 | |
|---|
| 50 | /** Hot spot x (must be inside image) */ |
|---|
| 51 | uint32_t hotspot_x; |
|---|
| 52 | |
|---|
| 53 | /** Hot spot y (must be inside image) */ |
|---|
| 54 | uint32_t hotspot_y; |
|---|
| 55 | |
|---|
| 56 | /** Animation delay to next frame (ms) */ |
|---|
| 57 | uint32_t delay; |
|---|
| 58 | }; |
|---|
| 59 | |
|---|
| 60 | /** A cursor, as returned by `wl_cursor_theme_get_cursor()` */ |
|---|
| 61 | struct wl_cursor { |
|---|
| 62 | /** How many images there are in this cursor’s animation */ |
|---|
| 63 | unsigned int image_count; |
|---|
| 64 | |
|---|
| 65 | /** The array of still images composing this animation */ |
|---|
| 66 | struct wl_cursor_image **images; |
|---|
| 67 | |
|---|
| 68 | /** The name of this cursor */ |
|---|
| 69 | char *name; |
|---|
| 70 | }; |
|---|
| 71 | |
|---|
| 72 | struct wl_cursor_theme * |
|---|
| 73 | wl_cursor_theme_load(const char *name, int size, struct wl_shm *shm); |
|---|
| 74 | |
|---|
| 75 | void |
|---|
| 76 | wl_cursor_theme_destroy(struct wl_cursor_theme *theme); |
|---|
| 77 | |
|---|
| 78 | struct wl_cursor * |
|---|
| 79 | wl_cursor_theme_get_cursor(struct wl_cursor_theme *theme, |
|---|
| 80 | const char *name); |
|---|
| 81 | |
|---|
| 82 | struct wl_buffer * |
|---|
| 83 | wl_cursor_image_get_buffer(struct wl_cursor_image *image); |
|---|
| 84 | |
|---|
| 85 | int |
|---|
| 86 | wl_cursor_frame(struct wl_cursor *cursor, uint32_t time); |
|---|
| 87 | |
|---|
| 88 | int |
|---|
| 89 | wl_cursor_frame_and_duration(struct wl_cursor *cursor, uint32_t time, |
|---|
| 90 | uint32_t *duration); |
|---|
| 91 | |
|---|
| 92 | #ifdef __cplusplus |
|---|
| 93 | } |
|---|
| 94 | #endif |
|---|
| 95 | |
|---|
| 96 | #endif |
|---|
| 97 | |
|---|
