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;
162 int repaint_scheduled;
163 struct weston_output_zoom zoom;
165 struct wl_signal frame_signal;
172 struct weston_mode *current;
173 struct weston_mode *origin;
174 struct wl_list mode_list;
176 void (*repaint)(struct weston_output *output,
177 pixman_region32_t *damage);
178 void (*destroy)(struct weston_output *output);
179 void (*assign_planes)(struct weston_output *output);
180 int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
182 /* backlight values are on 0-255 range, where higher is brighter */
183 uint32_t backlight_current;
184 void (*set_backlight)(struct weston_output *output, uint32_t value);
185 void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
188 struct weston_xkb_info {
189 struct xkb_keymap *keymap;
193 xkb_mod_index_t shift_mod;
194 xkb_mod_index_t caps_mod;
195 xkb_mod_index_t ctrl_mod;
196 xkb_mod_index_t alt_mod;
197 xkb_mod_index_t mod2_mod;
198 xkb_mod_index_t mod3_mod;
199 xkb_mod_index_t super_mod;
200 xkb_mod_index_t mod5_mod;
201 xkb_led_index_t num_led;
202 xkb_led_index_t caps_led;
203 xkb_led_index_t scroll_led;
208 struct wl_pointer pointer;
210 struct wl_keyboard keyboard;
212 struct wl_touch touch;
215 struct weston_compositor *compositor;
216 struct weston_surface *sprite;
217 struct wl_listener sprite_destroy_listener;
218 struct weston_surface *drag_surface;
219 struct wl_listener drag_surface_destroy_listener;
220 int32_t hotspot_x, hotspot_y;
222 enum weston_keyboard_modifier modifier_state;
223 struct wl_surface *saved_kbd_focus;
224 struct wl_listener saved_kbd_focus_listener;
228 struct wl_listener new_drag_icon_listener;
230 void (*led_update)(struct weston_seat *ws, enum weston_led leds);
232 struct weston_xkb_info xkb_info;
234 struct xkb_state *state;
235 enum weston_led leds;
239 struct weston_shader {
241 GLuint vertex_shader, fragment_shader;
243 GLint tex_uniforms[3];
246 GLint texwidth_uniform;
247 GLint opaque_uniform;
251 WESTON_COMPOSITOR_ACTIVE,
252 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
253 WESTON_COMPOSITOR_SLEEPING /* no rendering, no frame events */
256 struct weston_layer {
257 struct wl_list surface_list;
261 struct weston_plane {
262 pixman_region32_t damage;
266 struct weston_compositor {
268 struct wl_signal destroy_signal;
270 EGLDisplay egl_display;
271 EGLContext egl_context;
272 EGLConfig egl_config;
274 struct weston_shader texture_shader_rgba;
275 struct weston_shader texture_shader_y_uv;
276 struct weston_shader texture_shader_y_u_v;
277 struct weston_shader texture_shader_y_xuxv;
278 struct weston_shader solid_shader;
279 struct weston_shader *current_shader;
280 struct wl_display *wl_display;
281 struct weston_shell_interface shell_interface;
283 struct wl_signal activate_signal;
284 struct wl_signal lock_signal;
285 struct wl_signal unlock_signal;
287 struct wl_signal show_input_panel_signal;
288 struct wl_signal hide_input_panel_signal;
290 struct wl_event_loop *input_loop;
291 struct wl_event_source *input_loop_source;
293 struct weston_layer fade_layer;
294 struct weston_layer cursor_layer;
296 struct wl_list output_list;
297 struct wl_list seat_list;
298 struct wl_list layer_list;
299 struct wl_list surface_list;
300 struct wl_list key_binding_list;
301 struct wl_list button_binding_list;
302 struct wl_list axis_binding_list;
304 struct weston_spring spring;
305 struct weston_animation animation;
306 struct weston_surface *surface;
310 struct wl_event_source *idle_source;
311 uint32_t idle_inhibit;
312 int option_idle_time; /* default timeout, s */
313 int idle_time; /* effective timeout, s */
316 struct wl_array vertices, indices;
317 struct weston_plane primary_plane;
321 PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
322 image_target_renderbuffer_storage;
323 PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
324 PFNEGLCREATEIMAGEKHRPROC create_image;
325 PFNEGLDESTROYIMAGEKHRPROC destroy_image;
327 int has_unpack_subimage;
330 PFNEGLBINDWAYLANDDISPLAYWL bind_display;
331 PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
332 PFNEGLQUERYWAYLANDBUFFERWL query_buffer;
333 int has_bind_display;
335 void (*destroy)(struct weston_compositor *ec);
336 void (*restore)(struct weston_compositor *ec);
337 int (*authenticate)(struct weston_compositor *c, uint32_t id);
339 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
343 uint32_t output_id_pool;
345 struct xkb_rule_names xkb_names;
346 struct xkb_context *xkb_context;
347 struct weston_xkb_info xkb_info;
350 enum weston_output_flags {
351 WL_OUTPUT_FLIPPED = 0x01
354 struct weston_region {
355 struct wl_resource resource;
356 pixman_region32_t region;
359 /* Using weston_surface transformations
361 * To add a transformation to a surface, create a struct weston_transform, and
362 * add it to the list surface->geometry.transformation_list. Whenever you
363 * change the list, anything under surface->geometry, or anything in the
364 * weston_transforms linked into the list, you must set
365 * surface->geometry.dirty = 1.
367 * The order in the list defines the order of transformations. Let the list
368 * contain the transformation matrices M1, ..., Mn as head to tail. The
369 * transformation is applied to surface-local coordinate vector p as
370 * P = Mn * ... * M2 * M1 * p
371 * to produce the global coordinate vector P. The total transform
373 * is cached in surface->transform.matrix, and the inverse of it in
374 * surface->transform.inverse.
376 * The list always contains surface->transform.position transformation, which
377 * is the translation by surface->geometry.x and y.
379 * If you want to apply a transformation in local coordinates, add your
380 * weston_transform to the head of the list. If you want to apply a
381 * transformation in global coordinates, add it to the tail of the list.
384 struct weston_surface {
385 struct wl_surface surface;
386 struct weston_compositor *compositor;
389 pixman_region32_t clip;
390 pixman_region32_t damage;
391 pixman_region32_t opaque;
392 pixman_region32_t input;
395 struct wl_list layer_link;
396 struct weston_shader *shader;
398 GLfloat opaque_rect[4];
401 struct weston_plane *plane;
403 /* Surface geometry state, mutable.
404 * If you change anything, set dirty = 1.
405 * That includes the transformations referenced from the list.
408 GLfloat x, y; /* surface translation on display */
409 int32_t width, height;
411 /* struct weston_transform */
412 struct wl_list transformation_list;
417 /* State derived from geometry state, read-only.
418 * This is updated by weston_surface_update_transform().
421 pixman_region32_t boundingbox;
422 pixman_region32_t opaque;
424 /* matrix and inverse are used only if enabled = 1.
425 * If enabled = 0, use x, y, width, height directly.
428 struct weston_matrix matrix;
429 struct weston_matrix inverse;
431 struct weston_transform position; /* matrix from x, y */
435 * Which output to vsync this surface to.
436 * Used to determine, whether to send or queue frame events.
437 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
439 struct weston_output *output;
442 * A more complete representation of all outputs this surface is
445 uint32_t output_mask;
447 struct wl_list frame_callback_list;
449 EGLImageKHR images[3];
452 struct wl_buffer *buffer;
453 struct wl_listener buffer_destroy_listener;
456 * If non-NULL, this function will be called on surface::attach after
457 * a new buffer has been set up for this surface. The integer params
458 * are the sx and sy paramerters supplied to surface::attach .
460 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
464 enum weston_key_state_update {
465 STATE_UPDATE_AUTOMATIC,
470 weston_surface_update_transform(struct weston_surface *surface);
473 weston_surface_to_global_fixed(struct weston_surface *surface,
474 wl_fixed_t sx, wl_fixed_t sy,
475 wl_fixed_t *x, wl_fixed_t *y);
477 weston_surface_to_global_float(struct weston_surface *surface,
478 GLfloat sx, GLfloat sy, GLfloat *x, GLfloat *y);
481 weston_surface_from_global(struct weston_surface *surface,
482 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
484 weston_surface_from_global_fixed(struct weston_surface *surface,
485 wl_fixed_t x, wl_fixed_t y,
486 wl_fixed_t *sx, wl_fixed_t *sy);
489 weston_spring_init(struct weston_spring *spring,
490 double k, double current, double target);
492 weston_spring_update(struct weston_spring *spring, uint32_t msec);
494 weston_spring_done(struct weston_spring *spring);
497 weston_surface_activate(struct weston_surface *surface,
498 struct weston_seat *seat);
500 weston_surface_draw(struct weston_surface *es,
501 struct weston_output *output, pixman_region32_t *damage);
504 notify_motion(struct wl_seat *seat, uint32_t time,
505 wl_fixed_t x, wl_fixed_t y);
507 notify_button(struct wl_seat *seat, uint32_t time, int32_t button,
508 enum wl_pointer_button_state state);
510 notify_axis(struct wl_seat *seat, uint32_t time, uint32_t axis,
513 notify_key(struct wl_seat *seat, uint32_t time, uint32_t key,
514 enum wl_keyboard_key_state state,
515 enum weston_key_state_update update_state);
517 notify_modifiers(struct wl_seat *seat, uint32_t serial);
520 notify_pointer_focus(struct wl_seat *seat, struct weston_output *output,
521 wl_fixed_t x, wl_fixed_t y);
524 notify_keyboard_focus_in(struct wl_seat *seat, struct wl_array *keys,
525 enum weston_key_state_update update_state);
527 notify_keyboard_focus_out(struct wl_seat *seat);
530 notify_touch(struct wl_seat *seat, uint32_t time, int touch_id,
531 wl_fixed_t x, wl_fixed_t y, int touch_type);
534 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
537 weston_plane_init(struct weston_plane *plane, int32_t x, int32_t y);
539 weston_plane_release(struct weston_plane *plane);
542 weston_output_finish_frame(struct weston_output *output, uint32_t msecs);
544 weston_output_schedule_repaint(struct weston_output *output);
546 weston_output_damage(struct weston_output *output);
548 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
550 weston_compositor_fade(struct weston_compositor *compositor, float tint);
552 weston_compositor_damage_all(struct weston_compositor *compositor);
554 weston_compositor_unlock(struct weston_compositor *compositor);
556 weston_compositor_wake(struct weston_compositor *compositor);
558 weston_compositor_activity(struct weston_compositor *compositor);
560 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
563 struct weston_binding;
564 typedef void (*weston_key_binding_handler_t)(struct wl_seat *seat,
565 uint32_t time, uint32_t key,
567 struct weston_binding *
568 weston_compositor_add_key_binding(struct weston_compositor *compositor,
570 enum weston_keyboard_modifier modifier,
571 weston_key_binding_handler_t binding,
574 typedef void (*weston_button_binding_handler_t)(struct wl_seat *seat,
575 uint32_t time, uint32_t button,
577 struct weston_binding *
578 weston_compositor_add_button_binding(struct weston_compositor *compositor,
580 enum weston_keyboard_modifier modifier,
581 weston_button_binding_handler_t binding,
584 typedef void (*weston_axis_binding_handler_t)(struct wl_seat *seat,
585 uint32_t time, uint32_t axis,
586 wl_fixed_t value, void *data);
587 struct weston_binding *
588 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
590 enum weston_keyboard_modifier modifier,
591 weston_axis_binding_handler_t binding,
594 weston_binding_destroy(struct weston_binding *binding);
597 weston_binding_list_destroy_all(struct wl_list *list);
600 weston_compositor_run_key_binding(struct weston_compositor *compositor,
601 struct weston_seat *seat, uint32_t time,
603 enum wl_keyboard_key_state state);
605 weston_compositor_run_button_binding(struct weston_compositor *compositor,
606 struct weston_seat *seat, uint32_t time,
608 enum wl_pointer_button_state value);
610 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
611 struct weston_seat *seat, uint32_t time,
612 uint32_t axis, int32_t value);
615 weston_environment_get_fd(const char *env);
618 weston_compositor_top(struct weston_compositor *compositor);
620 struct weston_surface *
621 weston_surface_create(struct weston_compositor *compositor);
624 weston_surface_configure(struct weston_surface *surface,
625 GLfloat x, GLfloat y, int width, int height);
628 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
631 weston_surface_set_position(struct weston_surface *surface,
632 GLfloat x, GLfloat y);
635 weston_surface_is_mapped(struct weston_surface *surface);
638 weston_surface_assign_output(struct weston_surface *surface);
641 weston_surface_schedule_repaint(struct weston_surface *surface);
644 weston_surface_damage(struct weston_surface *surface);
647 weston_surface_damage_below(struct weston_surface *surface);
650 weston_surface_move_to_plane(struct weston_surface *surface,
651 struct weston_plane *plane);
653 weston_surface_unmap(struct weston_surface *surface);
656 weston_buffer_post_release(struct wl_buffer *buffer);
659 weston_compositor_get_time(void);
662 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display,
663 int argc, char *argv[], const char *config_file);
665 weston_compositor_init_gl(struct weston_compositor *ec);
667 weston_compositor_shutdown(struct weston_compositor *ec);
669 weston_text_cursor_position_notify(struct weston_surface *surface,
670 wl_fixed_t x, wl_fixed_t y);
672 weston_output_init_zoom(struct weston_output *output);
674 weston_output_update_zoom(struct weston_output *output, uint32_t type);
676 weston_output_update_matrix(struct weston_output *output);
678 weston_output_move(struct weston_output *output, int x, int y);
680 weston_output_init(struct weston_output *output, struct weston_compositor *c,
681 int x, int y, int width, int height);
683 weston_output_destroy(struct weston_output *output);
686 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
688 weston_seat_init_pointer(struct weston_seat *seat);
690 weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
692 weston_seat_init_touch(struct weston_seat *seat);
695 weston_seat_release(struct weston_seat *seat);
697 /* String literal of spaces, the same width as the timestamp. */
698 #define STAMP_SPACE " "
701 weston_log_file_open(const char *filename);
703 weston_log_file_close(void);
705 weston_log(const char *fmt, ...)
706 __attribute__ ((format (printf, 1, 2)));
708 weston_log_continue(const char *fmt, ...)
709 __attribute__ ((format (printf, 1, 2)));
716 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
719 tty_create(struct weston_compositor *compositor,
720 tty_vt_func_t vt_func, int tty_nr);
723 tty_destroy(struct tty *tty);
726 tty_reset(struct tty *tty);
729 tty_activate_vt(struct tty *tty, int vt);
732 screenshooter_create(struct weston_compositor *ec);
735 clipboard_create(struct weston_seat *seat);
738 text_cursor_position_notifier_create(struct weston_compositor *ec);
741 input_method_create(struct weston_compositor *ec);
743 struct weston_process;
744 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
747 struct weston_process {
749 weston_process_cleanup_func_t cleanup;
754 weston_client_launch(struct weston_compositor *compositor,
755 struct weston_process *proc,
757 weston_process_cleanup_func_t cleanup);
760 weston_watch_process(struct weston_process *process);
763 weston_xserver_init(struct weston_compositor *compositor);
765 struct weston_surface_animation;
766 typedef void (*weston_surface_animation_done_func_t)(struct weston_surface_animation *animation, void *data);
768 struct weston_surface_animation *
769 weston_zoom_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
770 weston_surface_animation_done_func_t done, void *data);
772 struct weston_surface_animation *
773 weston_fade_run(struct weston_surface *surface,
774 weston_surface_animation_done_func_t done, void *data);
775 struct weston_surface_animation *
776 weston_slide_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
777 weston_surface_animation_done_func_t done, void *data);
780 weston_surface_set_color(struct weston_surface *surface,
781 GLfloat red, GLfloat green, GLfloat blue, GLfloat alpha);
784 weston_surface_destroy(struct weston_surface *surface);
786 struct weston_compositor *
787 backend_init(struct wl_display *display, int argc, char *argv[],
788 const char *config_file);
791 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);