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),
55 MODIFIER_SHIFT = (1 << 3),
59 LED_NUM_LOCK = (1 << 0),
60 LED_CAPS_LOCK = (1 << 1),
61 LED_SCROLL_LOCK = (1 << 2),
66 int32_t width, height;
71 struct weston_shell_client {
72 void (*send_configure)(struct weston_surface *surface,
73 uint32_t edges, int32_t width, int32_t height);
76 struct weston_shell_interface {
77 void *shell; /* either desktop or tablet */
79 struct shell_surface *(*create_shell_surface)(void *shell,
80 struct weston_surface *surface,
81 const struct weston_shell_client *client);
83 void (*set_toplevel)(struct shell_surface *shsurf);
85 void (*set_transient)(struct shell_surface *shsurf,
86 struct weston_surface *parent,
87 int x, int y, uint32_t flags);
88 int (*move)(struct shell_surface *shsurf, struct weston_seat *ws);
89 int (*resize)(struct shell_surface *shsurf,
90 struct weston_seat *ws, uint32_t edges);
94 struct weston_border {
95 int32_t left, right, top, bottom;
98 struct weston_animation {
99 void (*frame)(struct weston_animation *animation,
100 struct weston_output *output, uint32_t msecs);
105 struct weston_spring {
119 struct weston_fixed_point {
123 struct weston_output_zoom {
129 float trans_x, trans_y;
130 struct weston_animation animation_z;
131 struct weston_spring spring_z;
132 struct weston_animation animation_xy;
133 struct weston_spring spring_xy;
134 struct weston_fixed_point from;
135 struct weston_fixed_point to;
136 struct weston_fixed_point current;
137 struct weston_fixed_point text_cursor;
140 /* bit compatible with drm definitions. */
148 struct weston_output {
152 struct wl_list resource_list;
153 struct wl_global *global;
154 struct weston_compositor *compositor;
155 struct weston_matrix matrix;
156 struct wl_list animation_list;
157 int32_t x, y, mm_width, mm_height;
158 struct weston_border border;
159 pixman_region32_t region;
160 pixman_region32_t previous_damage;
163 int repaint_scheduled;
164 struct weston_output_zoom zoom;
166 struct wl_signal frame_signal;
173 struct weston_mode *current;
174 struct weston_mode *origin;
175 struct wl_list mode_list;
177 void (*repaint)(struct weston_output *output,
178 pixman_region32_t *damage);
179 void (*destroy)(struct weston_output *output);
180 void (*assign_planes)(struct weston_output *output);
181 int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
183 /* backlight values are on 0-255 range, where higher is brighter */
184 uint32_t backlight_current;
185 void (*set_backlight)(struct weston_output *output, uint32_t value);
186 void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
189 struct weston_xkb_info {
190 struct xkb_keymap *keymap;
194 xkb_mod_index_t shift_mod;
195 xkb_mod_index_t caps_mod;
196 xkb_mod_index_t ctrl_mod;
197 xkb_mod_index_t alt_mod;
198 xkb_mod_index_t mod2_mod;
199 xkb_mod_index_t mod3_mod;
200 xkb_mod_index_t super_mod;
201 xkb_mod_index_t mod5_mod;
202 xkb_led_index_t num_led;
203 xkb_led_index_t caps_led;
204 xkb_led_index_t scroll_led;
209 struct wl_pointer pointer;
211 struct wl_keyboard keyboard;
213 struct wl_touch touch;
216 struct weston_compositor *compositor;
217 struct weston_surface *sprite;
218 struct wl_listener sprite_destroy_listener;
219 struct weston_surface *drag_surface;
220 struct wl_listener drag_surface_destroy_listener;
221 int32_t hotspot_x, hotspot_y;
223 enum weston_keyboard_modifier modifier_state;
224 struct wl_surface *saved_kbd_focus;
225 struct wl_listener saved_kbd_focus_listener;
229 struct wl_listener new_drag_icon_listener;
231 void (*led_update)(struct weston_seat *ws, enum weston_led leds);
233 struct weston_xkb_info xkb_info;
235 struct xkb_state *state;
236 enum weston_led leds;
240 struct weston_shader {
242 GLuint vertex_shader, fragment_shader;
244 GLint tex_uniforms[3];
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_plane {
263 pixman_region32_t damage;
267 struct weston_compositor {
269 struct wl_signal destroy_signal;
271 EGLDisplay egl_display;
272 EGLContext egl_context;
273 EGLConfig egl_config;
275 struct weston_shader texture_shader_rgba;
276 struct weston_shader texture_shader_y_uv;
277 struct weston_shader texture_shader_y_u_v;
278 struct weston_shader texture_shader_y_xuxv;
279 struct weston_shader solid_shader;
280 struct weston_shader *current_shader;
281 struct wl_display *wl_display;
282 struct weston_shell_interface shell_interface;
284 struct wl_signal activate_signal;
285 struct wl_signal lock_signal;
286 struct wl_signal unlock_signal;
288 struct wl_signal show_input_panel_signal;
289 struct wl_signal hide_input_panel_signal;
291 struct wl_event_loop *input_loop;
292 struct wl_event_source *input_loop_source;
294 /* There can be more than one, but not right now... */
295 struct weston_seat *seat;
297 struct weston_layer fade_layer;
298 struct weston_layer cursor_layer;
300 struct wl_list output_list;
301 struct wl_list seat_list;
302 struct wl_list layer_list;
303 struct wl_list surface_list;
304 struct wl_list key_binding_list;
305 struct wl_list button_binding_list;
306 struct wl_list axis_binding_list;
308 struct weston_spring spring;
309 struct weston_animation animation;
310 struct weston_surface *surface;
314 struct wl_event_source *idle_source;
315 uint32_t idle_inhibit;
316 int option_idle_time; /* default timeout, s */
317 int idle_time; /* effective timeout, s */
320 struct wl_array vertices, indices;
321 struct weston_plane primary_plane;
325 PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
326 image_target_renderbuffer_storage;
327 PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
328 PFNEGLCREATEIMAGEKHRPROC create_image;
329 PFNEGLDESTROYIMAGEKHRPROC destroy_image;
331 int has_unpack_subimage;
334 PFNEGLBINDWAYLANDDISPLAYWL bind_display;
335 PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
336 PFNEGLQUERYWAYLANDBUFFERWL query_buffer;
337 int has_bind_display;
339 void (*destroy)(struct weston_compositor *ec);
340 void (*restore)(struct weston_compositor *ec);
341 int (*authenticate)(struct weston_compositor *c, uint32_t id);
343 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
347 uint32_t output_id_pool;
349 struct xkb_rule_names xkb_names;
350 struct xkb_context *xkb_context;
351 struct weston_xkb_info xkb_info;
354 enum weston_output_flags {
355 WL_OUTPUT_FLIPPED = 0x01
358 struct weston_region {
359 struct wl_resource resource;
360 pixman_region32_t region;
363 /* Using weston_surface transformations
365 * To add a transformation to a surface, create a struct weston_transform, and
366 * add it to the list surface->geometry.transformation_list. Whenever you
367 * change the list, anything under surface->geometry, or anything in the
368 * weston_transforms linked into the list, you must set
369 * surface->geometry.dirty = 1.
371 * The order in the list defines the order of transformations. Let the list
372 * contain the transformation matrices M1, ..., Mn as head to tail. The
373 * transformation is applied to surface-local coordinate vector p as
374 * P = Mn * ... * M2 * M1 * p
375 * to produce the global coordinate vector P. The total transform
377 * is cached in surface->transform.matrix, and the inverse of it in
378 * surface->transform.inverse.
380 * The list always contains surface->transform.position transformation, which
381 * is the translation by surface->geometry.x and y.
383 * If you want to apply a transformation in local coordinates, add your
384 * weston_transform to the head of the list. If you want to apply a
385 * transformation in global coordinates, add it to the tail of the list.
388 struct weston_surface {
389 struct wl_surface surface;
390 struct weston_compositor *compositor;
393 pixman_region32_t clip;
394 pixman_region32_t damage;
395 pixman_region32_t opaque;
396 pixman_region32_t input;
399 struct wl_list layer_link;
400 struct weston_shader *shader;
402 GLfloat opaque_rect[4];
405 struct weston_plane *plane;
407 /* Surface geometry state, mutable.
408 * If you change anything, set dirty = 1.
409 * That includes the transformations referenced from the list.
412 GLfloat x, y; /* surface translation on display */
413 int32_t width, height;
415 /* struct weston_transform */
416 struct wl_list transformation_list;
421 /* State derived from geometry state, read-only.
422 * This is updated by weston_surface_update_transform().
425 pixman_region32_t boundingbox;
426 pixman_region32_t opaque;
428 /* matrix and inverse are used only if enabled = 1.
429 * If enabled = 0, use x, y, width, height directly.
432 struct weston_matrix matrix;
433 struct weston_matrix inverse;
435 struct weston_transform position; /* matrix from x, y */
439 * Which output to vsync this surface to.
440 * Used to determine, whether to send or queue frame events.
441 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
443 struct weston_output *output;
446 * A more complete representation of all outputs this surface is
449 uint32_t output_mask;
451 struct wl_list frame_callback_list;
453 EGLImageKHR images[3];
456 struct wl_buffer *buffer;
457 struct wl_listener buffer_destroy_listener;
460 * If non-NULL, this function will be called on surface::attach after
461 * a new buffer has been set up for this surface. The integer params
462 * are the sx and sy paramerters supplied to surface::attach .
464 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
468 enum weston_key_state_update {
469 STATE_UPDATE_AUTOMATIC,
474 weston_surface_update_transform(struct weston_surface *surface);
477 weston_surface_to_global_fixed(struct weston_surface *surface,
478 wl_fixed_t sx, wl_fixed_t sy,
479 wl_fixed_t *x, wl_fixed_t *y);
481 weston_surface_to_global_float(struct weston_surface *surface,
482 GLfloat sx, GLfloat sy, GLfloat *x, GLfloat *y);
485 weston_surface_from_global(struct weston_surface *surface,
486 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
488 weston_surface_from_global_fixed(struct weston_surface *surface,
489 wl_fixed_t x, wl_fixed_t y,
490 wl_fixed_t *sx, wl_fixed_t *sy);
493 weston_spring_init(struct weston_spring *spring,
494 double k, double current, double target);
496 weston_spring_update(struct weston_spring *spring, uint32_t msec);
498 weston_spring_done(struct weston_spring *spring);
501 weston_surface_activate(struct weston_surface *surface,
502 struct weston_seat *seat);
504 weston_surface_draw(struct weston_surface *es,
505 struct weston_output *output, pixman_region32_t *damage);
508 notify_motion(struct wl_seat *seat, uint32_t time,
509 wl_fixed_t x, wl_fixed_t y);
511 notify_button(struct wl_seat *seat, uint32_t time, int32_t button,
512 enum wl_pointer_button_state state);
514 notify_axis(struct wl_seat *seat, uint32_t time, uint32_t axis,
517 notify_key(struct wl_seat *seat, uint32_t time, uint32_t key,
518 enum wl_keyboard_key_state state,
519 enum weston_key_state_update update_state);
521 notify_modifiers(struct wl_seat *seat, uint32_t serial);
524 notify_pointer_focus(struct wl_seat *seat, struct weston_output *output,
525 wl_fixed_t x, wl_fixed_t y);
528 notify_keyboard_focus_in(struct wl_seat *seat, struct wl_array *keys,
529 enum weston_key_state_update update_state);
531 notify_keyboard_focus_out(struct wl_seat *seat);
534 notify_touch(struct wl_seat *seat, uint32_t time, int touch_id,
535 wl_fixed_t x, wl_fixed_t y, int touch_type);
538 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
541 weston_plane_init(struct weston_plane *plane, int32_t x, int32_t y);
543 weston_plane_release(struct weston_plane *plane);
546 weston_output_finish_frame(struct weston_output *output, uint32_t msecs);
548 weston_output_schedule_repaint(struct weston_output *output);
550 weston_output_damage(struct weston_output *output);
552 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
554 weston_compositor_fade(struct weston_compositor *compositor, float tint);
556 weston_compositor_damage_all(struct weston_compositor *compositor);
558 weston_compositor_unlock(struct weston_compositor *compositor);
560 weston_compositor_wake(struct weston_compositor *compositor);
562 weston_compositor_activity(struct weston_compositor *compositor);
564 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
567 struct weston_binding;
568 typedef void (*weston_key_binding_handler_t)(struct wl_seat *seat,
569 uint32_t time, uint32_t key,
571 struct weston_binding *
572 weston_compositor_add_key_binding(struct weston_compositor *compositor,
574 enum weston_keyboard_modifier modifier,
575 weston_key_binding_handler_t binding,
578 typedef void (*weston_button_binding_handler_t)(struct wl_seat *seat,
579 uint32_t time, uint32_t button,
581 struct weston_binding *
582 weston_compositor_add_button_binding(struct weston_compositor *compositor,
584 enum weston_keyboard_modifier modifier,
585 weston_button_binding_handler_t binding,
588 typedef void (*weston_axis_binding_handler_t)(struct wl_seat *seat,
589 uint32_t time, uint32_t axis,
590 wl_fixed_t value, void *data);
591 struct weston_binding *
592 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
594 enum weston_keyboard_modifier modifier,
595 weston_axis_binding_handler_t binding,
598 weston_binding_destroy(struct weston_binding *binding);
601 weston_binding_list_destroy_all(struct wl_list *list);
604 weston_compositor_run_key_binding(struct weston_compositor *compositor,
605 struct weston_seat *seat, uint32_t time,
607 enum wl_keyboard_key_state state);
609 weston_compositor_run_button_binding(struct weston_compositor *compositor,
610 struct weston_seat *seat, uint32_t time,
612 enum wl_pointer_button_state value);
614 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
615 struct weston_seat *seat, uint32_t time,
616 uint32_t axis, int32_t value);
619 weston_environment_get_fd(const char *env);
622 weston_compositor_top(struct weston_compositor *compositor);
624 struct weston_surface *
625 weston_surface_create(struct weston_compositor *compositor);
628 weston_surface_configure(struct weston_surface *surface,
629 GLfloat x, GLfloat y, int width, int height);
632 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
635 weston_surface_set_position(struct weston_surface *surface,
636 GLfloat x, GLfloat y);
639 weston_surface_is_mapped(struct weston_surface *surface);
642 weston_surface_assign_output(struct weston_surface *surface);
645 weston_surface_schedule_repaint(struct weston_surface *surface);
648 weston_surface_damage(struct weston_surface *surface);
651 weston_surface_damage_below(struct weston_surface *surface);
654 weston_surface_move_to_plane(struct weston_surface *surface,
655 struct weston_plane *plane);
657 weston_surface_unmap(struct weston_surface *surface);
660 weston_buffer_post_release(struct wl_buffer *buffer);
663 weston_compositor_get_time(void);
666 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display,
667 int argc, char *argv[], const char *config_file);
669 weston_compositor_init_gl(struct weston_compositor *ec);
671 weston_compositor_shutdown(struct weston_compositor *ec);
673 weston_text_cursor_position_notify(struct weston_surface *surface,
674 wl_fixed_t x, wl_fixed_t y);
676 weston_output_init_zoom(struct weston_output *output);
678 weston_output_update_zoom(struct weston_output *output, uint32_t type);
680 weston_output_update_matrix(struct weston_output *output);
682 weston_output_move(struct weston_output *output, int x, int y);
684 weston_output_init(struct weston_output *output, struct weston_compositor *c,
685 int x, int y, int width, int height, uint32_t flags);
687 weston_output_destroy(struct weston_output *output);
690 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
692 weston_seat_init_pointer(struct weston_seat *seat);
694 weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
696 weston_seat_init_touch(struct weston_seat *seat);
699 weston_seat_release(struct weston_seat *seat);
701 /* String literal of spaces, the same width as the timestamp. */
702 #define STAMP_SPACE " "
705 weston_log_file_open(const char *filename);
707 weston_log_file_close(void);
709 weston_log(const char *fmt, ...);
711 weston_log_continue(const char *fmt, ...);
718 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
721 tty_create(struct weston_compositor *compositor,
722 tty_vt_func_t vt_func, int tty_nr);
725 tty_destroy(struct tty *tty);
728 tty_reset(struct tty *tty);
731 tty_activate_vt(struct tty *tty, int vt);
734 screenshooter_create(struct weston_compositor *ec);
737 clipboard_create(struct weston_seat *seat);
740 text_cursor_position_notifier_create(struct weston_compositor *ec);
743 input_method_create(struct weston_compositor *ec);
745 struct weston_process;
746 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
749 struct weston_process {
751 weston_process_cleanup_func_t cleanup;
756 weston_client_launch(struct weston_compositor *compositor,
757 struct weston_process *proc,
759 weston_process_cleanup_func_t cleanup);
762 weston_watch_process(struct weston_process *process);
765 weston_xserver_init(struct weston_compositor *compositor);
767 struct weston_surface_animation;
768 typedef void (*weston_surface_animation_done_func_t)(struct weston_surface_animation *animation, void *data);
770 struct weston_surface_animation *
771 weston_zoom_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
772 weston_surface_animation_done_func_t done, void *data);
774 struct weston_surface_animation *
775 weston_fade_run(struct weston_surface *surface,
776 weston_surface_animation_done_func_t done, void *data);
777 struct weston_surface_animation *
778 weston_slide_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
779 weston_surface_animation_done_func_t done, void *data);
782 weston_surface_set_color(struct weston_surface *surface,
783 GLfloat red, GLfloat green, GLfloat blue, GLfloat alpha);
786 weston_surface_destroy(struct weston_surface *surface);
788 struct weston_compositor *
789 backend_init(struct wl_display *display, int argc, char *argv[],
790 const char *config_file);
793 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);