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 EGLImageKHR
  55 display_get_image_for_drm_surface(struct display *display,
  56                                   cairo_surface_t *surface);
  57 #endif
  58
  59 cairo_surface_t *
  60 display_create_surface(struct display *display,
  61                        struct rectangle *rectangle);
  62
  63 struct wl_buffer *
  64 display_get_buffer_for_surface(struct display *display,
  65                                cairo_surface_t *surface);
  66
  67 cairo_surface_t *
  68 display_get_pointer_surface(struct display *display, int pointer,
  69                             int *width, int *height,
  70                             int *hotspot_x, int *hotspot_y);
  71
  72 void
  73 display_add_drag_listener(struct display *display,
  74                           const struct wl_drag_listener *drag_listener,
  75                           void *data);
  76
  77 void
  78 display_flush_cairo_device(struct display *display);
  79
  80 void
  81 display_run(struct display *d);
  82
  83 enum {
  84         WINDOW_MODIFIER_SHIFT = 0x01,
  85         WINDOW_MODIFIER_LOCK = 0x02,
  86         WINDOW_MODIFIER_CONTROL = 0x04,
  87         WINDOW_MODIFIER_ALT = 0x08,
  88         WINDOW_MODIFIER_MOD2 = 0x10,
  89 };
  90
  91 enum pointer_type {
  92         POINTER_BOTTOM_LEFT,
  93         POINTER_BOTTOM_RIGHT,
  94         POINTER_BOTTOM,
  95         POINTER_DRAGGING,
  96         POINTER_LEFT_PTR,
  97         POINTER_LEFT,
  98         POINTER_RIGHT,
  99         POINTER_TOP_LEFT,
 100         POINTER_TOP_RIGHT,
 101         POINTER_TOP,
 102         POINTER_IBEAM,
 103         POINTER_HAND1,
 104 };
 105
 106 typedef void (*window_resize_handler_t)(struct window *window, void *data);
 107 typedef void (*window_redraw_handler_t)(struct window *window, void *data);
 108 typedef void (*window_frame_handler_t)(struct window *window, uint32_t frame, uint32_t timestamp, void *data);
 109 typedef void (*window_key_handler_t)(struct window *window, uint32_t key, uint32_t unicode,
 110                                      uint32_t state, uint32_t modifiers, void *data);
 111 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
 112                                                 struct input *device, void *data);
 113
 114 typedef void (*window_button_handler_t)(struct window *window,
 115                                         struct input *input, uint32_t time,
 116                                         int button, int state, void *data);
 117
 118 typedef int (*window_motion_handler_t)(struct window *window,
 119                                        struct input *input, uint32_t time,
 120                                        int32_t x, int32_t y,
 121                                        int32_t sx, int32_t sy, void *data);
 122
 123 typedef void (*display_drag_offer_handler_t)(struct wl_drag_offer *offer,
 124                                              struct display *display);
 125
 126 struct window *
 127 window_create(struct display *display, const char *title,
 128               int32_t width, int32_t height);
 129
 130 void
 131 window_move(struct window *window, struct input *input, uint32_t time);
 132
 133 void
 134 window_draw(struct window *window);
 135 void
 136 window_get_child_rectangle(struct window *window,
 137                            struct rectangle *rectangle);
 138 void
 139 window_set_child_size(struct window *window,
 140                       struct rectangle *rectangle);
 141 void
 142 window_copy_image(struct window *window,
 143                   struct rectangle *rectangle,
 144                   void *image);
 145 void
 146 window_schedule_redraw(struct window *window);
 147
 148 void
 149 window_damage(struct window *window, int32_t x, int32_t y,
 150               int32_t width, int32_t height);
 151
 152 cairo_surface_t *
 153 window_get_surface(struct window *window);
 154
 155 void
 156 window_copy_surface(struct window *window,
 157                     struct rectangle *rectangle,
 158                     cairo_surface_t *surface);
 159
 160 void
 161 window_flush(struct window *window);
 162
 163 void
 164 window_set_surface(struct window *window, cairo_surface_t *surface);
 165
 166 void
 167 window_create_surface(struct window *window);
 168
 169 enum window_buffer_type {
 170         WINDOW_BUFFER_TYPE_DRM,
 171         WINDOW_BUFFER_TYPE_SHM,
 172 };
 173
 174 void
 175 window_set_buffer_type(struct window *window, enum window_buffer_type type);
 176
 177 void
 178 window_set_fullscreen(struct window *window, int fullscreen);
 179
 180 void
 181 window_set_user_data(struct window *window, void *data);
 182
 183 void *
 184 window_get_user_data(struct window *window);
 185
 186 void
 187 window_set_redraw_handler(struct window *window,
 188                           window_redraw_handler_t handler);
 189
 190 void
 191 window_set_decoration(struct window *window, int decoration);
 192
 193 void
 194 window_set_resize_handler(struct window *window,
 195                           window_resize_handler_t handler);
 196 void
 197 window_set_frame_handler(struct window *window,
 198                          window_frame_handler_t handler);
 199
 200 void
 201 window_set_key_handler(struct window *window,
 202                        window_key_handler_t handler);
 203
 204 void
 205 window_set_button_handler(struct window *window,
 206                           window_button_handler_t handler);
 207
 208 void
 209 window_set_motion_handler(struct window *window,
 210                           window_motion_handler_t handler);
 211
 212 void
 213 window_set_keyboard_focus_handler(struct window *window,
 214                                   window_keyboard_focus_handler_t handler);
 215
 216 void
 217 window_set_frame_handler(struct window *window,
 218                          window_frame_handler_t handler);
 219
 220 void
 221 display_set_drag_offer_handler(struct display *display,
 222                                display_drag_offer_handler_t handler);
 223
 224 struct wl_drag *
 225 window_create_drag(struct window *window);
 226
 227 void
 228 window_activate_drag(struct wl_drag *drag, struct window *window,
 229                      struct input *input, uint32_t time);
 230
 231 void
 232 input_get_position(struct input *input, int32_t *x, int32_t *y);
 233
 234 struct wl_input_device *
 235 input_get_input_device(struct input *input);
 236
 237 #endif