clients/window.h

   1 /*
   2  * Copyright © 2008 Kristian Høgsberg
   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 _WINDOW_H_
  24 #define _WINDOW_H_
  25
  26 #include <glib.h>
  27 #include <wayland-client.h>
  28
  29 struct window;
  30
  31 struct rectangle {
  32         int32_t x;
  33         int32_t y;
  34         int32_t width;
  35         int32_t height;
  36 };
  37
  38 struct display;
  39 struct input;
  40
  41 struct display *
  42 display_create(int *argc, char **argv[], const GOptionEntry *option_entries);
  43
  44 struct wl_display *
  45 display_get_display(struct display *display);
  46
  47 struct wl_compositor *
  48 display_get_compositor(struct display *display);
  49
  50 #ifdef EGL_NO_DISPLAY
  51 EGLDisplay
  52 display_get_egl_display(struct display *d);
  53
  54 #ifdef HAVE_CAIRO_EGL
  55 EGLImageKHR
  56 display_get_image_for_drm_surface(struct display *display,
  57                                   cairo_surface_t *surface);
  58 #endif
  59 #endif
  60
  61 cairo_surface_t *
  62 display_create_surface(struct display *display,
  63                        struct rectangle *rectangle);
  64
  65 struct wl_buffer *
  66 display_get_buffer_for_surface(struct display *display,
  67                                cairo_surface_t *surface);
  68
  69 cairo_surface_t *
  70 display_get_pointer_surface(struct display *display, int pointer,
  71                             int *width, int *height,
  72                             int *hotspot_x, int *hotspot_y);
  73
  74 void
  75 display_add_drag_listener(struct display *display,
  76                           const struct wl_drag_listener *drag_listener,
  77                           void *data);
  78
  79 void
  80 display_flush_cairo_device(struct display *display);
  81
  82 void
  83 display_run(struct display *d);
  84
  85 enum {
  86         WINDOW_MODIFIER_SHIFT = 0x01,
  87         WINDOW_MODIFIER_LOCK = 0x02,
  88         WINDOW_MODIFIER_CONTROL = 0x04,
  89         WINDOW_MODIFIER_ALT = 0x08,
  90         WINDOW_MODIFIER_MOD2 = 0x10,
  91 };
  92
  93 enum pointer_type {
  94         POINTER_BOTTOM_LEFT,
  95         POINTER_BOTTOM_RIGHT,
  96         POINTER_BOTTOM,
  97         POINTER_DRAGGING,
  98         POINTER_LEFT_PTR,
  99         POINTER_LEFT,
 100         POINTER_RIGHT,
 101         POINTER_TOP_LEFT,
 102         POINTER_TOP_RIGHT,
 103         POINTER_TOP,
 104         POINTER_IBEAM,
 105         POINTER_HAND1,
 106 };
 107
 108 typedef void (*window_resize_handler_t)(struct window *window,
 109                                         int32_t width, int32_t height,
 110                                         void *data);
 111 typedef void (*window_redraw_handler_t)(struct window *window, void *data);
 112 typedef void (*window_frame_handler_t)(struct window *window, uint32_t frame, uint32_t timestamp, void *data);
 113 typedef void (*window_key_handler_t)(struct window *window, uint32_t key, uint32_t unicode,
 114                                      uint32_t state, uint32_t modifiers, void *data);
 115 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
 116                                                 struct input *device, void *data);
 117
 118 typedef void (*window_button_handler_t)(struct window *window,
 119                                         struct input *input, uint32_t time,
 120                                         int button, int state, void *data);
 121
 122 typedef int (*window_motion_handler_t)(struct window *window,
 123                                        struct input *input, uint32_t time,
 124                                        int32_t x, int32_t y,
 125                                        int32_t sx, int32_t sy, void *data);
 126
 127 typedef void (*display_drag_offer_handler_t)(struct wl_drag_offer *offer,
 128                                              struct display *display);
 129
 130 typedef void (*display_global_handler_t)(struct display *display,
 131                                          const char *interface,
 132                                          uint32_t version);
 133
 134 struct window *
 135 window_create(struct display *display, const char *title,
 136               int32_t width, int32_t height);
 137
 138 void
 139 window_move(struct window *window, struct input *input, uint32_t time);
 140
 141 void
 142 window_draw(struct window *window);
 143 void
 144 window_get_child_allocation(struct window *window,
 145                             struct rectangle *allocation);
 146 void
 147 window_set_child_size(struct window *window, int32_t width, int32_t height);
 148 void
 149 window_copy_image(struct window *window,
 150                   struct rectangle *rectangle,
 151                   void *image);
 152 void
 153 window_schedule_redraw(struct window *window);
 154
 155 void
 156 window_damage(struct window *window, int32_t x, int32_t y,
 157               int32_t width, int32_t height);
 158
 159 cairo_surface_t *
 160 window_get_surface(struct window *window);
 161
 162 void
 163 window_copy_surface(struct window *window,
 164                     struct rectangle *rectangle,
 165                     cairo_surface_t *surface);
 166
 167 void
 168 window_flush(struct window *window);
 169
 170 void
 171 window_set_surface(struct window *window, cairo_surface_t *surface);
 172
 173 void
 174 window_create_surface(struct window *window);
 175
 176 enum window_buffer_type {
 177         WINDOW_BUFFER_TYPE_DRM,
 178         WINDOW_BUFFER_TYPE_SHM,
 179 };
 180
 181 void
 182 window_set_buffer_type(struct window *window, enum window_buffer_type type);
 183
 184 void
 185 window_set_fullscreen(struct window *window, int fullscreen);
 186
 187 void
 188 window_set_user_data(struct window *window, void *data);
 189
 190 void *
 191 window_get_user_data(struct window *window);
 192
 193 void
 194 window_set_redraw_handler(struct window *window,
 195                           window_redraw_handler_t handler);
 196
 197 void
 198 window_set_decoration(struct window *window, int decoration);
 199
 200 void
 201 window_set_resize_handler(struct window *window,
 202                           window_resize_handler_t handler);
 203 void
 204 window_set_frame_handler(struct window *window,
 205                          window_frame_handler_t handler);
 206
 207 void
 208 window_set_key_handler(struct window *window,
 209                        window_key_handler_t handler);
 210
 211 void
 212 window_set_button_handler(struct window *window,
 213                           window_button_handler_t handler);
 214
 215 void
 216 window_set_motion_handler(struct window *window,
 217                           window_motion_handler_t handler);
 218
 219 void
 220 window_set_keyboard_focus_handler(struct window *window,
 221                                   window_keyboard_focus_handler_t handler);
 222
 223 void
 224 window_set_frame_handler(struct window *window,
 225                          window_frame_handler_t handler);
 226
 227 void
 228 display_set_drag_offer_handler(struct display *display,
 229                                display_drag_offer_handler_t handler);
 230
 231 void
 232 display_set_global_handler(struct display *display,
 233                            display_global_handler_t handler);
 234
 235 struct wl_drag *
 236 window_create_drag(struct window *window);
 237
 238 void
 239 window_activate_drag(struct wl_drag *drag, struct window *window,
 240                      struct input *input, uint32_t time);
 241
 242 void
 243 input_get_position(struct input *input, int32_t *x, int32_t *y);
 244
 245 struct wl_input_device *
 246 input_get_input_device(struct input *input);
 247
 248 #endif