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_global_handler_t)(struct display *display,
 128                                          const char *interface,
 129                                          uint32_t id,
 130                                          uint32_t version);
 131
 132 struct window *
 133 window_create(struct display *display, const char *title,
 134               int32_t width, int32_t height);
 135
 136 void
 137 window_move(struct window *window, struct input *input, uint32_t time);
 138
 139 void
 140 window_draw(struct window *window);
 141 void
 142 window_get_child_allocation(struct window *window,
 143                             struct rectangle *allocation);
 144 void
 145 window_set_child_size(struct window *window, int32_t width, int32_t height);
 146 void
 147 window_copy_image(struct window *window,
 148                   struct rectangle *rectangle,
 149                   void *image);
 150 void
 151 window_schedule_redraw(struct window *window);
 152
 153 void
 154 window_damage(struct window *window, int32_t x, int32_t y,
 155               int32_t width, int32_t height);
 156
 157 cairo_surface_t *
 158 window_get_surface(struct window *window);
 159
 160 void
 161 window_copy_surface(struct window *window,
 162                     struct rectangle *rectangle,
 163                     cairo_surface_t *surface);
 164
 165 void
 166 window_flush(struct window *window);
 167
 168 void
 169 window_set_surface(struct window *window, cairo_surface_t *surface);
 170
 171 void
 172 window_create_surface(struct window *window);
 173
 174 enum window_buffer_type {
 175         WINDOW_BUFFER_TYPE_DRM,
 176         WINDOW_BUFFER_TYPE_SHM,
 177 };
 178
 179 void
 180 window_set_buffer_type(struct window *window, enum window_buffer_type type);
 181
 182 void
 183 window_set_fullscreen(struct window *window, int fullscreen);
 184
 185 void
 186 window_set_user_data(struct window *window, void *data);
 187
 188 void *
 189 window_get_user_data(struct window *window);
 190
 191 void
 192 window_set_redraw_handler(struct window *window,
 193                           window_redraw_handler_t handler);
 194
 195 void
 196 window_set_decoration(struct window *window, int decoration);
 197
 198 void
 199 window_set_resize_handler(struct window *window,
 200                           window_resize_handler_t handler);
 201 void
 202 window_set_frame_handler(struct window *window,
 203                          window_frame_handler_t handler);
 204
 205 void
 206 window_set_key_handler(struct window *window,
 207                        window_key_handler_t handler);
 208
 209 void
 210 window_set_button_handler(struct window *window,
 211                           window_button_handler_t handler);
 212
 213 void
 214 window_set_motion_handler(struct window *window,
 215                           window_motion_handler_t handler);
 216
 217 void
 218 window_set_keyboard_focus_handler(struct window *window,
 219                                   window_keyboard_focus_handler_t handler);
 220
 221 void
 222 window_set_frame_handler(struct window *window,
 223                          window_frame_handler_t handler);
 224
 225 void
 226 display_set_global_handler(struct display *display,
 227                            display_global_handler_t handler);
 228
 229 struct wl_drag *
 230 window_create_drag(struct window *window);
 231
 232 void
 233 window_activate_drag(struct wl_drag *drag, struct window *window,
 234                      struct input *input, uint32_t time);
 235
 236 void
 237 input_get_position(struct input *input, int32_t *x, int32_t *y);
 238
 239 struct wl_input_device *
 240 input_get_input_device(struct input *input);
 241
 242 #endif