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;
52 enum weston_keyboard_modifier {
53 MODIFIER_CTRL = (1 << 0),
54 MODIFIER_ALT = (1 << 1),
55 MODIFIER_SUPER = (1 << 2),
56 MODIFIER_SHIFT = (1 << 3),
60 LED_NUM_LOCK = (1 << 0),
61 LED_CAPS_LOCK = (1 << 1),
62 LED_SCROLL_LOCK = (1 << 2),
67 int32_t width, height;
72 struct weston_shell_client {
73 void (*send_configure)(struct weston_surface *surface,
74 uint32_t edges, int32_t width, int32_t height);
77 struct weston_shell_interface {
78 void *shell; /* either desktop or tablet */
80 struct shell_surface *(*create_shell_surface)(void *shell,
81 struct weston_surface *surface,
82 const struct weston_shell_client *client);
84 void (*set_toplevel)(struct shell_surface *shsurf);
86 void (*set_transient)(struct shell_surface *shsurf,
87 struct weston_surface *parent,
88 int x, int y, uint32_t flags);
89 int (*move)(struct shell_surface *shsurf, struct weston_seat *ws);
90 int (*resize)(struct shell_surface *shsurf,
91 struct weston_seat *ws, uint32_t edges);
95 struct weston_border {
96 int32_t left, right, top, bottom;
99 struct weston_animation {
100 void (*frame)(struct weston_animation *animation,
101 struct weston_output *output, uint32_t msecs);
106 struct weston_spring {
120 struct weston_fixed_point {
124 struct weston_output_zoom {
130 float trans_x, trans_y;
131 struct weston_animation animation_z;
132 struct weston_spring spring_z;
133 struct weston_animation animation_xy;
134 struct weston_spring spring_xy;
135 struct weston_fixed_point from;
136 struct weston_fixed_point to;
137 struct weston_fixed_point current;
138 struct weston_fixed_point text_cursor;
141 /* bit compatible with drm definitions. */
149 struct weston_output {
152 EGLSurface egl_surface;
154 struct wl_list resource_list;
155 struct wl_global *global;
156 struct weston_compositor *compositor;
157 struct weston_matrix matrix;
158 struct wl_list animation_list;
159 int32_t x, y, width, height;
160 int32_t mm_width, mm_height;
161 struct weston_border border;
162 pixman_region32_t region;
163 pixman_region32_t previous_damage;
165 int repaint_scheduled;
166 struct weston_output_zoom zoom;
168 struct wl_signal frame_signal;
176 struct weston_mode *current;
177 struct weston_mode *origin;
178 struct wl_list mode_list;
180 void (*repaint)(struct weston_output *output,
181 pixman_region32_t *damage);
182 void (*destroy)(struct weston_output *output);
183 void (*assign_planes)(struct weston_output *output);
184 int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
186 /* backlight values are on 0-255 range, where higher is brighter */
187 uint32_t backlight_current;
188 void (*set_backlight)(struct weston_output *output, uint32_t value);
189 void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
192 struct weston_xkb_info {
193 struct xkb_keymap *keymap;
197 xkb_mod_index_t shift_mod;
198 xkb_mod_index_t caps_mod;
199 xkb_mod_index_t ctrl_mod;
200 xkb_mod_index_t alt_mod;
201 xkb_mod_index_t mod2_mod;
202 xkb_mod_index_t mod3_mod;
203 xkb_mod_index_t super_mod;
204 xkb_mod_index_t mod5_mod;
205 xkb_led_index_t num_led;
206 xkb_led_index_t caps_led;
207 xkb_led_index_t scroll_led;
212 struct wl_pointer pointer;
214 struct wl_keyboard keyboard;
216 struct wl_touch touch;
219 struct weston_compositor *compositor;
220 struct weston_surface *sprite;
221 struct wl_listener sprite_destroy_listener;
222 struct weston_surface *drag_surface;
223 struct wl_listener drag_surface_destroy_listener;
224 int32_t hotspot_x, hotspot_y;
226 enum weston_keyboard_modifier modifier_state;
227 struct wl_surface *saved_kbd_focus;
228 struct wl_listener saved_kbd_focus_listener;
232 struct wl_listener new_drag_icon_listener;
234 void (*led_update)(struct weston_seat *ws, enum weston_led leds);
236 struct weston_xkb_info xkb_info;
238 struct xkb_state *state;
239 enum weston_led leds;
242 struct input_method *input_method;
245 struct weston_shader {
247 GLuint vertex_shader, fragment_shader;
249 GLint tex_uniforms[3];
255 WESTON_COMPOSITOR_ACTIVE,
256 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
257 WESTON_COMPOSITOR_SLEEPING /* no rendering, no frame events */
260 struct weston_layer {
261 struct wl_list surface_list;
265 struct weston_plane {
266 pixman_region32_t damage;
270 struct weston_renderer {
271 void (*repaint_output)(struct weston_output *output,
272 pixman_region32_t *output_damage);
273 void (*flush_damage)(struct weston_surface *surface);
274 void (*attach)(struct weston_surface *es, struct wl_buffer *buffer);
275 void (*destroy_surface)(struct weston_surface *surface);
278 struct weston_compositor {
279 struct wl_signal destroy_signal;
281 EGLDisplay egl_display;
282 EGLContext egl_context;
283 EGLConfig egl_config;
284 struct weston_shader texture_shader_rgba;
285 struct weston_shader texture_shader_rgbx;
286 struct weston_shader texture_shader_egl_external;
287 struct weston_shader texture_shader_y_uv;
288 struct weston_shader texture_shader_y_u_v;
289 struct weston_shader texture_shader_y_xuxv;
290 struct weston_shader solid_shader;
291 struct weston_shader *current_shader;
292 struct wl_display *wl_display;
293 struct weston_shell_interface shell_interface;
295 struct wl_signal activate_signal;
296 struct wl_signal lock_signal;
297 struct wl_signal unlock_signal;
299 struct wl_signal show_input_panel_signal;
300 struct wl_signal hide_input_panel_signal;
302 struct wl_event_loop *input_loop;
303 struct wl_event_source *input_loop_source;
305 struct weston_layer fade_layer;
306 struct weston_layer cursor_layer;
308 struct wl_list output_list;
309 struct wl_list seat_list;
310 struct wl_list layer_list;
311 struct wl_list surface_list;
312 struct wl_list key_binding_list;
313 struct wl_list button_binding_list;
314 struct wl_list axis_binding_list;
316 struct weston_spring spring;
317 struct weston_animation animation;
318 struct weston_surface *surface;
322 struct wl_event_source *idle_source;
323 uint32_t idle_inhibit;
324 int option_idle_time; /* default timeout, s */
325 int idle_time; /* effective timeout, s */
328 struct wl_array vertices;
329 struct wl_array indices; /* only used in compositor-wayland */
330 struct wl_array vtxcnt;
331 struct weston_plane primary_plane;
336 struct weston_renderer *renderer;
338 PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
339 image_target_renderbuffer_storage;
340 PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
341 PFNEGLCREATEIMAGEKHRPROC create_image;
342 PFNEGLDESTROYIMAGEKHRPROC destroy_image;
344 int has_unpack_subimage;
347 PFNEGLBINDWAYLANDDISPLAYWL bind_display;
348 PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
349 PFNEGLQUERYWAYLANDBUFFERWL query_buffer;
350 int has_bind_display;
352 void (*destroy)(struct weston_compositor *ec);
353 void (*restore)(struct weston_compositor *ec);
354 int (*authenticate)(struct weston_compositor *c, uint32_t id);
356 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
360 uint32_t output_id_pool;
362 struct xkb_rule_names xkb_names;
363 struct xkb_context *xkb_context;
364 struct weston_xkb_info xkb_info;
367 struct weston_region {
368 struct wl_resource resource;
369 pixman_region32_t region;
372 /* Using weston_surface transformations
374 * To add a transformation to a surface, create a struct weston_transform, and
375 * add it to the list surface->geometry.transformation_list. Whenever you
376 * change the list, anything under surface->geometry, or anything in the
377 * weston_transforms linked into the list, you must set
378 * surface->geometry.dirty = 1.
380 * The order in the list defines the order of transformations. Let the list
381 * contain the transformation matrices M1, ..., Mn as head to tail. The
382 * transformation is applied to surface-local coordinate vector p as
383 * P = Mn * ... * M2 * M1 * p
384 * to produce the global coordinate vector P. The total transform
386 * is cached in surface->transform.matrix, and the inverse of it in
387 * surface->transform.inverse.
389 * The list always contains surface->transform.position transformation, which
390 * is the translation by surface->geometry.x and y.
392 * If you want to apply a transformation in local coordinates, add your
393 * weston_transform to the head of the list. If you want to apply a
394 * transformation in global coordinates, add it to the tail of the list.
397 struct weston_surface {
398 struct wl_surface surface;
399 struct weston_compositor *compositor;
402 pixman_region32_t clip;
403 pixman_region32_t damage;
404 pixman_region32_t opaque;
405 pixman_region32_t input;
408 struct wl_list layer_link;
409 struct weston_shader *shader;
412 struct weston_plane *plane;
414 /* Surface geometry state, mutable.
415 * If you change anything, set dirty = 1.
416 * That includes the transformations referenced from the list.
419 GLfloat x, y; /* surface translation on display */
420 int32_t width, height;
422 /* struct weston_transform */
423 struct wl_list transformation_list;
428 /* State derived from geometry state, read-only.
429 * This is updated by weston_surface_update_transform().
432 pixman_region32_t boundingbox;
433 pixman_region32_t opaque;
435 /* matrix and inverse are used only if enabled = 1.
436 * If enabled = 0, use x, y, width, height directly.
439 struct weston_matrix matrix;
440 struct weston_matrix inverse;
442 struct weston_transform position; /* matrix from x, y */
446 * Which output to vsync this surface to.
447 * Used to determine, whether to send or queue frame events.
448 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
450 struct weston_output *output;
453 * A more complete representation of all outputs this surface is
456 uint32_t output_mask;
458 struct wl_list frame_callback_list;
460 EGLImageKHR images[3];
464 struct wl_buffer *buffer;
465 struct wl_listener buffer_destroy_listener;
468 * If non-NULL, this function will be called on surface::attach after
469 * a new buffer has been set up for this surface. The integer params
470 * are the sx and sy paramerters supplied to surface::attach .
472 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
476 enum weston_key_state_update {
477 STATE_UPDATE_AUTOMATIC,
482 weston_surface_update_transform(struct weston_surface *surface);
485 weston_surface_to_global_fixed(struct weston_surface *surface,
486 wl_fixed_t sx, wl_fixed_t sy,
487 wl_fixed_t *x, wl_fixed_t *y);
489 weston_surface_to_global_float(struct weston_surface *surface,
490 GLfloat sx, GLfloat sy, GLfloat *x, GLfloat *y);
493 weston_surface_from_global_float(struct weston_surface *surface,
494 GLfloat x, GLfloat y, GLfloat *sx, GLfloat *sy);
496 weston_surface_from_global(struct weston_surface *surface,
497 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
499 weston_surface_from_global_fixed(struct weston_surface *surface,
500 wl_fixed_t x, wl_fixed_t y,
501 wl_fixed_t *sx, wl_fixed_t *sy);
504 weston_spring_init(struct weston_spring *spring,
505 double k, double current, double target);
507 weston_spring_update(struct weston_spring *spring, uint32_t msec);
509 weston_spring_done(struct weston_spring *spring);
512 weston_surface_activate(struct weston_surface *surface,
513 struct weston_seat *seat);
515 notify_motion(struct weston_seat *seat, uint32_t time,
516 wl_fixed_t x, wl_fixed_t y);
518 notify_button(struct weston_seat *seat, uint32_t time, int32_t button,
519 enum wl_pointer_button_state state);
521 notify_axis(struct weston_seat *seat, uint32_t time, uint32_t axis,
524 notify_key(struct weston_seat *seat, uint32_t time, uint32_t key,
525 enum wl_keyboard_key_state state,
526 enum weston_key_state_update update_state);
528 notify_modifiers(struct weston_seat *seat, uint32_t serial);
531 notify_pointer_focus(struct weston_seat *seat, struct weston_output *output,
532 wl_fixed_t x, wl_fixed_t y);
535 notify_keyboard_focus_in(struct weston_seat *seat, struct wl_array *keys,
536 enum weston_key_state_update update_state);
538 notify_keyboard_focus_out(struct weston_seat *seat);
541 notify_touch(struct weston_seat *seat, uint32_t time, int touch_id,
542 wl_fixed_t x, wl_fixed_t y, int touch_type);
545 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
548 weston_plane_init(struct weston_plane *plane, int32_t x, int32_t y);
550 weston_plane_release(struct weston_plane *plane);
553 weston_output_finish_frame(struct weston_output *output, uint32_t msecs);
555 weston_output_schedule_repaint(struct weston_output *output);
557 weston_output_damage(struct weston_output *output);
559 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
561 weston_compositor_fade(struct weston_compositor *compositor, float tint);
563 weston_compositor_damage_all(struct weston_compositor *compositor);
565 weston_compositor_unlock(struct weston_compositor *compositor);
567 weston_compositor_wake(struct weston_compositor *compositor);
569 weston_compositor_activity(struct weston_compositor *compositor);
571 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
574 struct weston_binding;
575 typedef void (*weston_key_binding_handler_t)(struct wl_seat *seat,
576 uint32_t time, uint32_t key,
578 struct weston_binding *
579 weston_compositor_add_key_binding(struct weston_compositor *compositor,
581 enum weston_keyboard_modifier modifier,
582 weston_key_binding_handler_t binding,
585 typedef void (*weston_button_binding_handler_t)(struct wl_seat *seat,
586 uint32_t time, uint32_t button,
588 struct weston_binding *
589 weston_compositor_add_button_binding(struct weston_compositor *compositor,
591 enum weston_keyboard_modifier modifier,
592 weston_button_binding_handler_t binding,
595 typedef void (*weston_axis_binding_handler_t)(struct wl_seat *seat,
596 uint32_t time, uint32_t axis,
597 wl_fixed_t value, void *data);
598 struct weston_binding *
599 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
601 enum weston_keyboard_modifier modifier,
602 weston_axis_binding_handler_t binding,
605 weston_binding_destroy(struct weston_binding *binding);
608 weston_binding_list_destroy_all(struct wl_list *list);
611 weston_compositor_run_key_binding(struct weston_compositor *compositor,
612 struct weston_seat *seat, uint32_t time,
614 enum wl_keyboard_key_state state);
616 weston_compositor_run_button_binding(struct weston_compositor *compositor,
617 struct weston_seat *seat, uint32_t time,
619 enum wl_pointer_button_state value);
621 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
622 struct weston_seat *seat, uint32_t time,
623 uint32_t axis, int32_t value);
626 weston_environment_get_fd(const char *env);
629 weston_compositor_top(struct weston_compositor *compositor);
631 struct weston_surface *
632 weston_surface_create(struct weston_compositor *compositor);
635 weston_surface_configure(struct weston_surface *surface,
636 GLfloat x, GLfloat y, int width, int height);
639 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
642 weston_surface_set_position(struct weston_surface *surface,
643 GLfloat x, GLfloat y);
646 weston_surface_is_mapped(struct weston_surface *surface);
649 weston_surface_assign_output(struct weston_surface *surface);
652 weston_surface_schedule_repaint(struct weston_surface *surface);
655 weston_surface_damage(struct weston_surface *surface);
658 weston_surface_damage_below(struct weston_surface *surface);
661 weston_surface_move_to_plane(struct weston_surface *surface,
662 struct weston_plane *plane);
664 weston_surface_unmap(struct weston_surface *surface);
667 weston_buffer_post_release(struct wl_buffer *buffer);
670 weston_compositor_get_time(void);
673 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display,
674 int argc, char *argv[], const char *config_file);
676 weston_compositor_shutdown(struct weston_compositor *ec);
678 weston_text_cursor_position_notify(struct weston_surface *surface,
679 wl_fixed_t x, wl_fixed_t y);
681 weston_output_init_zoom(struct weston_output *output);
683 weston_output_update_zoom(struct weston_output *output, uint32_t type);
685 weston_output_update_matrix(struct weston_output *output);
687 weston_output_move(struct weston_output *output, int x, int y);
689 weston_output_init(struct weston_output *output, struct weston_compositor *c,
690 int x, int y, int width, int height, uint32_t transform);
692 weston_output_destroy(struct weston_output *output);
695 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
697 weston_seat_init_pointer(struct weston_seat *seat);
699 weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
701 weston_seat_init_touch(struct weston_seat *seat);
704 weston_seat_release(struct weston_seat *seat);
706 /* String literal of spaces, the same width as the timestamp. */
707 #define STAMP_SPACE " "
710 weston_log_file_open(const char *filename);
712 weston_log_file_close(void);
714 weston_log(const char *fmt, ...)
715 __attribute__ ((format (printf, 1, 2)));
717 weston_log_continue(const char *fmt, ...)
718 __attribute__ ((format (printf, 1, 2)));
725 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
728 tty_create(struct weston_compositor *compositor,
729 tty_vt_func_t vt_func, int tty_nr);
732 tty_destroy(struct tty *tty);
735 tty_reset(struct tty *tty);
738 tty_activate_vt(struct tty *tty, int vt);
741 screenshooter_create(struct weston_compositor *ec);
744 clipboard_create(struct weston_seat *seat);
747 text_cursor_position_notifier_create(struct weston_compositor *ec);
750 input_method_create(struct weston_compositor *ec,
751 struct weston_seat *seat);
753 struct weston_process;
754 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
757 struct weston_process {
759 weston_process_cleanup_func_t cleanup;
764 weston_client_launch(struct weston_compositor *compositor,
765 struct weston_process *proc,
767 weston_process_cleanup_func_t cleanup);
770 weston_watch_process(struct weston_process *process);
772 struct weston_surface_animation;
773 typedef void (*weston_surface_animation_done_func_t)(struct weston_surface_animation *animation, void *data);
775 struct weston_surface_animation *
776 weston_zoom_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
777 weston_surface_animation_done_func_t done, void *data);
779 struct weston_surface_animation *
780 weston_fade_run(struct weston_surface *surface,
781 weston_surface_animation_done_func_t done, void *data);
782 struct weston_surface_animation *
783 weston_slide_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
784 weston_surface_animation_done_func_t done, void *data);
787 weston_surface_set_color(struct weston_surface *surface,
788 GLfloat red, GLfloat green, GLfloat blue, GLfloat alpha);
791 weston_surface_destroy(struct weston_surface *surface);
794 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);
797 gles2_renderer_init(struct weston_compositor *ec);
799 gles2_renderer_destroy(struct weston_compositor *ec);
801 struct weston_compositor *
802 backend_init(struct wl_display *display, int argc, char *argv[],
803 const char *config_file);
806 module_init(struct weston_compositor *compositor);