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>
33 #include "config-parser.h"
35 #define ARRAY_LENGTH(a) (sizeof (a) / sizeof (a)[0])
37 #define container_of(ptr, type, member) ({ \
38 const __typeof__( ((type *)0)->member ) *__mptr = (ptr); \
39 (type *)( (char *)__mptr - offsetof(type,member) );})
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 void (*set_fullscreen)(struct shell_surface *shsurf,
92 struct weston_output *output);
93 int (*move)(struct shell_surface *shsurf, struct weston_seat *ws);
94 int (*resize)(struct shell_surface *shsurf,
95 struct weston_seat *ws, uint32_t edges);
99 struct weston_border {
100 int32_t left, right, top, bottom;
103 struct weston_animation {
104 void (*frame)(struct weston_animation *animation,
105 struct weston_output *output, uint32_t msecs);
110 struct weston_spring {
124 struct weston_fixed_point {
128 struct weston_output_zoom {
134 float trans_x, trans_y;
135 struct weston_animation animation_z;
136 struct weston_spring spring_z;
137 struct weston_animation animation_xy;
138 struct weston_spring spring_xy;
139 struct weston_fixed_point from;
140 struct weston_fixed_point to;
141 struct weston_fixed_point current;
142 struct weston_fixed_point text_cursor;
145 /* bit compatible with drm definitions. */
153 struct weston_output {
156 void *renderer_state;
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;
168 pixman_region32_t previous_damage;
170 int repaint_scheduled;
171 struct weston_output_zoom zoom;
173 struct wl_signal frame_signal;
181 struct weston_mode *current;
182 struct weston_mode *origin;
183 struct wl_list mode_list;
185 void (*repaint)(struct weston_output *output,
186 pixman_region32_t *damage);
187 void (*destroy)(struct weston_output *output);
188 void (*assign_planes)(struct weston_output *output);
189 int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
191 /* backlight values are on 0-255 range, where higher is brighter */
192 uint32_t backlight_current;
193 void (*set_backlight)(struct weston_output *output, uint32_t value);
194 void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
197 struct weston_xkb_info {
198 struct xkb_keymap *keymap;
202 xkb_mod_index_t shift_mod;
203 xkb_mod_index_t caps_mod;
204 xkb_mod_index_t ctrl_mod;
205 xkb_mod_index_t alt_mod;
206 xkb_mod_index_t mod2_mod;
207 xkb_mod_index_t mod3_mod;
208 xkb_mod_index_t super_mod;
209 xkb_mod_index_t mod5_mod;
210 xkb_led_index_t num_led;
211 xkb_led_index_t caps_led;
212 xkb_led_index_t scroll_led;
215 struct weston_keyboard {
216 struct wl_keyboard keyboard;
218 struct wl_keyboard_grab input_method_grab;
219 struct wl_resource *input_method_resource;
224 struct wl_pointer pointer;
226 struct weston_keyboard keyboard;
228 struct wl_touch touch;
231 struct weston_compositor *compositor;
232 struct weston_surface *sprite;
233 struct wl_listener sprite_destroy_listener;
234 struct weston_surface *drag_surface;
235 struct wl_listener drag_surface_destroy_listener;
236 int32_t hotspot_x, hotspot_y;
238 enum weston_keyboard_modifier modifier_state;
239 struct wl_surface *saved_kbd_focus;
240 struct wl_listener saved_kbd_focus_listener;
244 struct wl_listener new_drag_icon_listener;
246 void (*led_update)(struct weston_seat *ws, enum weston_led leds);
248 struct weston_xkb_info xkb_info;
250 struct xkb_state *state;
251 enum weston_led leds;
254 struct input_method *input_method;
258 WESTON_COMPOSITOR_ACTIVE,
259 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
260 WESTON_COMPOSITOR_SLEEPING /* no rendering, no frame events */
263 struct weston_layer {
264 struct wl_list surface_list;
268 struct weston_plane {
269 pixman_region32_t damage;
270 pixman_region32_t clip;
275 struct weston_renderer {
276 int (*read_pixels)(struct weston_output *output,
277 pixman_format_code_t format, void *pixels,
278 uint32_t x, uint32_t y,
279 uint32_t width, uint32_t height);
280 void (*repaint_output)(struct weston_output *output,
281 pixman_region32_t *output_damage);
282 void (*flush_damage)(struct weston_surface *surface);
283 void (*attach)(struct weston_surface *es, struct wl_buffer *buffer);
284 int (*create_surface)(struct weston_surface *surface);
285 void (*surface_set_color)(struct weston_surface *surface,
286 float red, float green,
287 float blue, float alpha);
288 void (*destroy_surface)(struct weston_surface *surface);
289 void (*destroy)(struct weston_compositor *ec);
292 struct weston_compositor {
293 struct wl_signal destroy_signal;
295 struct wl_display *wl_display;
296 struct weston_shell_interface shell_interface;
298 struct wl_signal activate_signal;
299 struct wl_signal kill_signal;
300 struct wl_signal idle_signal;
301 struct wl_signal wake_signal;
303 struct wl_signal show_input_panel_signal;
304 struct wl_signal hide_input_panel_signal;
306 struct wl_signal seat_created_signal;
308 struct wl_event_loop *input_loop;
309 struct wl_event_source *input_loop_source;
311 struct weston_layer fade_layer;
312 struct weston_layer cursor_layer;
314 struct wl_list output_list;
315 struct wl_list seat_list;
316 struct wl_list layer_list;
317 struct wl_list surface_list;
318 struct wl_list plane_list;
319 struct wl_list key_binding_list;
320 struct wl_list button_binding_list;
321 struct wl_list axis_binding_list;
322 struct wl_list debug_binding_list;
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 pixman_format_code_t read_format;
343 void (*destroy)(struct weston_compositor *ec);
344 void (*restore)(struct weston_compositor *ec);
345 int (*authenticate)(struct weston_compositor *c, uint32_t id);
347 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
351 uint32_t output_id_pool;
353 struct xkb_rule_names xkb_names;
354 struct xkb_context *xkb_context;
355 struct weston_xkb_info xkb_info;
358 struct weston_buffer_reference {
359 struct wl_buffer *buffer;
360 struct wl_listener destroy_listener;
363 struct weston_region {
364 struct wl_resource resource;
365 pixman_region32_t region;
368 /* Using weston_surface transformations
370 * To add a transformation to a surface, create a struct weston_transform, and
371 * add it to the list surface->geometry.transformation_list. Whenever you
372 * change the list, anything under surface->geometry, or anything in the
373 * weston_transforms linked into the list, you must call
374 * weston_surface_geometry_dirty().
376 * The order in the list defines the order of transformations. Let the list
377 * contain the transformation matrices M1, ..., Mn as head to tail. The
378 * transformation is applied to surface-local coordinate vector p as
379 * P = Mn * ... * M2 * M1 * p
380 * to produce the global coordinate vector P. The total transform
382 * is cached in surface->transform.matrix, and the inverse of it in
383 * surface->transform.inverse.
385 * The list always contains surface->transform.position transformation, which
386 * is the translation by surface->geometry.x and y.
388 * If you want to apply a transformation in local coordinates, add your
389 * weston_transform to the head of the list. If you want to apply a
390 * transformation in global coordinates, add it to the tail of the list.
392 * If surface->geometry.parent is set, the total transformation of this
393 * surface will be the parent's total transformation and this transformation
395 * Mparent * Mn * ... * M2 * M1
398 struct weston_surface {
399 struct wl_surface surface;
400 struct weston_compositor *compositor;
401 pixman_region32_t clip;
402 pixman_region32_t damage;
403 pixman_region32_t opaque; /* part of geometry, see below */
404 pixman_region32_t input;
406 struct wl_list layer_link;
407 float alpha; /* part of geometry, see below */
408 struct weston_plane *plane;
410 void *renderer_state;
412 /* Surface geometry state, mutable.
413 * If you change anything, call weston_surface_geometry_dirty().
414 * That includes the transformations referenced from the list.
417 float x, y; /* surface translation on display */
418 int32_t width, height;
420 /* struct weston_transform */
421 struct wl_list transformation_list;
423 /* managed by weston_surface_set_transform_parent() */
424 struct weston_surface *parent;
425 struct wl_listener parent_destroy_listener;
426 struct wl_list child_list; /* geometry.parent_link */
427 struct wl_list parent_link;
430 /* State derived from geometry state, read-only.
431 * This is updated by weston_surface_update_transform().
436 pixman_region32_t boundingbox;
437 pixman_region32_t opaque;
439 /* matrix and inverse are used only if enabled = 1.
440 * If enabled = 0, use x, y, width, height directly.
443 struct weston_matrix matrix;
444 struct weston_matrix inverse;
446 struct weston_transform position; /* matrix from x, y */
450 * Which output to vsync this surface to.
451 * Used to determine, whether to send or queue frame events.
452 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
454 struct weston_output *output;
457 * A more complete representation of all outputs this surface is
460 uint32_t output_mask;
462 struct wl_list frame_callback_list;
464 struct weston_buffer_reference buffer_ref;
465 uint32_t buffer_transform;
466 int keep_buffer; /* bool for backends to prevent early release */
468 /* All the pending state, that wl_surface.commit will apply. */
470 /* wl_surface.attach */
472 struct wl_buffer *buffer;
473 struct wl_listener buffer_destroy_listener;
477 /* wl_surface.damage */
478 pixman_region32_t damage;
480 /* wl_surface.set_opaque_region */
481 pixman_region32_t opaque;
483 /* wl_surface.set_input_region */
484 pixman_region32_t input;
486 /* wl_surface.frame */
487 struct wl_list frame_callback_list;
489 /* wl_surface.set_buffer_transform */
490 uint32_t buffer_transform;
494 * If non-NULL, this function will be called on surface::attach after
495 * a new buffer has been set up for this surface. The integer params
496 * are the sx and sy paramerters supplied to surface::attach .
498 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy, int32_t width, int32_t height);
502 enum weston_key_state_update {
503 STATE_UPDATE_AUTOMATIC,
508 weston_version(int *major, int *minor, int *micro);
511 weston_surface_update_transform(struct weston_surface *surface);
514 weston_surface_geometry_dirty(struct weston_surface *surface);
517 weston_surface_to_global_fixed(struct weston_surface *surface,
518 wl_fixed_t sx, wl_fixed_t sy,
519 wl_fixed_t *x, wl_fixed_t *y);
521 weston_surface_to_global_float(struct weston_surface *surface,
522 float sx, float sy, float *x, float *y);
525 weston_surface_from_global_float(struct weston_surface *surface,
526 float x, float y, float *sx, float *sy);
528 weston_surface_from_global(struct weston_surface *surface,
529 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
531 weston_surface_from_global_fixed(struct weston_surface *surface,
532 wl_fixed_t x, wl_fixed_t y,
533 wl_fixed_t *sx, wl_fixed_t *sy);
535 weston_surface_buffer_width(struct weston_surface *surface);
537 weston_surface_buffer_height(struct weston_surface *surface);
540 weston_surface_to_buffer_float(struct weston_surface *surface,
541 float x, float y, float *bx, float *by);
543 weston_surface_to_buffer_rect(struct weston_surface *surface,
544 pixman_box32_t rect);
547 weston_spring_init(struct weston_spring *spring,
548 double k, double current, double target);
550 weston_spring_update(struct weston_spring *spring, uint32_t msec);
552 weston_spring_done(struct weston_spring *spring);
555 weston_surface_activate(struct weston_surface *surface,
556 struct weston_seat *seat);
558 notify_motion(struct weston_seat *seat, uint32_t time,
559 wl_fixed_t x, wl_fixed_t y);
561 notify_button(struct weston_seat *seat, uint32_t time, int32_t button,
562 enum wl_pointer_button_state state);
564 notify_axis(struct weston_seat *seat, uint32_t time, uint32_t axis,
567 notify_key(struct weston_seat *seat, uint32_t time, uint32_t key,
568 enum wl_keyboard_key_state state,
569 enum weston_key_state_update update_state);
571 notify_modifiers(struct weston_seat *seat, uint32_t serial);
574 notify_pointer_focus(struct weston_seat *seat, struct weston_output *output,
575 wl_fixed_t x, wl_fixed_t y);
578 notify_keyboard_focus_in(struct weston_seat *seat, struct wl_array *keys,
579 enum weston_key_state_update update_state);
581 notify_keyboard_focus_out(struct weston_seat *seat);
584 notify_touch(struct weston_seat *seat, uint32_t time, int touch_id,
585 wl_fixed_t x, wl_fixed_t y, int touch_type);
588 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
591 weston_plane_init(struct weston_plane *plane, int32_t x, int32_t y);
593 weston_plane_release(struct weston_plane *plane);
596 weston_compositor_stack_plane(struct weston_compositor *ec,
597 struct weston_plane *plane,
598 struct weston_plane *above);
601 weston_output_finish_frame(struct weston_output *output, uint32_t msecs);
603 weston_output_schedule_repaint(struct weston_output *output);
605 weston_output_damage(struct weston_output *output);
607 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
609 weston_compositor_fade(struct weston_compositor *compositor, float tint);
611 weston_compositor_damage_all(struct weston_compositor *compositor);
613 weston_compositor_unlock(struct weston_compositor *compositor);
615 weston_compositor_wake(struct weston_compositor *compositor);
617 weston_compositor_sleep(struct weston_compositor *compositor);
619 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
622 struct weston_binding;
623 typedef void (*weston_key_binding_handler_t)(struct wl_seat *seat,
624 uint32_t time, uint32_t key,
626 struct weston_binding *
627 weston_compositor_add_key_binding(struct weston_compositor *compositor,
629 enum weston_keyboard_modifier modifier,
630 weston_key_binding_handler_t binding,
633 typedef void (*weston_button_binding_handler_t)(struct wl_seat *seat,
634 uint32_t time, uint32_t button,
636 struct weston_binding *
637 weston_compositor_add_button_binding(struct weston_compositor *compositor,
639 enum weston_keyboard_modifier modifier,
640 weston_button_binding_handler_t binding,
643 typedef void (*weston_axis_binding_handler_t)(struct wl_seat *seat,
644 uint32_t time, uint32_t axis,
645 wl_fixed_t value, void *data);
646 struct weston_binding *
647 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
649 enum weston_keyboard_modifier modifier,
650 weston_axis_binding_handler_t binding,
652 struct weston_binding *
653 weston_compositor_add_debug_binding(struct weston_compositor *compositor,
655 weston_key_binding_handler_t binding,
658 weston_binding_destroy(struct weston_binding *binding);
661 weston_binding_list_destroy_all(struct wl_list *list);
664 weston_compositor_run_key_binding(struct weston_compositor *compositor,
665 struct weston_seat *seat, uint32_t time,
667 enum wl_keyboard_key_state state);
669 weston_compositor_run_button_binding(struct weston_compositor *compositor,
670 struct weston_seat *seat, uint32_t time,
672 enum wl_pointer_button_state value);
674 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
675 struct weston_seat *seat, uint32_t time,
676 uint32_t axis, int32_t value);
678 weston_compositor_run_debug_binding(struct weston_compositor *compositor,
679 struct weston_seat *seat, uint32_t time,
681 enum wl_keyboard_key_state state);
684 weston_environment_get_fd(const char *env);
687 weston_compositor_top(struct weston_compositor *compositor);
689 struct weston_surface *
690 weston_surface_create(struct weston_compositor *compositor);
693 weston_surface_configure(struct weston_surface *surface,
694 float x, float y, int width, int height);
697 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
700 weston_surface_set_position(struct weston_surface *surface,
704 weston_surface_set_transform_parent(struct weston_surface *surface,
705 struct weston_surface *parent);
708 weston_surface_is_mapped(struct weston_surface *surface);
711 weston_surface_schedule_repaint(struct weston_surface *surface);
714 weston_surface_damage(struct weston_surface *surface);
717 weston_surface_damage_below(struct weston_surface *surface);
720 weston_surface_move_to_plane(struct weston_surface *surface,
721 struct weston_plane *plane);
723 weston_surface_unmap(struct weston_surface *surface);
726 weston_buffer_reference(struct weston_buffer_reference *ref,
727 struct wl_buffer *buffer);
730 weston_compositor_get_time(void);
733 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display,
734 int *argc, char *argv[], const char *config_file);
736 weston_compositor_shutdown(struct weston_compositor *ec);
738 weston_text_cursor_position_notify(struct weston_surface *surface,
739 wl_fixed_t x, wl_fixed_t y);
741 weston_output_init_zoom(struct weston_output *output);
743 weston_output_update_zoom(struct weston_output *output, uint32_t type);
745 weston_output_update_matrix(struct weston_output *output);
747 weston_output_move(struct weston_output *output, int x, int y);
749 weston_output_init(struct weston_output *output, struct weston_compositor *c,
750 int x, int y, int width, int height, uint32_t transform);
752 weston_output_destroy(struct weston_output *output);
755 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
757 weston_seat_init_pointer(struct weston_seat *seat);
759 weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
761 weston_seat_init_touch(struct weston_seat *seat);
764 weston_seat_release(struct weston_seat *seat);
766 /* String literal of spaces, the same width as the timestamp. */
767 #define STAMP_SPACE " "
770 weston_log_file_open(const char *filename);
772 weston_log_file_close(void);
774 weston_log(const char *fmt, ...)
775 __attribute__ ((format (printf, 1, 2)));
777 weston_log_continue(const char *fmt, ...)
778 __attribute__ ((format (printf, 1, 2)));
785 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
788 tty_create(struct weston_compositor *compositor,
789 tty_vt_func_t vt_func, int tty_nr);
792 tty_destroy(struct tty *tty);
795 tty_reset(struct tty *tty);
798 tty_activate_vt(struct tty *tty, int vt);
801 screenshooter_create(struct weston_compositor *ec);
804 clipboard_create(struct weston_seat *seat);
807 text_cursor_position_notifier_create(struct weston_compositor *ec);
810 text_backend_init(struct weston_compositor *ec);
812 struct weston_process;
813 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
816 struct weston_process {
818 weston_process_cleanup_func_t cleanup;
823 weston_client_launch(struct weston_compositor *compositor,
824 struct weston_process *proc,
826 weston_process_cleanup_func_t cleanup);
829 weston_watch_process(struct weston_process *process);
831 struct weston_surface_animation;
832 typedef void (*weston_surface_animation_done_func_t)(struct weston_surface_animation *animation, void *data);
834 struct weston_surface_animation *
835 weston_zoom_run(struct weston_surface *surface, float start, float stop,
836 weston_surface_animation_done_func_t done, void *data);
838 struct weston_surface_animation *
839 weston_fade_run(struct weston_surface *surface,
840 float start, float end, float k,
841 weston_surface_animation_done_func_t done, void *data);
843 weston_fade_update(struct weston_surface_animation *fade,
844 float start, float end, float k);
846 struct weston_surface_animation *
847 weston_slide_run(struct weston_surface *surface, float start, float stop,
848 weston_surface_animation_done_func_t done, void *data);
851 weston_surface_set_color(struct weston_surface *surface,
852 float red, float green, float blue, float alpha);
855 weston_surface_destroy(struct weston_surface *surface);
858 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);
861 noop_renderer_init(struct weston_compositor *ec);
863 struct weston_compositor *
864 backend_init(struct wl_display *display, int *argc, char *argv[],
865 const char *config_file);
868 module_init(struct weston_compositor *compositor,
869 int *argc, char *argv[], const char *config_file);
872 weston_transformed_coord(int width, int height,
873 enum wl_output_transform transform,
874 float sx, float sy, float *bx, float *by);
876 weston_transformed_rect(int width, int height,
877 enum wl_output_transform transform,
878 pixman_box32_t rect);