2 * Copyright © 2008 Kristian Høgsberg
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.
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
26 #include <xkbcommon/xkbcommon.h>
27 #include <wayland-client.h>
29 #include "../shared/config-parser.h"
38 void (*run)(struct task *task, uint32_t events);
50 display_create(int argc, char *argv[]);
53 display_destroy(struct display *display);
56 display_set_user_data(struct display *display, void *data);
59 display_get_user_data(struct display *display);
62 display_get_display(struct display *display);
64 struct wl_compositor *
65 display_get_compositor(struct display *display);
68 display_get_shell(struct display *display);
71 display_get_output(struct display *display);
74 display_get_serial(struct display *display);
76 typedef void (*display_output_handler_t)(struct output *output, void *data);
79 * The output configure handler is called, when a new output is connected
80 * and we know its current mode, or when the current mode changes.
81 * Test and set the output user data in your handler to know, if the
82 * output is new. Note: 'data' in the configure handler is the display
86 display_set_output_configure_handler(struct display *display,
87 display_output_handler_t handler);
89 struct wl_data_source *
90 display_create_data_source(struct display *display);
94 display_get_egl_display(struct display *d);
97 display_get_argb_egl_config(struct display *d);
100 display_acquire_window_surface(struct display *display,
101 struct window *window,
104 display_release_window_surface(struct display *display,
105 struct window *window);
107 #ifdef HAVE_CAIRO_EGL
109 display_get_image_for_egl_image_surface(struct display *display,
110 cairo_surface_t *surface);
114 #define SURFACE_OPAQUE 0x01
115 #define SURFACE_SHM 0x02
118 display_create_surface(struct display *display,
119 struct wl_surface *surface,
120 struct rectangle *rectangle,
124 display_get_buffer_for_surface(struct display *display,
125 cairo_surface_t *surface);
127 struct wl_cursor_image *
128 display_get_pointer_image(struct display *display, int pointer);
131 display_defer(struct display *display, struct task *task);
134 display_watch_fd(struct display *display,
135 int fd, uint32_t events, struct task *task);
138 display_run(struct display *d);
141 display_exit(struct display *d);
161 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
162 uint32_t time, uint32_t key, uint32_t unicode,
163 enum wl_keyboard_key_state state, void *data);
165 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
166 struct input *device, void *data);
168 typedef void (*window_data_handler_t)(struct window *window,
174 typedef void (*window_drop_handler_t)(struct window *window,
176 int32_t x, int32_t y, void *data);
178 typedef void (*window_close_handler_t)(struct window *window, void *data);
179 typedef void (*window_fullscreen_handler_t)(struct window *window, void *data);
181 typedef void (*widget_resize_handler_t)(struct widget *widget,
182 int32_t width, int32_t height,
184 typedef void (*widget_redraw_handler_t)(struct widget *widget, void *data);
186 typedef int (*widget_enter_handler_t)(struct widget *widget,
188 float x, float y, void *data);
189 typedef void (*widget_leave_handler_t)(struct widget *widget,
190 struct input *input, void *data);
191 typedef int (*widget_motion_handler_t)(struct widget *widget,
192 struct input *input, uint32_t time,
193 float x, float y, void *data);
194 typedef void (*widget_button_handler_t)(struct widget *widget,
195 struct input *input, uint32_t time,
197 enum wl_pointer_button_state state,
201 window_create(struct display *display);
203 window_create_transient(struct display *display, struct window *parent,
204 int32_t x, int32_t y, uint32_t flags);
206 window_create_custom(struct display *display);
208 typedef void (*menu_func_t)(struct window *window, int index, void *data);
211 window_show_menu(struct display *display,
212 struct input *input, uint32_t time, struct window *parent,
213 int32_t x, int32_t y,
214 menu_func_t func, const char **entries, int count);
217 window_show_frame_menu(struct window *window,
218 struct input *input, uint32_t time);
221 window_destroy(struct window *window);
224 window_add_widget(struct window *window, void *data);
226 typedef void (*data_func_t)(void *data, size_t len,
227 int32_t x, int32_t y, void *user_data);
230 window_get_display(struct window *window);
232 window_move(struct window *window, struct input *input, uint32_t time);
234 window_get_allocation(struct window *window, struct rectangle *allocation);
236 window_set_transparent(struct window *window, int transparent);
238 window_schedule_redraw(struct window *window);
240 window_schedule_resize(struct window *window, int width, int height);
243 window_damage(struct window *window, int32_t x, int32_t y,
244 int32_t width, int32_t height);
247 window_get_surface(struct window *window);
250 window_get_wl_surface(struct window *window);
252 struct wl_shell_surface *
253 window_get_wl_shell_surface(struct window *window);
256 window_flush(struct window *window);
259 window_set_surface(struct window *window, cairo_surface_t *surface);
262 window_create_surface(struct window *window);
264 enum window_buffer_type {
265 WINDOW_BUFFER_TYPE_EGL_WINDOW,
266 WINDOW_BUFFER_TYPE_SHM,
270 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
271 int32_t x, int32_t y, int32_t width, int32_t height);
274 window_set_buffer_type(struct window *window, enum window_buffer_type type);
277 window_set_fullscreen(struct window *window, int fullscreen);
280 window_set_maximized(struct window *window, int maximized);
283 window_set_user_data(struct window *window, void *data);
286 window_get_user_data(struct window *window);
289 window_set_key_handler(struct window *window,
290 window_key_handler_t handler);
293 window_set_keyboard_focus_handler(struct window *window,
294 window_keyboard_focus_handler_t handler);
297 window_set_data_handler(struct window *window,
298 window_data_handler_t handler);
301 window_set_drop_handler(struct window *window,
302 window_drop_handler_t handler);
305 window_set_close_handler(struct window *window,
306 window_close_handler_t handler);
308 window_set_fullscreen_handler(struct window *window,
309 window_fullscreen_handler_t handler);
312 window_set_title(struct window *window, const char *title);
315 window_get_title(struct window *window);
318 window_set_text_cursor_position(struct window *window, int32_t x, int32_t y);
321 widget_set_tooltip(struct widget *parent, char *entry, float x, float y);
324 widget_destroy_tooltip(struct widget *parent);
327 widget_add_widget(struct widget *parent, void *data);
330 widget_destroy(struct widget *widget);
332 widget_get_allocation(struct widget *widget, struct rectangle *allocation);
335 widget_set_allocation(struct widget *widget,
336 int32_t x, int32_t y, int32_t width, int32_t height);
338 widget_set_size(struct widget *widget, int32_t width, int32_t height);
340 widget_set_transparent(struct widget *widget, int transparent);
342 widget_schedule_resize(struct widget *widget, int32_t width, int32_t height);
345 widget_get_user_data(struct widget *widget);
348 widget_set_redraw_handler(struct widget *widget,
349 widget_redraw_handler_t handler);
351 widget_set_resize_handler(struct widget *widget,
352 widget_resize_handler_t handler);
354 widget_set_enter_handler(struct widget *widget,
355 widget_enter_handler_t handler);
357 widget_set_leave_handler(struct widget *widget,
358 widget_leave_handler_t handler);
360 widget_set_motion_handler(struct widget *widget,
361 widget_motion_handler_t handler);
363 widget_set_button_handler(struct widget *widget,
364 widget_button_handler_t handler);
367 widget_schedule_redraw(struct widget *widget);
370 frame_create(struct window *window, void *data);
372 frame_set_child_size(struct widget *widget, int child_width, int child_height);
375 input_set_pointer_image(struct input *input, int pointer);
378 input_get_position(struct input *input, int32_t *x, int32_t *y);
380 #define MOD_SHIFT_MASK 0x01
381 #define MOD_ALT_MASK 0x02
382 #define MOD_CONTROL_MASK 0x04
385 input_get_modifiers(struct input *input);
388 input_grab(struct input *input, struct widget *widget, uint32_t button);
391 input_ungrab(struct input *input);
394 input_get_focus_widget(struct input *input);
397 input_get_display(struct input *input);
400 input_get_seat(struct input *input);
402 struct wl_data_device *
403 input_get_data_device(struct input *input);
406 input_set_selection(struct input *input,
407 struct wl_data_source *source, uint32_t time);
410 input_accept(struct input *input, const char *type);
414 input_receive_drag_data(struct input *input, const char *mime_type,
415 data_func_t func, void *user_data);
418 input_receive_selection_data(struct input *input, const char *mime_type,
419 data_func_t func, void *data);
421 input_receive_selection_data_to_fd(struct input *input,
422 const char *mime_type, int fd);
425 output_set_user_data(struct output *output, void *data);
428 output_get_user_data(struct output *output);
431 output_set_destroy_handler(struct output *output,
432 display_output_handler_t handler);
435 output_get_allocation(struct output *output, struct rectangle *allocation);
438 output_get_wl_output(struct output *output);