cursor/wayland-cursor.h

   1 /*
   2  * Copyright © 2012 Intel Corporation
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and its
   5  * documentation for any purpose is hereby granted without fee, provided that
   6  * the above copyright notice appear in all copies and that both that copyright
   7  * notice and this permission notice appear in supporting documentation, and
   8  * that the name of the copyright holders not be used in advertising or
   9  * publicity pertaining to distribution of the software without specific,
  10  * written prior permission.  The copyright holders make no representations
  11  * about the suitability of this software for any purpose.  It is provided "as
  12  * is" without express or implied warranty.
  13  *
  14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  15  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  16  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  17  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  18  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  19  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  20  * OF THIS SOFTWARE.
  21  */
  22
  23 #ifndef WAYLAND_CURSOR_H
  24 #define WAYLAND_CURSOR_H
  25
  26 #include <stdint.h>
  27
  28 #ifdef  __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 enum wl_cursor_type {
  33         WL_CURSOR_BOTTOM_LEFT,
  34         WL_CURSOR_BOTTOM_RIGHT,
  35         WL_CURSOR_BOTTOM,
  36         WL_CURSOR_DRAGGING,
  37         WL_CURSOR_LEFT_PTR,
  38         WL_CURSOR_LEFT,
  39         WL_CURSOR_RIGHT,
  40         WL_CURSOR_TOP_LEFT,
  41         WL_CURSOR_TOP_RIGHT,
  42         WL_CURSOR_TOP,
  43         WL_CURSOR_IBEAM,
  44         WL_CURSOR_HAND1,
  45 };
  46
  47 struct wl_cursor_theme;
  48
  49 struct wl_cursor_image {
  50         uint32_t width;         /* actual width */
  51         uint32_t height;        /* actual height */
  52         uint32_t hotspot_x;     /* hot spot x (must be inside image) */
  53         uint32_t hotspot_y;     /* hot spot y (must be inside image) */
  54         uint32_t delay;         /* animation delay to next frame (ms) */
  55 };
  56
  57 struct wl_cursor {
  58         unsigned int image_count;
  59         struct wl_cursor_image **images;
  60         char *name;
  61 };
  62
  63 struct wl_shm;
  64
  65 struct wl_cursor_theme *
  66 wl_cursor_theme_load(const char *name, int size, struct wl_shm *shm);
  67
  68 void
  69 wl_cursor_theme_destroy(struct wl_cursor_theme *theme);
  70
  71 struct wl_cursor *
  72 wl_cursor_theme_get_cursor(struct wl_cursor_theme *theme,
  73                            enum wl_cursor_type type);
  74
  75 struct wl_cursor *
  76 wl_cursor_theme_get_cursor_by_name(struct wl_cursor_theme *theme,
  77                                    const char *name);
  78
  79 struct wl_buffer *
  80 wl_cursor_image_get_buffer(struct wl_cursor_image *image);
  81
  82 #ifdef  __cplusplus
  83 }
  84 #endif
  85
  86 #endif