blob: e9d717b4078441cf0b64d01bb51b4b55a4d63278 [file] [log] [blame]
Kristian Høgsberg0c4457f2008-12-07 19:59:11 -05001/*
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
Kristian Høgsberg23c03ad2011-01-19 14:41:20 -050026#include <X11/extensions/XKBcommon.h>
Fred Morcosc4b8c452010-11-28 19:31:55 +010027#include <glib.h>
28#include <wayland-client.h>
Benjamin Franzkecff904e2011-02-18 23:00:55 +010029#include <cairo.h>
Fred Morcosc4b8c452010-11-28 19:31:55 +010030
Kristian Høgsberg0c4457f2008-12-07 19:59:11 -050031struct window;
Kristian Høgsbergc51f7992012-01-08 15:09:53 -050032struct widget;
Kristian Høgsberge28d05b2011-09-20 21:43:54 -040033struct display;
34struct input;
Kristian Høgsberg53ff2f62011-11-26 17:27:37 -050035struct output;
Kristian Høgsberg0c4457f2008-12-07 19:59:11 -050036
Kristian Høgsberg3a696272011-09-14 17:33:48 -040037struct task {
38 void (*run)(struct task *task, uint32_t events);
39 struct wl_list link;
40};
41
Kristian Høgsberg0c4457f2008-12-07 19:59:11 -050042struct rectangle {
43 int32_t x;
44 int32_t y;
45 int32_t width;
46 int32_t height;
47};
48
Kristian Høgsberg43c28ee2009-01-26 23:42:46 -050049struct display *
Kristian Høgsberg9de79a92011-08-24 11:09:53 -040050display_create(int *argc, char **argv[], const GOptionEntry *option_entries);
Kristian Høgsberg7824d812010-06-08 14:59:44 -040051
Pekka Paalanen999c5b52011-11-30 10:52:38 +020052void
Pekka Paalanenfe6079a2011-12-15 15:20:04 +020053display_destroy(struct display *display);
54
55void
Pekka Paalanen999c5b52011-11-30 10:52:38 +020056display_set_user_data(struct display *display, void *data);
57
58void *
59display_get_user_data(struct display *display);
60
Kristian Høgsberg9d69f8e2010-09-03 14:46:38 -040061struct wl_display *
62display_get_display(struct display *display);
63
Kristian Høgsberg43c28ee2009-01-26 23:42:46 -050064struct wl_compositor *
65display_get_compositor(struct display *display);
66
Kristian Høgsberg58eec362011-01-19 14:27:42 -050067struct wl_shell *
68display_get_shell(struct display *display);
69
Kristian Høgsberg53ff2f62011-11-26 17:27:37 -050070struct output *
71display_get_output(struct display *display);
72
Pekka Paalanen999c5b52011-11-30 10:52:38 +020073typedef void (*display_output_handler_t)(struct output *output, void *data);
74
75/*
76 * The output configure handler is called, when a new output is connected
77 * and we know its current mode, or when the current mode changes.
78 * Test and set the output user data in your handler to know, if the
79 * output is new. Note: 'data' in the configure handler is the display
80 * user data.
81 */
82void
83display_set_output_configure_handler(struct display *display,
84 display_output_handler_t handler);
85
Kristian Høgsberg47fe08a2011-10-28 12:26:06 -040086struct wl_data_source *
87display_create_data_source(struct display *display);
88
Kristian Høgsberg7824d812010-06-08 14:59:44 -040089#ifdef EGL_NO_DISPLAY
90EGLDisplay
91display_get_egl_display(struct display *d);
Kristian Høgsberg2b43bd72010-11-08 15:45:55 -050092
Benjamin Franzkecff904e2011-02-18 23:00:55 +010093EGLConfig
Benjamin Franzke0c991632011-09-27 21:57:31 +020094display_get_rgb_egl_config(struct display *d);
95
96EGLConfig
97display_get_argb_egl_config(struct display *d);
Benjamin Franzkecff904e2011-02-18 23:00:55 +010098
Benjamin Franzke1a89f282011-10-07 09:33:06 +020099int
Benjamin Franzkecff904e2011-02-18 23:00:55 +0100100display_acquire_window_surface(struct display *display,
101 struct window *window,
102 EGLContext ctx);
103void
Benjamin Franzke0c991632011-09-27 21:57:31 +0200104display_release_window_surface(struct display *display,
105 struct window *window);
Benjamin Franzkecff904e2011-02-18 23:00:55 +0100106
Kristian Høgsberg8def2642011-01-14 17:41:33 -0500107#ifdef HAVE_CAIRO_EGL
Kristian Høgsberg2b43bd72010-11-08 15:45:55 -0500108EGLImageKHR
Kristian Høgsberg297c6312011-02-04 14:11:33 -0500109display_get_image_for_egl_image_surface(struct display *display,
110 cairo_surface_t *surface);
Kristian Høgsberg7824d812010-06-08 14:59:44 -0400111#endif
nobled98354172011-01-05 17:48:15 +0000112#endif
Kristian Høgsberg7824d812010-06-08 14:59:44 -0400113
Kristian Høgsberg3be87d12011-05-13 13:45:17 -0400114#define SURFACE_OPAQUE 0x01
115
Kristian Høgsbergdcb71b62010-06-15 17:16:35 -0400116cairo_surface_t *
117display_create_surface(struct display *display,
Benjamin Franzke6693ac22011-02-10 12:04:30 +0100118 struct wl_surface *surface,
Kristian Høgsberg3be87d12011-05-13 13:45:17 -0400119 struct rectangle *rectangle,
120 uint32_t flags);
Kristian Høgsbergdcb71b62010-06-15 17:16:35 -0400121
Kristian Høgsberg9a686242010-08-18 15:28:04 -0400122struct wl_buffer *
123display_get_buffer_for_surface(struct display *display,
124 cairo_surface_t *surface);
125
126cairo_surface_t *
127display_get_pointer_surface(struct display *display, int pointer,
128 int *width, int *height,
129 int *hotspot_x, int *hotspot_y);
130
Kristian Høgsberg7824d812010-06-08 14:59:44 -0400131void
Kristian Høgsberg3a696272011-09-14 17:33:48 -0400132display_defer(struct display *display, struct task *task);
133
134void
135display_watch_fd(struct display *display,
136 int fd, uint32_t events, struct task *task);
137
138void
Kristian Høgsberg7824d812010-06-08 14:59:44 -0400139display_run(struct display *d);
140
Pekka Paalanen826d7952011-12-15 10:14:07 +0200141void
142display_exit(struct display *d);
143
Kristian Høgsberg9a686242010-08-18 15:28:04 -0400144enum pointer_type {
145 POINTER_BOTTOM_LEFT,
146 POINTER_BOTTOM_RIGHT,
147 POINTER_BOTTOM,
148 POINTER_DRAGGING,
149 POINTER_LEFT_PTR,
150 POINTER_LEFT,
151 POINTER_RIGHT,
152 POINTER_TOP_LEFT,
153 POINTER_TOP_RIGHT,
154 POINTER_TOP,
155 POINTER_IBEAM,
156 POINTER_HAND1,
157};
158
Kristian Høgsberg67cac8a2011-01-19 14:20:33 -0500159typedef void (*window_key_handler_t)(struct window *window, struct input *input,
160 uint32_t time, uint32_t key, uint32_t unicode,
161 uint32_t state, void *data);
Tim Wiederhakedc3f8172011-01-17 17:25:34 +0100162
Kristian Høgsberg3c248cc2009-02-22 23:01:35 -0500163typedef void (*window_keyboard_focus_handler_t)(struct window *window,
Kristian Høgsberg808fd412010-07-20 17:06:19 -0400164 struct input *device, void *data);
Kristian Høgsberg0c4457f2008-12-07 19:59:11 -0500165
Kristian Høgsberg47fe08a2011-10-28 12:26:06 -0400166typedef void (*window_data_handler_t)(struct window *window,
167 struct input *input, uint32_t time,
168 int32_t x, int32_t y,
169 const char **types,
170 void *data);
171
172typedef void (*window_drop_handler_t)(struct window *window,
173 struct input *input,
174 int32_t x, int32_t y, void *data);
175
Kristian Høgsberg4f7dcd62012-01-06 21:59:05 -0500176typedef void (*window_close_handler_t)(struct window *window, void *data);
177
Kristian Høgsbergb67e94b2012-01-10 12:23:19 -0500178typedef void (*widget_resize_handler_t)(struct widget *widget,
179 int32_t width, int32_t height,
180 void *data);
181typedef void (*widget_redraw_handler_t)(struct widget *widget, void *data);
182
Kristian Høgsbergbb901fa2012-01-09 11:22:32 -0500183typedef int (*widget_enter_handler_t)(struct widget *widget,
184 struct input *input, uint32_t time,
185 int32_t x, int32_t y, void *data);
Kristian Høgsbergee143232012-01-09 08:42:24 -0500186typedef void (*widget_leave_handler_t)(struct widget *widget,
187 struct input *input, void *data);
Kristian Høgsberg04e98342012-01-09 09:36:16 -0500188typedef int (*widget_motion_handler_t)(struct widget *widget,
189 struct input *input, uint32_t time,
190 int32_t x, int32_t y, void *data);
Kristian Høgsberga8a0db32012-01-09 11:12:05 -0500191typedef void (*widget_button_handler_t)(struct widget *widget,
192 struct input *input, uint32_t time,
193 int button, int state, void *data);
Kristian Høgsbergbb901fa2012-01-09 11:22:32 -0500194typedef void (*widget_resize_handler_t)(struct widget *widget,
195 int32_t width, int32_t height,
196 void *data);
Kristian Høgsbergee143232012-01-09 08:42:24 -0500197
Kristian Høgsberg0c4457f2008-12-07 19:59:11 -0500198struct window *
Kristian Høgsberg248c1b62011-01-21 18:03:15 -0500199window_create(struct display *display, int32_t width, int32_t height);
200struct window *
201window_create_transient(struct display *display, struct window *parent,
202 int32_t x, int32_t y, int32_t width, int32_t height);
Kristian Høgsberg4f7dcd62012-01-06 21:59:05 -0500203
204typedef void (*menu_func_t)(struct window *window, int index, void *data);
205
Kristian Høgsbergbbedd7e2011-12-19 15:40:10 -0500206struct window *
Kristian Høgsbergb3cca0a2012-01-04 22:19:14 -0500207window_create_menu(struct display *display,
208 struct input *input, uint32_t time, struct window *parent,
Kristian Høgsberg4f7dcd62012-01-06 21:59:05 -0500209 int32_t x, int32_t y,
210 menu_func_t func, const char **entries, int count);
Kristian Høgsberg248c1b62011-01-21 18:03:15 -0500211
212void
213window_destroy(struct window *window);
214
Kristian Høgsbergc51f7992012-01-08 15:09:53 -0500215struct widget *
216window_add_widget(struct window *window, void *data);
Kristian Høgsberge28d05b2011-09-20 21:43:54 -0400217
Kristian Høgsberg47fe08a2011-10-28 12:26:06 -0400218typedef void (*data_func_t)(void *data, size_t len,
219 int32_t x, int32_t y, void *user_data);
220
Kristian Høgsbergbcee9a42011-10-12 00:36:16 -0400221struct display *
222window_get_display(struct window *window);
Kristian Høgsberg248c1b62011-01-21 18:03:15 -0500223void
Kristian Høgsberg82da52b2010-12-17 09:53:12 -0500224window_move(struct window *window, struct input *input, uint32_t time);
Kristian Høgsberg0c4457f2008-12-07 19:59:11 -0500225void
Kristian Høgsbergbb977002012-01-10 19:11:42 -0500226window_get_allocation(struct window *window, struct rectangle *allocation);
Kristian Høgsberg0c4457f2008-12-07 19:59:11 -0500227void
Kristian Høgsberg3be87d12011-05-13 13:45:17 -0400228window_set_transparent(struct window *window, int transparent);
229void
Kristian Høgsberg80d746f2010-06-14 23:52:50 -0400230window_schedule_redraw(struct window *window);
Kristian Høgsbergb67e94b2012-01-10 12:23:19 -0500231void
232window_schedule_resize(struct window *window, int width, int height);
Kristian Høgsberga85fe3c2010-06-08 14:08:30 -0400233
234void
Kristian Høgsbergd0c3b9d2010-10-25 11:40:03 -0400235window_damage(struct window *window, int32_t x, int32_t y,
236 int32_t width, int32_t height);
237
Kristian Høgsberg0ac16f02009-01-15 11:37:43 -0500238cairo_surface_t *
Kristian Høgsberga85fe3c2010-06-08 14:08:30 -0400239window_get_surface(struct window *window);
240
Benjamin Franzkeec4d3422011-03-14 12:07:26 +0100241struct wl_surface *
242window_get_wl_surface(struct window *window);
243
Pekka Paalanen9d1613e2011-11-25 12:09:16 +0200244struct wl_shell_surface *
245window_get_wl_shell_surface(struct window *window);
246
Kristian Høgsberg0ac16f02009-01-15 11:37:43 -0500247void
Kristian Høgsberg9d69f8e2010-09-03 14:46:38 -0400248window_flush(struct window *window);
249
Kristian Høgsberg012a0072010-10-26 00:02:20 -0400250void
Bryce Harringtonf57303f2010-11-19 12:15:15 -0800251window_set_surface(struct window *window, cairo_surface_t *surface);
252
253void
Kristian Høgsberg012a0072010-10-26 00:02:20 -0400254window_create_surface(struct window *window);
255
Kristian Høgsbergd0c3b9d2010-10-25 11:40:03 -0400256enum window_buffer_type {
Benjamin Franzke6693ac22011-02-10 12:04:30 +0100257 WINDOW_BUFFER_TYPE_EGL_WINDOW,
Kristian Høgsberg297c6312011-02-04 14:11:33 -0500258 WINDOW_BUFFER_TYPE_EGL_IMAGE,
Kristian Høgsbergd0c3b9d2010-10-25 11:40:03 -0400259 WINDOW_BUFFER_TYPE_SHM,
260};
261
262void
Benjamin Franzkebde55ec2011-03-07 15:08:09 +0100263display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
264 int32_t x, int32_t y, int32_t width, int32_t height);
265
266void
Kristian Høgsbergd0c3b9d2010-10-25 11:40:03 -0400267window_set_buffer_type(struct window *window, enum window_buffer_type type);
268
Kristian Høgsberg9d69f8e2010-09-03 14:46:38 -0400269void
Kristian Høgsberg0395f302008-12-22 12:14:50 -0500270window_set_fullscreen(struct window *window, int fullscreen);
271
272void
Kristian Høgsberg0c29eb22011-09-06 18:02:34 -0400273window_set_custom(struct window *window);
274
275void
Kristian Høgsbergc8c37342010-06-25 11:19:22 -0400276window_set_user_data(struct window *window, void *data);
277
Kristian Høgsberge9d37bd2010-09-02 20:22:42 -0400278void *
279window_get_user_data(struct window *window);
280
Kristian Høgsbergc8c37342010-06-25 11:19:22 -0400281void
Kristian Høgsberg6e83d582008-12-08 00:01:36 -0500282window_set_key_handler(struct window *window,
Kristian Høgsbergc8c37342010-06-25 11:19:22 -0400283 window_key_handler_t handler);
Kristian Høgsberg0c4457f2008-12-07 19:59:11 -0500284
Kristian Høgsberg3c248cc2009-02-22 23:01:35 -0500285void
286window_set_keyboard_focus_handler(struct window *window,
Kristian Høgsbergc8c37342010-06-25 11:19:22 -0400287 window_keyboard_focus_handler_t handler);
Kristian Høgsberga85fe3c2010-06-08 14:08:30 -0400288
289void
Kristian Høgsberg47fe08a2011-10-28 12:26:06 -0400290window_set_data_handler(struct window *window,
291 window_data_handler_t handler);
292
293void
294window_set_drop_handler(struct window *window,
295 window_drop_handler_t handler);
296
297void
Kristian Høgsberg4f7dcd62012-01-06 21:59:05 -0500298window_set_close_handler(struct window *window,
299 window_close_handler_t handler);
300
301void
Callum Lowcayef57a9b2011-01-14 20:46:23 +1300302window_set_title(struct window *window, const char *title);
303
304const char *
305window_get_title(struct window *window);
306
Kristian Høgsberg441338c2012-01-10 13:52:34 -0500307struct widget *
308widget_add_widget(struct widget *parent, void *data);
309void
310widget_destroy(struct widget *widget);
Kristian Høgsberg9a686242010-08-18 15:28:04 -0400311void
Kristian Høgsbergc51f7992012-01-08 15:09:53 -0500312widget_get_allocation(struct widget *widget, struct rectangle *allocation);
Kristian Høgsberge28d05b2011-09-20 21:43:54 -0400313
314void
Kristian Høgsbergc51f7992012-01-08 15:09:53 -0500315widget_set_allocation(struct widget *widget,
316 int32_t x, int32_t y, int32_t width, int32_t height);
Kristian Høgsbergbb977002012-01-10 19:11:42 -0500317void
318widget_set_size(struct widget *widget, int32_t width, int32_t height);
319void
320widget_schedule_resize(struct widget *widget, int32_t width, int32_t height);
Kristian Høgsberge28d05b2011-09-20 21:43:54 -0400321
322void *
Kristian Høgsbergc51f7992012-01-08 15:09:53 -0500323widget_get_user_data(struct widget *widget);
Kristian Høgsberge28d05b2011-09-20 21:43:54 -0400324
325void
Kristian Høgsbergb67e94b2012-01-10 12:23:19 -0500326widget_set_redraw_handler(struct widget *widget,
327 widget_redraw_handler_t handler);
328void
329widget_set_resize_handler(struct widget *widget,
330 widget_resize_handler_t handler);
331void
Kristian Høgsbergee143232012-01-09 08:42:24 -0500332widget_set_enter_handler(struct widget *widget,
333 widget_enter_handler_t handler);
334void
335widget_set_leave_handler(struct widget *widget,
336 widget_leave_handler_t handler);
Kristian Høgsberg04e98342012-01-09 09:36:16 -0500337void
338widget_set_motion_handler(struct widget *widget,
339 widget_motion_handler_t handler);
Kristian Høgsberg9a13dab2012-01-08 15:18:19 -0500340void
Kristian Høgsberga8a0db32012-01-09 11:12:05 -0500341widget_set_button_handler(struct widget *widget,
342 widget_button_handler_t handler);
343
344void
Kristian Høgsberg9a13dab2012-01-08 15:18:19 -0500345widget_schedule_redraw(struct widget *widget);
346
Kristian Høgsberg29af3eb2012-01-10 22:41:05 -0500347struct widget *
348frame_create(struct window *window, void *data);
349
Kristian Høgsberg9a13dab2012-01-08 15:18:19 -0500350void
Kristian Høgsberg47fe08a2011-10-28 12:26:06 -0400351input_set_pointer_image(struct input *input, uint32_t time, int pointer);
352
353void
Kristian Høgsberg9a686242010-08-18 15:28:04 -0400354input_get_position(struct input *input, int32_t *x, int32_t *y);
355
Kristian Høgsberg67cac8a2011-01-19 14:20:33 -0500356uint32_t
357input_get_modifiers(struct input *input);
358
Kristian Høgsberg831dd522012-01-10 23:46:33 -0500359void
360input_grab(struct input *input, struct widget *widget, uint32_t button);
361
362void
363input_ungrab(struct input *input, uint32_t time);
364
Kristian Høgsbergb6323512012-01-11 00:04:42 -0500365struct widget *
366input_get_focus_widget(struct input *input);
367
Kristian Høgsberg1d7ffd32010-08-25 16:34:05 -0400368struct wl_input_device *
369input_get_input_device(struct input *input);
370
Kristian Høgsberg47fe08a2011-10-28 12:26:06 -0400371struct wl_data_device *
372input_get_data_device(struct input *input);
373
Kristian Høgsberg6bccebe2011-01-21 16:23:09 -0500374void
Kristian Høgsberg47fe08a2011-10-28 12:26:06 -0400375input_set_selection(struct input *input,
376 struct wl_data_source *source, uint32_t time);
377
378void
379input_accept(struct input *input, uint32_t time, const char *type);
380
381
382void
383input_receive_drag_data(struct input *input, const char *mime_type,
384 data_func_t func, void *user_data);
385
386int
387input_receive_selection_data(struct input *input, const char *mime_type,
388 data_func_t func, void *data);
Kristian Høgsberge7aaec32011-12-27 13:50:04 -0500389int
390input_receive_selection_data_to_fd(struct input *input,
391 const char *mime_type, int fd);
Kristian Høgsberg58eec362011-01-19 14:27:42 -0500392
Kristian Høgsberg53ff2f62011-11-26 17:27:37 -0500393void
Pekka Paalanen999c5b52011-11-30 10:52:38 +0200394output_set_user_data(struct output *output, void *data);
395
396void *
397output_get_user_data(struct output *output);
398
399void
400output_set_destroy_handler(struct output *output,
401 display_output_handler_t handler);
402
403void
Kristian Høgsberg53ff2f62011-11-26 17:27:37 -0500404output_get_allocation(struct output *output, struct rectangle *allocation);
405
Pekka Paalanen999c5b52011-11-30 10:52:38 +0200406struct wl_output *
407output_get_wl_output(struct output *output);
Kristian Høgsberg53ff2f62011-11-26 17:27:37 -0500408
Kristian Høgsberg0c4457f2008-12-07 19:59:11 -0500409#endif