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"
40 #define ARRAY_LENGTH(a) (sizeof (a) / sizeof (a)[0])
42 struct weston_transform {
43 struct weston_matrix matrix;
47 struct weston_surface;
53 enum weston_keyboard_modifier {
54 MODIFIER_CTRL = (1 << 0),
55 MODIFIER_ALT = (1 << 1),
56 MODIFIER_SUPER = (1 << 2),
57 MODIFIER_SHIFT = (1 << 3),
61 LED_NUM_LOCK = (1 << 0),
62 LED_CAPS_LOCK = (1 << 1),
63 LED_SCROLL_LOCK = (1 << 2),
68 int32_t width, height;
73 struct weston_shell_client {
74 void (*send_configure)(struct weston_surface *surface,
75 uint32_t edges, int32_t width, int32_t height);
78 struct weston_shell_interface {
79 void *shell; /* either desktop or tablet */
81 struct shell_surface *(*create_shell_surface)(void *shell,
82 struct weston_surface *surface,
83 const struct weston_shell_client *client);
85 void (*set_toplevel)(struct shell_surface *shsurf);
87 void (*set_transient)(struct shell_surface *shsurf,
88 struct weston_surface *parent,
89 int x, int y, uint32_t flags);
90 int (*move)(struct shell_surface *shsurf, struct weston_seat *ws);
91 int (*resize)(struct shell_surface *shsurf,
92 struct weston_seat *ws, uint32_t edges);
96 struct weston_border {
97 int32_t left, right, top, bottom;
100 struct weston_animation {
101 void (*frame)(struct weston_animation *animation,
102 struct weston_output *output, uint32_t msecs);
107 struct weston_spring {
121 struct weston_fixed_point {
125 struct weston_output_zoom {
131 float trans_x, trans_y;
132 struct weston_animation animation_z;
133 struct weston_spring spring_z;
134 struct weston_animation animation_xy;
135 struct weston_spring spring_xy;
136 struct weston_fixed_point from;
137 struct weston_fixed_point to;
138 struct weston_fixed_point current;
139 struct weston_fixed_point text_cursor;
142 /* bit compatible with drm definitions. */
150 struct weston_output {
153 EGLSurface egl_surface;
155 struct wl_list resource_list;
156 struct wl_global *global;
157 struct weston_compositor *compositor;
158 struct weston_matrix matrix;
159 struct wl_list animation_list;
160 int32_t x, y, width, height;
161 int32_t mm_width, mm_height;
162 struct weston_border border;
163 pixman_region32_t region;
165 pixman_region32_t buffer_damage[2];
167 int repaint_scheduled;
168 struct weston_output_zoom zoom;
170 struct wl_signal frame_signal;
178 struct weston_mode *current;
179 struct weston_mode *origin;
180 struct wl_list mode_list;
182 void (*repaint)(struct weston_output *output,
183 pixman_region32_t *damage);
184 void (*destroy)(struct weston_output *output);
185 void (*assign_planes)(struct weston_output *output);
186 int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
188 /* backlight values are on 0-255 range, where higher is brighter */
189 uint32_t backlight_current;
190 void (*set_backlight)(struct weston_output *output, uint32_t value);
191 void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
194 struct weston_xkb_info {
195 struct xkb_keymap *keymap;
199 xkb_mod_index_t shift_mod;
200 xkb_mod_index_t caps_mod;
201 xkb_mod_index_t ctrl_mod;
202 xkb_mod_index_t alt_mod;
203 xkb_mod_index_t mod2_mod;
204 xkb_mod_index_t mod3_mod;
205 xkb_mod_index_t super_mod;
206 xkb_mod_index_t mod5_mod;
207 xkb_led_index_t num_led;
208 xkb_led_index_t caps_led;
209 xkb_led_index_t scroll_led;
214 struct wl_pointer pointer;
216 struct wl_keyboard keyboard;
218 struct wl_touch touch;
221 struct weston_compositor *compositor;
222 struct weston_surface *sprite;
223 struct wl_listener sprite_destroy_listener;
224 struct weston_surface *drag_surface;
225 struct wl_listener drag_surface_destroy_listener;
226 int32_t hotspot_x, hotspot_y;
228 enum weston_keyboard_modifier modifier_state;
229 struct wl_surface *saved_kbd_focus;
230 struct wl_listener saved_kbd_focus_listener;
234 struct wl_listener new_drag_icon_listener;
236 void (*led_update)(struct weston_seat *ws, enum weston_led leds);
238 struct weston_xkb_info xkb_info;
240 struct xkb_state *state;
241 enum weston_led leds;
244 struct input_method *input_method;
247 struct weston_shader {
249 GLuint vertex_shader, fragment_shader;
251 GLint tex_uniforms[3];
257 WESTON_COMPOSITOR_ACTIVE,
258 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
259 WESTON_COMPOSITOR_SLEEPING /* no rendering, no frame events */
262 struct weston_layer {
263 struct wl_list surface_list;
267 struct weston_plane {
268 pixman_region32_t damage;
272 struct weston_renderer {
273 void (*repaint_output)(struct weston_output *output,
274 pixman_region32_t *output_damage);
275 void (*flush_damage)(struct weston_surface *surface);
276 void (*attach)(struct weston_surface *es, struct wl_buffer *buffer);
277 void (*destroy_surface)(struct weston_surface *surface);
280 struct weston_compositor {
281 struct wl_signal destroy_signal;
283 EGLDisplay egl_display;
284 EGLContext egl_context;
285 EGLConfig egl_config;
286 struct weston_shader texture_shader_rgba;
287 struct weston_shader texture_shader_rgbx;
288 struct weston_shader texture_shader_egl_external;
289 struct weston_shader texture_shader_y_uv;
290 struct weston_shader texture_shader_y_u_v;
291 struct weston_shader texture_shader_y_xuxv;
292 struct weston_shader solid_shader;
293 struct weston_shader *current_shader;
294 struct wl_display *wl_display;
295 struct weston_shell_interface shell_interface;
297 struct wl_signal activate_signal;
298 struct wl_signal kill_signal;
299 struct wl_signal lock_signal;
300 struct wl_signal unlock_signal;
302 struct wl_signal show_input_panel_signal;
303 struct wl_signal hide_input_panel_signal;
305 struct wl_event_loop *input_loop;
306 struct wl_event_source *input_loop_source;
308 struct weston_layer fade_layer;
309 struct weston_layer cursor_layer;
311 struct wl_list output_list;
312 struct wl_list seat_list;
313 struct wl_list layer_list;
314 struct wl_list surface_list;
315 struct wl_list key_binding_list;
316 struct wl_list button_binding_list;
317 struct wl_list axis_binding_list;
319 struct weston_spring spring;
320 struct weston_animation animation;
321 struct weston_surface *surface;
325 struct wl_event_source *idle_source;
326 uint32_t idle_inhibit;
327 int option_idle_time; /* default timeout, s */
328 int idle_time; /* effective timeout, s */
331 struct wl_array vertices;
332 struct wl_array indices; /* only used in compositor-wayland */
333 struct wl_array vtxcnt;
334 struct weston_plane primary_plane;
339 struct weston_renderer *renderer;
341 PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
342 image_target_renderbuffer_storage;
343 PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
344 PFNEGLCREATEIMAGEKHRPROC create_image;
345 PFNEGLDESTROYIMAGEKHRPROC destroy_image;
347 int has_unpack_subimage;
350 PFNEGLBINDWAYLANDDISPLAYWL bind_display;
351 PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
352 PFNEGLQUERYWAYLANDBUFFERWL query_buffer;
353 int has_bind_display;
355 void (*destroy)(struct weston_compositor *ec);
356 void (*restore)(struct weston_compositor *ec);
357 int (*authenticate)(struct weston_compositor *c, uint32_t id);
359 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
363 uint32_t output_id_pool;
365 struct xkb_rule_names xkb_names;
366 struct xkb_context *xkb_context;
367 struct weston_xkb_info xkb_info;
370 struct weston_region {
371 struct wl_resource resource;
372 pixman_region32_t region;
375 /* Using weston_surface transformations
377 * To add a transformation to a surface, create a struct weston_transform, and
378 * add it to the list surface->geometry.transformation_list. Whenever you
379 * change the list, anything under surface->geometry, or anything in the
380 * weston_transforms linked into the list, you must set
381 * surface->geometry.dirty = 1.
383 * The order in the list defines the order of transformations. Let the list
384 * contain the transformation matrices M1, ..., Mn as head to tail. The
385 * transformation is applied to surface-local coordinate vector p as
386 * P = Mn * ... * M2 * M1 * p
387 * to produce the global coordinate vector P. The total transform
389 * is cached in surface->transform.matrix, and the inverse of it in
390 * surface->transform.inverse.
392 * The list always contains surface->transform.position transformation, which
393 * is the translation by surface->geometry.x and y.
395 * If you want to apply a transformation in local coordinates, add your
396 * weston_transform to the head of the list. If you want to apply a
397 * transformation in global coordinates, add it to the tail of the list.
400 struct weston_surface {
401 struct wl_surface surface;
402 struct weston_compositor *compositor;
405 pixman_region32_t clip;
406 pixman_region32_t damage;
407 pixman_region32_t opaque;
408 pixman_region32_t input;
411 struct wl_list layer_link;
412 struct weston_shader *shader;
415 struct weston_plane *plane;
417 /* Surface geometry state, mutable.
418 * If you change anything, set dirty = 1.
419 * That includes the transformations referenced from the list.
422 float x, y; /* surface translation on display */
423 int32_t width, height;
425 /* struct weston_transform */
426 struct wl_list transformation_list;
431 /* State derived from geometry state, read-only.
432 * This is updated by weston_surface_update_transform().
435 pixman_region32_t boundingbox;
436 pixman_region32_t opaque;
438 /* matrix and inverse are used only if enabled = 1.
439 * If enabled = 0, use x, y, width, height directly.
442 struct weston_matrix matrix;
443 struct weston_matrix inverse;
445 struct weston_transform position; /* matrix from x, y */
449 * Which output to vsync this surface to.
450 * Used to determine, whether to send or queue frame events.
451 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
453 struct weston_output *output;
456 * A more complete representation of all outputs this surface is
459 uint32_t output_mask;
461 struct wl_list frame_callback_list;
463 EGLImageKHR images[3];
467 struct wl_buffer *buffer;
468 struct wl_listener buffer_destroy_listener;
470 /* All the pending state, that wl_surface.commit will apply. */
472 /* wl_surface.attach */
474 struct wl_buffer *buffer;
475 struct wl_listener buffer_destroy_listener;
479 /* wl_surface.damage */
480 pixman_region32_t damage;
482 /* wl_surface.set_opaque_region */
483 pixman_region32_t opaque;
485 /* wl_surface.set_input_region */
486 pixman_region32_t input;
488 /* wl_surface.frame */
489 struct wl_list frame_callback_list;
493 * If non-NULL, this function will be called on surface::attach after
494 * a new buffer has been set up for this surface. The integer params
495 * are the sx and sy paramerters supplied to surface::attach .
497 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
501 enum weston_key_state_update {
502 STATE_UPDATE_AUTOMATIC,
507 weston_surface_update_transform(struct weston_surface *surface);
510 weston_surface_to_global_fixed(struct weston_surface *surface,
511 wl_fixed_t sx, wl_fixed_t sy,
512 wl_fixed_t *x, wl_fixed_t *y);
514 weston_surface_to_global_float(struct weston_surface *surface,
515 float sx, float sy, float *x, float *y);
518 weston_surface_from_global_float(struct weston_surface *surface,
519 float x, float y, float *sx, float *sy);
521 weston_surface_from_global(struct weston_surface *surface,
522 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
524 weston_surface_from_global_fixed(struct weston_surface *surface,
525 wl_fixed_t x, wl_fixed_t y,
526 wl_fixed_t *sx, wl_fixed_t *sy);
529 weston_spring_init(struct weston_spring *spring,
530 double k, double current, double target);
532 weston_spring_update(struct weston_spring *spring, uint32_t msec);
534 weston_spring_done(struct weston_spring *spring);
537 weston_surface_activate(struct weston_surface *surface,
538 struct weston_seat *seat);
540 notify_motion(struct weston_seat *seat, uint32_t time,
541 wl_fixed_t x, wl_fixed_t y);
543 notify_button(struct weston_seat *seat, uint32_t time, int32_t button,
544 enum wl_pointer_button_state state);
546 notify_axis(struct weston_seat *seat, uint32_t time, uint32_t axis,
549 notify_key(struct weston_seat *seat, uint32_t time, uint32_t key,
550 enum wl_keyboard_key_state state,
551 enum weston_key_state_update update_state);
553 notify_modifiers(struct weston_seat *seat, uint32_t serial);
556 notify_pointer_focus(struct weston_seat *seat, struct weston_output *output,
557 wl_fixed_t x, wl_fixed_t y);
560 notify_keyboard_focus_in(struct weston_seat *seat, struct wl_array *keys,
561 enum weston_key_state_update update_state);
563 notify_keyboard_focus_out(struct weston_seat *seat);
566 notify_touch(struct weston_seat *seat, uint32_t time, int touch_id,
567 wl_fixed_t x, wl_fixed_t y, int touch_type);
570 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
573 weston_plane_init(struct weston_plane *plane, int32_t x, int32_t y);
575 weston_plane_release(struct weston_plane *plane);
578 weston_output_finish_frame(struct weston_output *output, uint32_t msecs);
580 weston_output_schedule_repaint(struct weston_output *output);
582 weston_output_damage(struct weston_output *output);
584 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
586 weston_compositor_fade(struct weston_compositor *compositor, float tint);
588 weston_compositor_damage_all(struct weston_compositor *compositor);
590 weston_compositor_unlock(struct weston_compositor *compositor);
592 weston_compositor_wake(struct weston_compositor *compositor);
594 weston_compositor_activity(struct weston_compositor *compositor);
596 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
599 struct weston_binding;
600 typedef void (*weston_key_binding_handler_t)(struct wl_seat *seat,
601 uint32_t time, uint32_t key,
603 struct weston_binding *
604 weston_compositor_add_key_binding(struct weston_compositor *compositor,
606 enum weston_keyboard_modifier modifier,
607 weston_key_binding_handler_t binding,
610 typedef void (*weston_button_binding_handler_t)(struct wl_seat *seat,
611 uint32_t time, uint32_t button,
613 struct weston_binding *
614 weston_compositor_add_button_binding(struct weston_compositor *compositor,
616 enum weston_keyboard_modifier modifier,
617 weston_button_binding_handler_t binding,
620 typedef void (*weston_axis_binding_handler_t)(struct wl_seat *seat,
621 uint32_t time, uint32_t axis,
622 wl_fixed_t value, void *data);
623 struct weston_binding *
624 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
626 enum weston_keyboard_modifier modifier,
627 weston_axis_binding_handler_t binding,
630 weston_binding_destroy(struct weston_binding *binding);
633 weston_binding_list_destroy_all(struct wl_list *list);
636 weston_compositor_run_key_binding(struct weston_compositor *compositor,
637 struct weston_seat *seat, uint32_t time,
639 enum wl_keyboard_key_state state);
641 weston_compositor_run_button_binding(struct weston_compositor *compositor,
642 struct weston_seat *seat, uint32_t time,
644 enum wl_pointer_button_state value);
646 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
647 struct weston_seat *seat, uint32_t time,
648 uint32_t axis, int32_t value);
651 weston_environment_get_fd(const char *env);
654 weston_compositor_top(struct weston_compositor *compositor);
656 struct weston_surface *
657 weston_surface_create(struct weston_compositor *compositor);
660 weston_surface_configure(struct weston_surface *surface,
661 float x, float y, int width, int height);
664 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
667 weston_surface_set_position(struct weston_surface *surface,
671 weston_surface_is_mapped(struct weston_surface *surface);
674 weston_surface_schedule_repaint(struct weston_surface *surface);
677 weston_surface_damage(struct weston_surface *surface);
680 weston_surface_damage_below(struct weston_surface *surface);
683 weston_surface_move_to_plane(struct weston_surface *surface,
684 struct weston_plane *plane);
686 weston_surface_unmap(struct weston_surface *surface);
689 weston_buffer_post_release(struct wl_buffer *buffer);
692 weston_compositor_get_time(void);
695 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display,
696 int argc, char *argv[], const char *config_file);
698 weston_compositor_shutdown(struct weston_compositor *ec);
700 weston_text_cursor_position_notify(struct weston_surface *surface,
701 wl_fixed_t x, wl_fixed_t y);
703 weston_output_init_zoom(struct weston_output *output);
705 weston_output_update_zoom(struct weston_output *output, uint32_t type);
707 weston_output_update_matrix(struct weston_output *output);
709 weston_output_move(struct weston_output *output, int x, int y);
711 weston_output_init(struct weston_output *output, struct weston_compositor *c,
712 int x, int y, int width, int height, uint32_t transform);
714 weston_output_destroy(struct weston_output *output);
717 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
719 weston_seat_init_pointer(struct weston_seat *seat);
721 weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
723 weston_seat_init_touch(struct weston_seat *seat);
726 weston_seat_release(struct weston_seat *seat);
728 /* String literal of spaces, the same width as the timestamp. */
729 #define STAMP_SPACE " "
732 weston_log_file_open(const char *filename);
734 weston_log_file_close(void);
736 weston_log(const char *fmt, ...)
737 __attribute__ ((format (printf, 1, 2)));
739 weston_log_continue(const char *fmt, ...)
740 __attribute__ ((format (printf, 1, 2)));
747 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
750 tty_create(struct weston_compositor *compositor,
751 tty_vt_func_t vt_func, int tty_nr);
754 tty_destroy(struct tty *tty);
757 tty_reset(struct tty *tty);
760 tty_activate_vt(struct tty *tty, int vt);
763 screenshooter_create(struct weston_compositor *ec);
766 clipboard_create(struct weston_seat *seat);
769 text_cursor_position_notifier_create(struct weston_compositor *ec);
772 text_model_factory_create(struct weston_compositor *ec);
775 input_method_create(struct weston_compositor *ec,
776 struct weston_seat *seat);
778 struct weston_process;
779 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
782 struct weston_process {
784 weston_process_cleanup_func_t cleanup;
789 weston_client_launch(struct weston_compositor *compositor,
790 struct weston_process *proc,
792 weston_process_cleanup_func_t cleanup);
795 weston_watch_process(struct weston_process *process);
797 struct weston_surface_animation;
798 typedef void (*weston_surface_animation_done_func_t)(struct weston_surface_animation *animation, void *data);
800 struct weston_surface_animation *
801 weston_zoom_run(struct weston_surface *surface, float start, float stop,
802 weston_surface_animation_done_func_t done, void *data);
804 struct weston_surface_animation *
805 weston_fade_run(struct weston_surface *surface,
806 weston_surface_animation_done_func_t done, void *data);
807 struct weston_surface_animation *
808 weston_slide_run(struct weston_surface *surface, float start, float stop,
809 weston_surface_animation_done_func_t done, void *data);
812 weston_surface_set_color(struct weston_surface *surface,
813 float red, float green, float blue, float alpha);
816 weston_surface_destroy(struct weston_surface *surface);
819 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);
822 gles2_renderer_init(struct weston_compositor *ec);
824 gles2_renderer_destroy(struct weston_compositor *ec);
826 struct weston_compositor *
827 backend_init(struct wl_display *display, int argc, char *argv[],
828 const char *config_file);
831 module_init(struct weston_compositor *compositor);