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>
38 #include "config-parser.h"
39 #include "weston-egl-ext.h"
41 #define ARRAY_LENGTH(a) (sizeof (a) / sizeof (a)[0])
43 #define container_of(ptr, type, member) ({ \
44 const __typeof__( ((type *)0)->member ) *__mptr = (ptr); \
45 (type *)( (char *)__mptr - offsetof(type,member) );})
47 struct weston_transform {
48 struct weston_matrix matrix;
52 struct weston_surface;
58 enum weston_keyboard_modifier {
59 MODIFIER_CTRL = (1 << 0),
60 MODIFIER_ALT = (1 << 1),
61 MODIFIER_SUPER = (1 << 2),
62 MODIFIER_SHIFT = (1 << 3),
66 LED_NUM_LOCK = (1 << 0),
67 LED_CAPS_LOCK = (1 << 1),
68 LED_SCROLL_LOCK = (1 << 2),
73 int32_t width, height;
78 struct weston_shell_client {
79 void (*send_configure)(struct weston_surface *surface,
80 uint32_t edges, int32_t width, int32_t height);
83 struct weston_shell_interface {
84 void *shell; /* either desktop or tablet */
86 struct shell_surface *(*create_shell_surface)(void *shell,
87 struct weston_surface *surface,
88 const struct weston_shell_client *client);
90 void (*set_toplevel)(struct shell_surface *shsurf);
92 void (*set_transient)(struct shell_surface *shsurf,
93 struct weston_surface *parent,
94 int x, int y, uint32_t flags);
95 int (*move)(struct shell_surface *shsurf, struct weston_seat *ws);
96 int (*resize)(struct shell_surface *shsurf,
97 struct weston_seat *ws, uint32_t edges);
101 struct weston_border {
102 int32_t left, right, top, bottom;
105 struct weston_animation {
106 void (*frame)(struct weston_animation *animation,
107 struct weston_output *output, uint32_t msecs);
112 struct weston_spring {
126 struct weston_fixed_point {
130 struct weston_output_zoom {
136 float trans_x, trans_y;
137 struct weston_animation animation_z;
138 struct weston_spring spring_z;
139 struct weston_animation animation_xy;
140 struct weston_spring spring_xy;
141 struct weston_fixed_point from;
142 struct weston_fixed_point to;
143 struct weston_fixed_point current;
144 struct weston_fixed_point text_cursor;
147 /* bit compatible with drm definitions. */
155 struct weston_output {
158 EGLSurface egl_surface;
160 struct wl_list resource_list;
161 struct wl_global *global;
162 struct weston_compositor *compositor;
163 struct weston_matrix matrix;
164 struct wl_list animation_list;
165 int32_t x, y, width, height;
166 int32_t mm_width, mm_height;
167 struct weston_border border;
168 pixman_region32_t region;
170 pixman_region32_t buffer_damage[2];
172 int repaint_scheduled;
173 struct weston_output_zoom zoom;
175 struct wl_signal frame_signal;
183 struct weston_mode *current;
184 struct weston_mode *origin;
185 struct wl_list mode_list;
187 void (*repaint)(struct weston_output *output,
188 pixman_region32_t *damage);
189 void (*destroy)(struct weston_output *output);
190 void (*assign_planes)(struct weston_output *output);
191 int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
193 /* backlight values are on 0-255 range, where higher is brighter */
194 uint32_t backlight_current;
195 void (*set_backlight)(struct weston_output *output, uint32_t value);
196 void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
199 struct weston_xkb_info {
200 struct xkb_keymap *keymap;
204 xkb_mod_index_t shift_mod;
205 xkb_mod_index_t caps_mod;
206 xkb_mod_index_t ctrl_mod;
207 xkb_mod_index_t alt_mod;
208 xkb_mod_index_t mod2_mod;
209 xkb_mod_index_t mod3_mod;
210 xkb_mod_index_t super_mod;
211 xkb_mod_index_t mod5_mod;
212 xkb_led_index_t num_led;
213 xkb_led_index_t caps_led;
214 xkb_led_index_t scroll_led;
219 struct wl_pointer pointer;
221 struct wl_keyboard keyboard;
223 struct wl_touch touch;
226 struct weston_compositor *compositor;
227 struct weston_surface *sprite;
228 struct wl_listener sprite_destroy_listener;
229 struct weston_surface *drag_surface;
230 struct wl_listener drag_surface_destroy_listener;
231 int32_t hotspot_x, hotspot_y;
233 enum weston_keyboard_modifier modifier_state;
234 struct wl_surface *saved_kbd_focus;
235 struct wl_listener saved_kbd_focus_listener;
239 struct wl_listener new_drag_icon_listener;
241 void (*led_update)(struct weston_seat *ws, enum weston_led leds);
243 struct weston_xkb_info xkb_info;
245 struct xkb_state *state;
246 enum weston_led leds;
249 struct input_method *input_method;
252 struct weston_shader {
254 GLuint vertex_shader, fragment_shader;
256 GLint tex_uniforms[3];
262 WESTON_COMPOSITOR_ACTIVE,
263 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
264 WESTON_COMPOSITOR_SLEEPING /* no rendering, no frame events */
267 struct weston_layer {
268 struct wl_list surface_list;
272 struct weston_plane {
273 pixman_region32_t damage;
274 pixman_region32_t opaque;
278 struct weston_renderer {
279 void (*repaint_output)(struct weston_output *output,
280 pixman_region32_t *output_damage);
281 void (*flush_damage)(struct weston_surface *surface);
282 void (*attach)(struct weston_surface *es, struct wl_buffer *buffer);
283 void (*destroy_surface)(struct weston_surface *surface);
286 struct weston_compositor {
287 struct wl_signal destroy_signal;
289 EGLDisplay egl_display;
290 EGLContext egl_context;
291 EGLConfig egl_config;
292 struct weston_shader texture_shader_rgba;
293 struct weston_shader texture_shader_rgbx;
294 struct weston_shader texture_shader_egl_external;
295 struct weston_shader texture_shader_y_uv;
296 struct weston_shader texture_shader_y_u_v;
297 struct weston_shader texture_shader_y_xuxv;
298 struct weston_shader solid_shader;
299 struct weston_shader *current_shader;
300 struct wl_display *wl_display;
301 struct weston_shell_interface shell_interface;
303 struct wl_signal activate_signal;
304 struct wl_signal kill_signal;
305 struct wl_signal lock_signal;
306 struct wl_signal unlock_signal;
308 struct wl_signal show_input_panel_signal;
309 struct wl_signal hide_input_panel_signal;
311 struct wl_event_loop *input_loop;
312 struct wl_event_source *input_loop_source;
314 struct weston_layer fade_layer;
315 struct weston_layer cursor_layer;
317 struct wl_list output_list;
318 struct wl_list seat_list;
319 struct wl_list layer_list;
320 struct wl_list surface_list;
321 struct wl_list key_binding_list;
322 struct wl_list button_binding_list;
323 struct wl_list axis_binding_list;
325 struct weston_spring spring;
326 struct weston_animation animation;
327 struct weston_surface *surface;
331 struct wl_event_source *idle_source;
332 uint32_t idle_inhibit;
333 int option_idle_time; /* default timeout, s */
334 int idle_time; /* effective timeout, s */
337 struct wl_array vertices;
338 struct wl_array indices; /* only used in compositor-wayland */
339 struct wl_array vtxcnt;
340 struct weston_plane primary_plane;
345 struct weston_renderer *renderer;
347 PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
348 image_target_renderbuffer_storage;
349 PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
350 PFNEGLCREATEIMAGEKHRPROC create_image;
351 PFNEGLDESTROYIMAGEKHRPROC destroy_image;
353 int has_unpack_subimage;
356 PFNEGLBINDWAYLANDDISPLAYWL bind_display;
357 PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
358 PFNEGLQUERYWAYLANDBUFFERWL query_buffer;
359 int has_bind_display;
361 void (*destroy)(struct weston_compositor *ec);
362 void (*restore)(struct weston_compositor *ec);
363 int (*authenticate)(struct weston_compositor *c, uint32_t id);
365 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
369 uint32_t output_id_pool;
371 struct xkb_rule_names xkb_names;
372 struct xkb_context *xkb_context;
373 struct weston_xkb_info xkb_info;
376 struct weston_region {
377 struct wl_resource resource;
378 pixman_region32_t region;
381 /* Using weston_surface transformations
383 * To add a transformation to a surface, create a struct weston_transform, and
384 * add it to the list surface->geometry.transformation_list. Whenever you
385 * change the list, anything under surface->geometry, or anything in the
386 * weston_transforms linked into the list, you must set
387 * surface->geometry.dirty = 1.
389 * The order in the list defines the order of transformations. Let the list
390 * contain the transformation matrices M1, ..., Mn as head to tail. The
391 * transformation is applied to surface-local coordinate vector p as
392 * P = Mn * ... * M2 * M1 * p
393 * to produce the global coordinate vector P. The total transform
395 * is cached in surface->transform.matrix, and the inverse of it in
396 * surface->transform.inverse.
398 * The list always contains surface->transform.position transformation, which
399 * is the translation by surface->geometry.x and y.
401 * If you want to apply a transformation in local coordinates, add your
402 * weston_transform to the head of the list. If you want to apply a
403 * transformation in global coordinates, add it to the tail of the list.
406 struct weston_surface {
407 struct wl_surface surface;
408 struct weston_compositor *compositor;
411 pixman_region32_t clip;
412 pixman_region32_t damage;
413 pixman_region32_t opaque;
414 pixman_region32_t input;
417 struct wl_list layer_link;
418 struct weston_shader *shader;
421 struct weston_plane *plane;
423 /* Surface geometry state, mutable.
424 * If you change anything, set dirty = 1.
425 * That includes the transformations referenced from the list.
428 float x, y; /* surface translation on display */
429 int32_t width, height;
431 /* struct weston_transform */
432 struct wl_list transformation_list;
437 /* State derived from geometry state, read-only.
438 * This is updated by weston_surface_update_transform().
441 pixman_region32_t boundingbox;
442 pixman_region32_t opaque;
444 /* matrix and inverse are used only if enabled = 1.
445 * If enabled = 0, use x, y, width, height directly.
448 struct weston_matrix matrix;
449 struct weston_matrix inverse;
451 struct weston_transform position; /* matrix from x, y */
455 * Which output to vsync this surface to.
456 * Used to determine, whether to send or queue frame events.
457 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
459 struct weston_output *output;
462 * A more complete representation of all outputs this surface is
465 uint32_t output_mask;
467 struct wl_list frame_callback_list;
469 EGLImageKHR images[3];
473 struct wl_buffer *buffer;
474 struct wl_listener buffer_destroy_listener;
476 /* All the pending state, that wl_surface.commit will apply. */
478 /* wl_surface.attach */
480 struct wl_buffer *buffer;
481 struct wl_listener buffer_destroy_listener;
485 /* wl_surface.damage */
486 pixman_region32_t damage;
488 /* wl_surface.set_opaque_region */
489 pixman_region32_t opaque;
491 /* wl_surface.set_input_region */
492 pixman_region32_t input;
494 /* wl_surface.frame */
495 struct wl_list frame_callback_list;
499 * If non-NULL, this function will be called on surface::attach after
500 * a new buffer has been set up for this surface. The integer params
501 * are the sx and sy paramerters supplied to surface::attach .
503 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
507 enum weston_key_state_update {
508 STATE_UPDATE_AUTOMATIC,
513 weston_version(int *major, int *minor, int *micro);
516 weston_surface_update_transform(struct weston_surface *surface);
519 weston_surface_to_global_fixed(struct weston_surface *surface,
520 wl_fixed_t sx, wl_fixed_t sy,
521 wl_fixed_t *x, wl_fixed_t *y);
523 weston_surface_to_global_float(struct weston_surface *surface,
524 float sx, float sy, float *x, float *y);
527 weston_surface_from_global_float(struct weston_surface *surface,
528 float x, float y, float *sx, float *sy);
530 weston_surface_from_global(struct weston_surface *surface,
531 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
533 weston_surface_from_global_fixed(struct weston_surface *surface,
534 wl_fixed_t x, wl_fixed_t y,
535 wl_fixed_t *sx, wl_fixed_t *sy);
538 weston_spring_init(struct weston_spring *spring,
539 double k, double current, double target);
541 weston_spring_update(struct weston_spring *spring, uint32_t msec);
543 weston_spring_done(struct weston_spring *spring);
546 weston_surface_activate(struct weston_surface *surface,
547 struct weston_seat *seat);
549 notify_motion(struct weston_seat *seat, uint32_t time,
550 wl_fixed_t x, wl_fixed_t y);
552 notify_button(struct weston_seat *seat, uint32_t time, int32_t button,
553 enum wl_pointer_button_state state);
555 notify_axis(struct weston_seat *seat, uint32_t time, uint32_t axis,
558 notify_key(struct weston_seat *seat, uint32_t time, uint32_t key,
559 enum wl_keyboard_key_state state,
560 enum weston_key_state_update update_state);
562 notify_modifiers(struct weston_seat *seat, uint32_t serial);
565 notify_pointer_focus(struct weston_seat *seat, struct weston_output *output,
566 wl_fixed_t x, wl_fixed_t y);
569 notify_keyboard_focus_in(struct weston_seat *seat, struct wl_array *keys,
570 enum weston_key_state_update update_state);
572 notify_keyboard_focus_out(struct weston_seat *seat);
575 notify_touch(struct weston_seat *seat, uint32_t time, int touch_id,
576 wl_fixed_t x, wl_fixed_t y, int touch_type);
579 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
582 weston_plane_init(struct weston_plane *plane, int32_t x, int32_t y);
584 weston_plane_release(struct weston_plane *plane);
587 weston_output_finish_frame(struct weston_output *output, uint32_t msecs);
589 weston_output_schedule_repaint(struct weston_output *output);
591 weston_output_damage(struct weston_output *output);
593 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
595 weston_compositor_fade(struct weston_compositor *compositor, float tint);
597 weston_compositor_damage_all(struct weston_compositor *compositor);
599 weston_compositor_unlock(struct weston_compositor *compositor);
601 weston_compositor_wake(struct weston_compositor *compositor);
603 weston_compositor_activity(struct weston_compositor *compositor);
605 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
608 struct weston_binding;
609 typedef void (*weston_key_binding_handler_t)(struct wl_seat *seat,
610 uint32_t time, uint32_t key,
612 struct weston_binding *
613 weston_compositor_add_key_binding(struct weston_compositor *compositor,
615 enum weston_keyboard_modifier modifier,
616 weston_key_binding_handler_t binding,
619 typedef void (*weston_button_binding_handler_t)(struct wl_seat *seat,
620 uint32_t time, uint32_t button,
622 struct weston_binding *
623 weston_compositor_add_button_binding(struct weston_compositor *compositor,
625 enum weston_keyboard_modifier modifier,
626 weston_button_binding_handler_t binding,
629 typedef void (*weston_axis_binding_handler_t)(struct wl_seat *seat,
630 uint32_t time, uint32_t axis,
631 wl_fixed_t value, void *data);
632 struct weston_binding *
633 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
635 enum weston_keyboard_modifier modifier,
636 weston_axis_binding_handler_t binding,
639 weston_binding_destroy(struct weston_binding *binding);
642 weston_binding_list_destroy_all(struct wl_list *list);
645 weston_compositor_run_key_binding(struct weston_compositor *compositor,
646 struct weston_seat *seat, uint32_t time,
648 enum wl_keyboard_key_state state);
650 weston_compositor_run_button_binding(struct weston_compositor *compositor,
651 struct weston_seat *seat, uint32_t time,
653 enum wl_pointer_button_state value);
655 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
656 struct weston_seat *seat, uint32_t time,
657 uint32_t axis, int32_t value);
660 weston_environment_get_fd(const char *env);
663 weston_compositor_top(struct weston_compositor *compositor);
665 struct weston_surface *
666 weston_surface_create(struct weston_compositor *compositor);
669 weston_surface_configure(struct weston_surface *surface,
670 float x, float y, int width, int height);
673 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
676 weston_surface_set_position(struct weston_surface *surface,
680 weston_surface_is_mapped(struct weston_surface *surface);
683 weston_surface_schedule_repaint(struct weston_surface *surface);
686 weston_surface_damage(struct weston_surface *surface);
689 weston_surface_damage_below(struct weston_surface *surface);
692 weston_surface_move_to_plane(struct weston_surface *surface,
693 struct weston_plane *plane);
695 weston_surface_unmap(struct weston_surface *surface);
698 weston_buffer_post_release(struct wl_buffer *buffer);
701 weston_compositor_get_time(void);
704 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display,
705 int argc, char *argv[], const char *config_file);
707 weston_compositor_shutdown(struct weston_compositor *ec);
709 weston_text_cursor_position_notify(struct weston_surface *surface,
710 wl_fixed_t x, wl_fixed_t y);
712 weston_output_init_zoom(struct weston_output *output);
714 weston_output_update_zoom(struct weston_output *output, uint32_t type);
716 weston_output_update_matrix(struct weston_output *output);
718 weston_output_move(struct weston_output *output, int x, int y);
720 weston_output_init(struct weston_output *output, struct weston_compositor *c,
721 int x, int y, int width, int height, uint32_t transform);
723 weston_output_destroy(struct weston_output *output);
726 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
728 weston_seat_init_pointer(struct weston_seat *seat);
730 weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
732 weston_seat_init_touch(struct weston_seat *seat);
735 weston_seat_release(struct weston_seat *seat);
737 /* String literal of spaces, the same width as the timestamp. */
738 #define STAMP_SPACE " "
741 weston_log_file_open(const char *filename);
743 weston_log_file_close(void);
745 weston_log(const char *fmt, ...)
746 __attribute__ ((format (printf, 1, 2)));
748 weston_log_continue(const char *fmt, ...)
749 __attribute__ ((format (printf, 1, 2)));
756 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
759 tty_create(struct weston_compositor *compositor,
760 tty_vt_func_t vt_func, int tty_nr);
763 tty_destroy(struct tty *tty);
766 tty_reset(struct tty *tty);
769 tty_activate_vt(struct tty *tty, int vt);
772 screenshooter_create(struct weston_compositor *ec);
775 clipboard_create(struct weston_seat *seat);
778 text_cursor_position_notifier_create(struct weston_compositor *ec);
781 text_model_factory_create(struct weston_compositor *ec);
784 input_method_create(struct weston_compositor *ec,
785 struct weston_seat *seat);
787 struct weston_process;
788 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
791 struct weston_process {
793 weston_process_cleanup_func_t cleanup;
798 weston_client_launch(struct weston_compositor *compositor,
799 struct weston_process *proc,
801 weston_process_cleanup_func_t cleanup);
804 weston_watch_process(struct weston_process *process);
806 struct weston_surface_animation;
807 typedef void (*weston_surface_animation_done_func_t)(struct weston_surface_animation *animation, void *data);
809 struct weston_surface_animation *
810 weston_zoom_run(struct weston_surface *surface, float start, float stop,
811 weston_surface_animation_done_func_t done, void *data);
813 struct weston_surface_animation *
814 weston_fade_run(struct weston_surface *surface,
815 weston_surface_animation_done_func_t done, void *data);
816 struct weston_surface_animation *
817 weston_slide_run(struct weston_surface *surface, float start, float stop,
818 weston_surface_animation_done_func_t done, void *data);
821 weston_surface_set_color(struct weston_surface *surface,
822 float red, float green, float blue, float alpha);
825 weston_surface_destroy(struct weston_surface *surface);
828 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);
831 gles2_renderer_init(struct weston_compositor *ec);
833 gles2_renderer_destroy(struct weston_compositor *ec);
835 struct weston_compositor *
836 backend_init(struct wl_display *display, int argc, char *argv[],
837 const char *config_file);
840 module_init(struct weston_compositor *compositor);