2 * Copyright © 2008-2011 Kristian Høgsberg
3 * Copyright © 2012 Collabora, Ltd.
5 * Permission to use, copy, modify, distribute, and sell this software and
6 * its documentation for any purpose is hereby granted without fee, provided
7 * that the above copyright notice appear in all copies and that both that
8 * copyright notice and this permission notice appear in supporting
9 * documentation, and that the name of the copyright holders not be used in
10 * advertising or publicity pertaining to distribution of the software
11 * without specific, written prior permission. The copyright holders make
12 * no representations about the suitability of this software for any
13 * purpose. It is provided "as is" without express or implied warranty.
15 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
16 * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
17 * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
18 * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
19 * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
20 * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
21 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
24 #ifndef _WAYLAND_SYSTEM_COMPOSITOR_H_
25 #define _WAYLAND_SYSTEM_COMPOSITOR_H_
28 #include <xkbcommon/xkbcommon.h>
29 #include <wayland-server.h>
31 #include <GLES2/gl2.h>
32 #include <GLES2/gl2ext.h>
34 #include <EGL/eglext.h>
37 #include "../shared/config-parser.h"
38 #include "weston-egl-ext.h"
41 struct weston_transform {
42 struct weston_matrix matrix;
46 struct weston_surface;
51 enum weston_keyboard_modifier {
52 MODIFIER_CTRL = (1 << 0),
53 MODIFIER_ALT = (1 << 1),
54 MODIFIER_SUPER = (1 << 2),
58 LED_NUM_LOCK = (1 << 0),
59 LED_CAPS_LOCK = (1 << 1),
60 LED_SCROLL_LOCK = (1 << 2),
65 int32_t width, height;
70 struct weston_shell_client {
71 void (*send_configure)(struct weston_surface *surface,
72 uint32_t edges, int32_t width, int32_t height);
75 struct weston_shell_interface {
76 void *shell; /* either desktop or tablet */
78 struct shell_surface *(*create_shell_surface)(void *shell,
79 struct weston_surface *surface,
80 const struct weston_shell_client *client);
82 void (*set_toplevel)(struct shell_surface *shsurf);
84 void (*set_transient)(struct shell_surface *shsurf,
85 struct shell_surface *pshsurf,
86 int x, int y, uint32_t flags);
87 int (*move)(struct shell_surface *shsurf, struct weston_seat *ws);
88 int (*resize)(struct shell_surface *shsurf,
89 struct weston_seat *ws, uint32_t edges);
93 struct weston_border {
94 int32_t left, right, top, bottom;
97 struct weston_animation {
98 void (*frame)(struct weston_animation *animation,
99 struct weston_output *output, uint32_t msecs);
104 struct weston_spring {
118 struct weston_output_zoom {
125 float trans_x, trans_y;
126 struct weston_animation animation_z;
127 struct weston_spring spring_z;
130 /* bit compatible with drm definitions. */
138 struct weston_read_pixels {
140 int x, y, width, height;
141 void (*done)(struct weston_read_pixels *read_pixels,
142 struct weston_output *output);
146 struct weston_output {
150 struct wl_list resource_list;
151 struct wl_global *global;
152 struct weston_compositor *compositor;
153 struct weston_matrix matrix;
154 struct wl_list animation_list;
155 int32_t x, y, mm_width, mm_height;
156 struct weston_border border;
157 pixman_region32_t region;
158 pixman_region32_t previous_damage;
161 int repaint_scheduled;
162 struct weston_output_zoom zoom;
164 struct wl_list read_pixels_list;
165 struct wl_signal frame_signal;
170 struct weston_mode *current;
171 struct weston_mode *origin;
172 struct wl_list mode_list;
174 void (*repaint)(struct weston_output *output,
175 pixman_region32_t *damage);
176 void (*destroy)(struct weston_output *output);
177 void (*assign_planes)(struct weston_output *output);
178 int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
180 /* backlight values are on 0-255 range, where higher is brighter */
181 uint32_t backlight_current;
182 void (*set_backlight)(struct weston_output *output, uint32_t value);
183 void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
186 struct weston_xkb_info {
187 struct xkb_keymap *keymap;
191 xkb_mod_index_t ctrl_mod;
192 xkb_mod_index_t alt_mod;
193 xkb_mod_index_t super_mod;
194 xkb_led_index_t num_led;
195 xkb_led_index_t caps_led;
196 xkb_led_index_t scroll_led;
201 struct wl_pointer pointer;
203 struct wl_keyboard keyboard;
205 struct wl_touch touch;
208 struct weston_compositor *compositor;
209 struct weston_surface *sprite;
210 struct weston_surface *drag_surface;
211 struct wl_listener drag_surface_destroy_listener;
212 int32_t hotspot_x, hotspot_y;
214 enum weston_keyboard_modifier modifier_state;
216 struct wl_surface *saved_kbd_focus;
217 struct wl_listener saved_kbd_focus_listener;
220 struct wl_surface *touch_focus;
221 struct wl_listener touch_focus_listener;
222 struct wl_resource *touch_focus_resource;
223 struct wl_listener touch_focus_resource_listener;
225 struct wl_listener new_drag_icon_listener;
227 void (*led_update)(struct weston_seat *ws, enum weston_led leds);
229 struct weston_xkb_info xkb_info;
231 struct xkb_state *state;
232 uint32_t mods_depressed;
233 uint32_t mods_latched;
234 uint32_t mods_locked;
236 enum weston_led leds;
240 struct weston_shader {
242 GLuint vertex_shader, fragment_shader;
247 GLint texwidth_uniform;
248 GLint opaque_uniform;
252 WESTON_COMPOSITOR_ACTIVE,
253 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
254 WESTON_COMPOSITOR_SLEEPING /* no rendering, no frame events */
257 struct weston_layer {
258 struct wl_list surface_list;
262 struct weston_compositor {
264 struct wl_signal destroy_signal;
270 struct weston_shader texture_shader;
271 struct weston_shader solid_shader;
272 struct weston_shader *current_shader;
273 struct wl_display *wl_display;
274 struct weston_shell_interface shell_interface;
276 struct wl_signal activate_signal;
277 struct wl_signal lock_signal;
278 struct wl_signal unlock_signal;
280 struct wl_event_loop *input_loop;
281 struct wl_event_source *input_loop_source;
283 /* There can be more than one, but not right now... */
284 struct weston_seat *seat;
286 struct weston_layer fade_layer;
287 struct weston_layer cursor_layer;
289 struct wl_list output_list;
290 struct wl_list seat_list;
291 struct wl_list layer_list;
292 struct wl_list surface_list;
293 struct wl_list key_binding_list;
294 struct wl_list button_binding_list;
295 struct wl_list axis_binding_list;
297 struct weston_spring spring;
298 struct weston_animation animation;
299 struct weston_surface *surface;
303 struct wl_event_source *idle_source;
304 uint32_t idle_inhibit;
305 int option_idle_time; /* default timeout, s */
306 int idle_time; /* effective timeout, s */
309 struct wl_array vertices, indices;
310 pixman_region32_t damage;
314 PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
315 image_target_renderbuffer_storage;
316 PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
317 PFNEGLCREATEIMAGEKHRPROC create_image;
318 PFNEGLDESTROYIMAGEKHRPROC destroy_image;
320 int has_unpack_subimage;
323 PFNEGLBINDWAYLANDDISPLAYWL bind_display;
324 PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
325 int has_bind_display;
327 void (*destroy)(struct weston_compositor *ec);
328 int (*authenticate)(struct weston_compositor *c, uint32_t id);
330 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
334 uint32_t output_id_pool;
336 struct xkb_rule_names xkb_names;
337 struct xkb_context *xkb_context;
338 struct weston_xkb_info xkb_info;
341 enum weston_output_flags {
342 WL_OUTPUT_FLIPPED = 0x01
345 struct weston_region {
346 struct wl_resource resource;
347 pixman_region32_t region;
350 /* Using weston_surface transformations
352 * To add a transformation to a surface, create a struct weston_transform, and
353 * add it to the list surface->geometry.transformation_list. Whenever you
354 * change the list, anything under surface->geometry, or anything in the
355 * weston_transforms linked into the list, you must set
356 * surface->geometry.dirty = 1.
358 * The order in the list defines the order of transformations. Let the list
359 * contain the transformation matrices M1, ..., Mn as head to tail. The
360 * transformation is applied to surface-local coordinate vector p as
361 * P = Mn * ... * M2 * M1 * p
362 * to produce the global coordinate vector P. The total transform
364 * is cached in surface->transform.matrix, and the inverse of it in
365 * surface->transform.inverse.
367 * The list always contains surface->transform.position transformation, which
368 * is the translation by surface->geometry.x and y.
370 * If you want to apply a transformation in local coordinates, add your
371 * weston_transform to the head of the list. If you want to apply a
372 * transformation in global coordinates, add it to the tail of the list.
375 struct weston_surface {
376 struct wl_surface surface;
377 struct weston_compositor *compositor;
379 pixman_region32_t clip;
380 pixman_region32_t damage;
381 pixman_region32_t opaque;
382 pixman_region32_t input;
385 struct wl_list layer_link;
386 struct weston_shader *shader;
388 GLfloat opaque_rect[4];
392 /* Surface geometry state, mutable.
393 * If you change anything, set dirty = 1.
394 * That includes the transformations referenced from the list.
397 GLfloat x, y; /* surface translation on display */
398 int32_t width, height;
400 /* struct weston_transform */
401 struct wl_list transformation_list;
406 /* State derived from geometry state, read-only.
407 * This is updated by weston_surface_update_transform().
410 pixman_region32_t boundingbox;
411 pixman_region32_t opaque;
413 /* matrix and inverse are used only if enabled = 1.
414 * If enabled = 0, use x, y, width, height directly.
417 struct weston_matrix matrix;
418 struct weston_matrix inverse;
420 struct weston_transform position; /* matrix from x, y */
424 * Which output to vsync this surface to.
425 * Used to determine, whether to send or queue frame events.
426 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
428 struct weston_output *output;
431 * A more complete representation of all outputs this surface is
434 uint32_t output_mask;
436 struct wl_list frame_callback_list;
440 struct wl_buffer *buffer;
441 struct wl_listener buffer_destroy_listener;
444 * If non-NULL, this function will be called on surface::attach after
445 * a new buffer has been set up for this surface. The integer params
446 * are the sx and sy paramerters supplied to surface::attach .
448 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
453 weston_surface_update_transform(struct weston_surface *surface);
456 weston_surface_to_global_fixed(struct weston_surface *surface,
457 wl_fixed_t sx, wl_fixed_t sy,
458 wl_fixed_t *x, wl_fixed_t *y);
460 weston_surface_to_global_float(struct weston_surface *surface,
461 GLfloat sx, GLfloat sy, GLfloat *x, GLfloat *y);
464 weston_surface_from_global(struct weston_surface *surface,
465 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
467 weston_surface_from_global_fixed(struct weston_surface *surface,
468 wl_fixed_t x, wl_fixed_t y,
469 wl_fixed_t *sx, wl_fixed_t *sy);
472 weston_spring_init(struct weston_spring *spring,
473 double k, double current, double target);
475 weston_spring_update(struct weston_spring *spring, uint32_t msec);
477 weston_spring_done(struct weston_spring *spring);
480 weston_surface_activate(struct weston_surface *surface,
481 struct weston_seat *seat);
483 weston_surface_draw(struct weston_surface *es,
484 struct weston_output *output, pixman_region32_t *damage);
487 notify_motion(struct wl_seat *seat, uint32_t time,
488 wl_fixed_t x, wl_fixed_t y);
490 notify_button(struct wl_seat *seat, uint32_t time, int32_t button,
491 enum wl_pointer_button_state state);
493 notify_axis(struct wl_seat *seat, uint32_t time, uint32_t axis,
496 notify_key(struct wl_seat *seat, uint32_t time, uint32_t key,
497 enum wl_keyboard_key_state state);
500 notify_pointer_focus(struct wl_seat *seat, struct weston_output *output,
501 wl_fixed_t x, wl_fixed_t y);
504 notify_keyboard_focus(struct wl_seat *seat, struct wl_array *keys);
507 notify_touch(struct wl_seat *seat, uint32_t time, int touch_id,
508 wl_fixed_t x, wl_fixed_t y, int touch_type);
511 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
514 weston_output_finish_frame(struct weston_output *output, int msecs);
516 weston_output_damage(struct weston_output *output);
518 weston_output_do_read_pixels(struct weston_output *output);
520 weston_compositor_repick(struct weston_compositor *compositor);
522 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
524 weston_compositor_fade(struct weston_compositor *compositor, float tint);
526 weston_compositor_damage_all(struct weston_compositor *compositor);
528 weston_compositor_unlock(struct weston_compositor *compositor);
530 weston_compositor_wake(struct weston_compositor *compositor);
532 weston_compositor_activity(struct weston_compositor *compositor);
534 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
537 struct weston_binding;
538 typedef void (*weston_key_binding_handler_t)(struct wl_seat *seat,
539 uint32_t time, uint32_t key,
541 struct weston_binding *
542 weston_compositor_add_key_binding(struct weston_compositor *compositor,
544 enum weston_keyboard_modifier modifier,
545 weston_key_binding_handler_t binding,
548 typedef void (*weston_button_binding_handler_t)(struct wl_seat *seat,
549 uint32_t time, uint32_t button,
551 struct weston_binding *
552 weston_compositor_add_button_binding(struct weston_compositor *compositor,
554 enum weston_keyboard_modifier modifier,
555 weston_button_binding_handler_t binding,
558 typedef void (*weston_axis_binding_handler_t)(struct wl_seat *seat,
559 uint32_t time, uint32_t axis,
560 wl_fixed_t value, void *data);
561 struct weston_binding *
562 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
564 enum weston_keyboard_modifier modifier,
565 weston_axis_binding_handler_t binding,
568 weston_binding_destroy(struct weston_binding *binding);
571 weston_binding_list_destroy_all(struct wl_list *list);
574 weston_compositor_run_key_binding(struct weston_compositor *compositor,
575 struct weston_seat *seat, uint32_t time,
577 enum wl_keyboard_key_state state);
579 weston_compositor_run_button_binding(struct weston_compositor *compositor,
580 struct weston_seat *seat, uint32_t time,
582 enum wl_pointer_button_state value);
584 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
585 struct weston_seat *seat, uint32_t time,
586 uint32_t axis, int32_t value);
589 weston_environment_get_fd(const char *env);
592 weston_compositor_top(struct weston_compositor *compositor);
594 struct weston_surface *
595 weston_surface_create(struct weston_compositor *compositor);
598 weston_surface_configure(struct weston_surface *surface,
599 GLfloat x, GLfloat y, int width, int height);
602 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
605 weston_surface_set_position(struct weston_surface *surface,
606 GLfloat x, GLfloat y);
609 weston_surface_is_mapped(struct weston_surface *surface);
612 weston_surface_assign_output(struct weston_surface *surface);
615 weston_surface_damage(struct weston_surface *surface);
618 weston_surface_damage_below(struct weston_surface *surface);
621 weston_buffer_post_release(struct wl_buffer *buffer);
624 weston_compositor_get_time(void);
627 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display,
628 int argc, char *argv[], const char *config_file);
630 weston_compositor_shutdown(struct weston_compositor *ec);
632 weston_text_cursor_position_notify(struct weston_surface *surface,
633 wl_fixed_t x, wl_fixed_t y);
635 weston_output_update_zoom(struct weston_output *output,
636 wl_fixed_t x, wl_fixed_t y,
639 weston_output_update_matrix(struct weston_output *output);
641 weston_output_move(struct weston_output *output, int x, int y);
643 weston_output_init(struct weston_output *output, struct weston_compositor *c,
644 int x, int y, int width, int height, uint32_t flags);
646 weston_output_destroy(struct weston_output *output);
649 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
651 weston_seat_init_pointer(struct weston_seat *seat);
653 weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
655 weston_seat_init_touch(struct weston_seat *seat);
658 weston_seat_release(struct weston_seat *seat);
665 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
668 tty_create(struct weston_compositor *compositor,
669 tty_vt_func_t vt_func, int tty_nr);
672 tty_destroy(struct tty *tty);
675 tty_activate_vt(struct tty *tty, int vt);
678 screenshooter_create(struct weston_compositor *ec);
681 clipboard_create(struct weston_seat *seat);
684 text_cursor_position_notifier_create(struct weston_compositor *ec);
686 struct weston_process;
687 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
690 struct weston_process {
692 weston_process_cleanup_func_t cleanup;
697 weston_client_launch(struct weston_compositor *compositor,
698 struct weston_process *proc,
700 weston_process_cleanup_func_t cleanup);
703 weston_watch_process(struct weston_process *process);
706 weston_xserver_init(struct weston_compositor *compositor);
709 typedef void (*weston_zoom_done_func_t)(struct weston_zoom *zoom, void *data);
712 weston_zoom_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
713 weston_zoom_done_func_t done, void *data);
716 typedef void (*weston_fade_done_func_t)(struct weston_fade *fade, void *data);
719 weston_fade_run(struct weston_surface *surface,
720 weston_fade_done_func_t done, void *data);
724 weston_surface_set_color(struct weston_surface *surface,
725 GLfloat red, GLfloat green, GLfloat blue, GLfloat alpha);
728 weston_surface_destroy(struct weston_surface *surface);
730 struct weston_compositor *
731 backend_init(struct wl_display *display, int argc, char *argv[],
732 const char *config_file);
735 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);