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 #define container_of(ptr, type, member) ({ \
43 const __typeof__( ((type *)0)->member ) *__mptr = (ptr); \
44 (type *)( (char *)__mptr - offsetof(type,member) );})
46 struct weston_transform {
47 struct weston_matrix matrix;
51 struct weston_surface;
57 enum weston_keyboard_modifier {
58 MODIFIER_CTRL = (1 << 0),
59 MODIFIER_ALT = (1 << 1),
60 MODIFIER_SUPER = (1 << 2),
61 MODIFIER_SHIFT = (1 << 3),
65 LED_NUM_LOCK = (1 << 0),
66 LED_CAPS_LOCK = (1 << 1),
67 LED_SCROLL_LOCK = (1 << 2),
72 int32_t width, height;
77 struct weston_shell_client {
78 void (*send_configure)(struct weston_surface *surface,
79 uint32_t edges, int32_t width, int32_t height);
82 struct weston_shell_interface {
83 void *shell; /* either desktop or tablet */
85 struct shell_surface *(*create_shell_surface)(void *shell,
86 struct weston_surface *surface,
87 const struct weston_shell_client *client);
89 void (*set_toplevel)(struct shell_surface *shsurf);
91 void (*set_transient)(struct shell_surface *shsurf,
92 struct weston_surface *parent,
93 int x, int y, uint32_t flags);
94 int (*move)(struct shell_surface *shsurf, struct weston_seat *ws);
95 int (*resize)(struct shell_surface *shsurf,
96 struct weston_seat *ws, uint32_t edges);
100 struct weston_border {
101 int32_t left, right, top, bottom;
104 struct weston_animation {
105 void (*frame)(struct weston_animation *animation,
106 struct weston_output *output, uint32_t msecs);
111 struct weston_spring {
125 struct weston_fixed_point {
129 struct weston_output_zoom {
135 float trans_x, trans_y;
136 struct weston_animation animation_z;
137 struct weston_spring spring_z;
138 struct weston_animation animation_xy;
139 struct weston_spring spring_xy;
140 struct weston_fixed_point from;
141 struct weston_fixed_point to;
142 struct weston_fixed_point current;
143 struct weston_fixed_point text_cursor;
146 /* bit compatible with drm definitions. */
154 struct weston_output {
157 EGLSurface egl_surface;
159 struct wl_list resource_list;
160 struct wl_global *global;
161 struct weston_compositor *compositor;
162 struct weston_matrix matrix;
163 struct wl_list animation_list;
164 int32_t x, y, width, height;
165 int32_t mm_width, mm_height;
166 struct weston_border border;
167 pixman_region32_t region;
169 pixman_region32_t buffer_damage[2];
171 int repaint_scheduled;
172 struct weston_output_zoom zoom;
174 struct wl_signal frame_signal;
182 struct weston_mode *current;
183 struct weston_mode *origin;
184 struct wl_list mode_list;
186 void (*repaint)(struct weston_output *output,
187 pixman_region32_t *damage);
188 void (*destroy)(struct weston_output *output);
189 void (*assign_planes)(struct weston_output *output);
190 int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
192 /* backlight values are on 0-255 range, where higher is brighter */
193 uint32_t backlight_current;
194 void (*set_backlight)(struct weston_output *output, uint32_t value);
195 void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
198 struct weston_xkb_info {
199 struct xkb_keymap *keymap;
203 xkb_mod_index_t shift_mod;
204 xkb_mod_index_t caps_mod;
205 xkb_mod_index_t ctrl_mod;
206 xkb_mod_index_t alt_mod;
207 xkb_mod_index_t mod2_mod;
208 xkb_mod_index_t mod3_mod;
209 xkb_mod_index_t super_mod;
210 xkb_mod_index_t mod5_mod;
211 xkb_led_index_t num_led;
212 xkb_led_index_t caps_led;
213 xkb_led_index_t scroll_led;
218 struct wl_pointer pointer;
220 struct wl_keyboard keyboard;
222 struct wl_touch touch;
225 struct weston_compositor *compositor;
226 struct weston_surface *sprite;
227 struct wl_listener sprite_destroy_listener;
228 struct weston_surface *drag_surface;
229 struct wl_listener drag_surface_destroy_listener;
230 int32_t hotspot_x, hotspot_y;
232 enum weston_keyboard_modifier modifier_state;
233 struct wl_surface *saved_kbd_focus;
234 struct wl_listener saved_kbd_focus_listener;
238 struct wl_listener new_drag_icon_listener;
240 void (*led_update)(struct weston_seat *ws, enum weston_led leds);
242 struct weston_xkb_info xkb_info;
244 struct xkb_state *state;
245 enum weston_led leds;
248 struct input_method *input_method;
251 struct weston_shader {
253 GLuint vertex_shader, fragment_shader;
255 GLint tex_uniforms[3];
261 WESTON_COMPOSITOR_ACTIVE,
262 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
263 WESTON_COMPOSITOR_SLEEPING /* no rendering, no frame events */
266 struct weston_layer {
267 struct wl_list surface_list;
271 struct weston_plane {
272 pixman_region32_t damage;
273 pixman_region32_t opaque;
277 struct weston_renderer {
278 void (*repaint_output)(struct weston_output *output,
279 pixman_region32_t *output_damage);
280 void (*flush_damage)(struct weston_surface *surface);
281 void (*attach)(struct weston_surface *es, struct wl_buffer *buffer);
282 void (*destroy_surface)(struct weston_surface *surface);
285 struct weston_compositor {
286 struct wl_signal destroy_signal;
288 EGLDisplay egl_display;
289 EGLContext egl_context;
290 EGLConfig egl_config;
291 struct weston_shader texture_shader_rgba;
292 struct weston_shader texture_shader_rgbx;
293 struct weston_shader texture_shader_egl_external;
294 struct weston_shader texture_shader_y_uv;
295 struct weston_shader texture_shader_y_u_v;
296 struct weston_shader texture_shader_y_xuxv;
297 struct weston_shader solid_shader;
298 struct weston_shader *current_shader;
299 struct wl_display *wl_display;
300 struct weston_shell_interface shell_interface;
302 struct wl_signal activate_signal;
303 struct wl_signal kill_signal;
304 struct wl_signal lock_signal;
305 struct wl_signal unlock_signal;
307 struct wl_signal show_input_panel_signal;
308 struct wl_signal hide_input_panel_signal;
310 struct wl_event_loop *input_loop;
311 struct wl_event_source *input_loop_source;
313 struct weston_layer fade_layer;
314 struct weston_layer cursor_layer;
316 struct wl_list output_list;
317 struct wl_list seat_list;
318 struct wl_list layer_list;
319 struct wl_list surface_list;
320 struct wl_list key_binding_list;
321 struct wl_list button_binding_list;
322 struct wl_list axis_binding_list;
324 struct weston_spring spring;
325 struct weston_animation animation;
326 struct weston_surface *surface;
330 struct wl_event_source *idle_source;
331 uint32_t idle_inhibit;
332 int option_idle_time; /* default timeout, s */
333 int idle_time; /* effective timeout, s */
336 struct wl_array vertices;
337 struct wl_array indices; /* only used in compositor-wayland */
338 struct wl_array vtxcnt;
339 struct weston_plane primary_plane;
344 struct weston_renderer *renderer;
346 PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
347 image_target_renderbuffer_storage;
348 PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
349 PFNEGLCREATEIMAGEKHRPROC create_image;
350 PFNEGLDESTROYIMAGEKHRPROC destroy_image;
352 int has_unpack_subimage;
355 PFNEGLBINDWAYLANDDISPLAYWL bind_display;
356 PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
357 PFNEGLQUERYWAYLANDBUFFERWL query_buffer;
358 int has_bind_display;
360 void (*destroy)(struct weston_compositor *ec);
361 void (*restore)(struct weston_compositor *ec);
362 int (*authenticate)(struct weston_compositor *c, uint32_t id);
364 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
368 uint32_t output_id_pool;
370 struct xkb_rule_names xkb_names;
371 struct xkb_context *xkb_context;
372 struct weston_xkb_info xkb_info;
375 struct weston_region {
376 struct wl_resource resource;
377 pixman_region32_t region;
380 /* Using weston_surface transformations
382 * To add a transformation to a surface, create a struct weston_transform, and
383 * add it to the list surface->geometry.transformation_list. Whenever you
384 * change the list, anything under surface->geometry, or anything in the
385 * weston_transforms linked into the list, you must set
386 * surface->geometry.dirty = 1.
388 * The order in the list defines the order of transformations. Let the list
389 * contain the transformation matrices M1, ..., Mn as head to tail. The
390 * transformation is applied to surface-local coordinate vector p as
391 * P = Mn * ... * M2 * M1 * p
392 * to produce the global coordinate vector P. The total transform
394 * is cached in surface->transform.matrix, and the inverse of it in
395 * surface->transform.inverse.
397 * The list always contains surface->transform.position transformation, which
398 * is the translation by surface->geometry.x and y.
400 * If you want to apply a transformation in local coordinates, add your
401 * weston_transform to the head of the list. If you want to apply a
402 * transformation in global coordinates, add it to the tail of the list.
405 struct weston_surface {
406 struct wl_surface surface;
407 struct weston_compositor *compositor;
410 pixman_region32_t clip;
411 pixman_region32_t damage;
412 pixman_region32_t opaque;
413 pixman_region32_t input;
416 struct wl_list layer_link;
417 struct weston_shader *shader;
420 struct weston_plane *plane;
422 /* Surface geometry state, mutable.
423 * If you change anything, set dirty = 1.
424 * That includes the transformations referenced from the list.
427 float x, y; /* surface translation on display */
428 int32_t width, height;
430 /* struct weston_transform */
431 struct wl_list transformation_list;
436 /* State derived from geometry state, read-only.
437 * This is updated by weston_surface_update_transform().
440 pixman_region32_t boundingbox;
441 pixman_region32_t opaque;
443 /* matrix and inverse are used only if enabled = 1.
444 * If enabled = 0, use x, y, width, height directly.
447 struct weston_matrix matrix;
448 struct weston_matrix inverse;
450 struct weston_transform position; /* matrix from x, y */
454 * Which output to vsync this surface to.
455 * Used to determine, whether to send or queue frame events.
456 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
458 struct weston_output *output;
461 * A more complete representation of all outputs this surface is
464 uint32_t output_mask;
466 struct wl_list frame_callback_list;
468 EGLImageKHR images[3];
472 struct wl_buffer *buffer;
473 struct wl_listener buffer_destroy_listener;
475 /* All the pending state, that wl_surface.commit will apply. */
477 /* wl_surface.attach */
479 struct wl_buffer *buffer;
480 struct wl_listener buffer_destroy_listener;
484 /* wl_surface.damage */
485 pixman_region32_t damage;
487 /* wl_surface.set_opaque_region */
488 pixman_region32_t opaque;
490 /* wl_surface.set_input_region */
491 pixman_region32_t input;
493 /* wl_surface.frame */
494 struct wl_list frame_callback_list;
498 * If non-NULL, this function will be called on surface::attach after
499 * a new buffer has been set up for this surface. The integer params
500 * are the sx and sy paramerters supplied to surface::attach .
502 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
506 enum weston_key_state_update {
507 STATE_UPDATE_AUTOMATIC,
512 weston_surface_update_transform(struct weston_surface *surface);
515 weston_surface_to_global_fixed(struct weston_surface *surface,
516 wl_fixed_t sx, wl_fixed_t sy,
517 wl_fixed_t *x, wl_fixed_t *y);
519 weston_surface_to_global_float(struct weston_surface *surface,
520 float sx, float sy, float *x, float *y);
523 weston_surface_from_global_float(struct weston_surface *surface,
524 float x, float y, float *sx, float *sy);
526 weston_surface_from_global(struct weston_surface *surface,
527 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
529 weston_surface_from_global_fixed(struct weston_surface *surface,
530 wl_fixed_t x, wl_fixed_t y,
531 wl_fixed_t *sx, wl_fixed_t *sy);
534 weston_spring_init(struct weston_spring *spring,
535 double k, double current, double target);
537 weston_spring_update(struct weston_spring *spring, uint32_t msec);
539 weston_spring_done(struct weston_spring *spring);
542 weston_surface_activate(struct weston_surface *surface,
543 struct weston_seat *seat);
545 notify_motion(struct weston_seat *seat, uint32_t time,
546 wl_fixed_t x, wl_fixed_t y);
548 notify_button(struct weston_seat *seat, uint32_t time, int32_t button,
549 enum wl_pointer_button_state state);
551 notify_axis(struct weston_seat *seat, uint32_t time, uint32_t axis,
554 notify_key(struct weston_seat *seat, uint32_t time, uint32_t key,
555 enum wl_keyboard_key_state state,
556 enum weston_key_state_update update_state);
558 notify_modifiers(struct weston_seat *seat, uint32_t serial);
561 notify_pointer_focus(struct weston_seat *seat, struct weston_output *output,
562 wl_fixed_t x, wl_fixed_t y);
565 notify_keyboard_focus_in(struct weston_seat *seat, struct wl_array *keys,
566 enum weston_key_state_update update_state);
568 notify_keyboard_focus_out(struct weston_seat *seat);
571 notify_touch(struct weston_seat *seat, uint32_t time, int touch_id,
572 wl_fixed_t x, wl_fixed_t y, int touch_type);
575 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
578 weston_plane_init(struct weston_plane *plane, int32_t x, int32_t y);
580 weston_plane_release(struct weston_plane *plane);
583 weston_output_finish_frame(struct weston_output *output, uint32_t msecs);
585 weston_output_schedule_repaint(struct weston_output *output);
587 weston_output_damage(struct weston_output *output);
589 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
591 weston_compositor_fade(struct weston_compositor *compositor, float tint);
593 weston_compositor_damage_all(struct weston_compositor *compositor);
595 weston_compositor_unlock(struct weston_compositor *compositor);
597 weston_compositor_wake(struct weston_compositor *compositor);
599 weston_compositor_activity(struct weston_compositor *compositor);
601 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
604 struct weston_binding;
605 typedef void (*weston_key_binding_handler_t)(struct wl_seat *seat,
606 uint32_t time, uint32_t key,
608 struct weston_binding *
609 weston_compositor_add_key_binding(struct weston_compositor *compositor,
611 enum weston_keyboard_modifier modifier,
612 weston_key_binding_handler_t binding,
615 typedef void (*weston_button_binding_handler_t)(struct wl_seat *seat,
616 uint32_t time, uint32_t button,
618 struct weston_binding *
619 weston_compositor_add_button_binding(struct weston_compositor *compositor,
621 enum weston_keyboard_modifier modifier,
622 weston_button_binding_handler_t binding,
625 typedef void (*weston_axis_binding_handler_t)(struct wl_seat *seat,
626 uint32_t time, uint32_t axis,
627 wl_fixed_t value, void *data);
628 struct weston_binding *
629 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
631 enum weston_keyboard_modifier modifier,
632 weston_axis_binding_handler_t binding,
635 weston_binding_destroy(struct weston_binding *binding);
638 weston_binding_list_destroy_all(struct wl_list *list);
641 weston_compositor_run_key_binding(struct weston_compositor *compositor,
642 struct weston_seat *seat, uint32_t time,
644 enum wl_keyboard_key_state state);
646 weston_compositor_run_button_binding(struct weston_compositor *compositor,
647 struct weston_seat *seat, uint32_t time,
649 enum wl_pointer_button_state value);
651 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
652 struct weston_seat *seat, uint32_t time,
653 uint32_t axis, int32_t value);
656 weston_environment_get_fd(const char *env);
659 weston_compositor_top(struct weston_compositor *compositor);
661 struct weston_surface *
662 weston_surface_create(struct weston_compositor *compositor);
665 weston_surface_configure(struct weston_surface *surface,
666 float x, float y, int width, int height);
669 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
672 weston_surface_set_position(struct weston_surface *surface,
676 weston_surface_is_mapped(struct weston_surface *surface);
679 weston_surface_schedule_repaint(struct weston_surface *surface);
682 weston_surface_damage(struct weston_surface *surface);
685 weston_surface_damage_below(struct weston_surface *surface);
688 weston_surface_move_to_plane(struct weston_surface *surface,
689 struct weston_plane *plane);
691 weston_surface_unmap(struct weston_surface *surface);
694 weston_buffer_post_release(struct wl_buffer *buffer);
697 weston_compositor_get_time(void);
700 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display,
701 int argc, char *argv[], const char *config_file);
703 weston_compositor_shutdown(struct weston_compositor *ec);
705 weston_text_cursor_position_notify(struct weston_surface *surface,
706 wl_fixed_t x, wl_fixed_t y);
708 weston_output_init_zoom(struct weston_output *output);
710 weston_output_update_zoom(struct weston_output *output, uint32_t type);
712 weston_output_update_matrix(struct weston_output *output);
714 weston_output_move(struct weston_output *output, int x, int y);
716 weston_output_init(struct weston_output *output, struct weston_compositor *c,
717 int x, int y, int width, int height, uint32_t transform);
719 weston_output_destroy(struct weston_output *output);
722 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
724 weston_seat_init_pointer(struct weston_seat *seat);
726 weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
728 weston_seat_init_touch(struct weston_seat *seat);
731 weston_seat_release(struct weston_seat *seat);
733 /* String literal of spaces, the same width as the timestamp. */
734 #define STAMP_SPACE " "
737 weston_log_file_open(const char *filename);
739 weston_log_file_close(void);
741 weston_log(const char *fmt, ...)
742 __attribute__ ((format (printf, 1, 2)));
744 weston_log_continue(const char *fmt, ...)
745 __attribute__ ((format (printf, 1, 2)));
752 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
755 tty_create(struct weston_compositor *compositor,
756 tty_vt_func_t vt_func, int tty_nr);
759 tty_destroy(struct tty *tty);
762 tty_reset(struct tty *tty);
765 tty_activate_vt(struct tty *tty, int vt);
768 screenshooter_create(struct weston_compositor *ec);
771 clipboard_create(struct weston_seat *seat);
774 text_cursor_position_notifier_create(struct weston_compositor *ec);
777 text_model_factory_create(struct weston_compositor *ec);
780 input_method_create(struct weston_compositor *ec,
781 struct weston_seat *seat);
783 struct weston_process;
784 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
787 struct weston_process {
789 weston_process_cleanup_func_t cleanup;
794 weston_client_launch(struct weston_compositor *compositor,
795 struct weston_process *proc,
797 weston_process_cleanup_func_t cleanup);
800 weston_watch_process(struct weston_process *process);
802 struct weston_surface_animation;
803 typedef void (*weston_surface_animation_done_func_t)(struct weston_surface_animation *animation, void *data);
805 struct weston_surface_animation *
806 weston_zoom_run(struct weston_surface *surface, float start, float stop,
807 weston_surface_animation_done_func_t done, void *data);
809 struct weston_surface_animation *
810 weston_fade_run(struct weston_surface *surface,
811 weston_surface_animation_done_func_t done, void *data);
812 struct weston_surface_animation *
813 weston_slide_run(struct weston_surface *surface, float start, float stop,
814 weston_surface_animation_done_func_t done, void *data);
817 weston_surface_set_color(struct weston_surface *surface,
818 float red, float green, float blue, float alpha);
821 weston_surface_destroy(struct weston_surface *surface);
824 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);
827 gles2_renderer_init(struct weston_compositor *ec);
829 gles2_renderer_destroy(struct weston_compositor *ec);
831 struct weston_compositor *
832 backend_init(struct wl_display *display, int argc, char *argv[],
833 const char *config_file);
836 module_init(struct weston_compositor *compositor);