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 opaque;
274 struct weston_renderer {
275 int (*read_pixels)(struct weston_output *output,
276 pixman_format_code_t format, void *pixels,
277 uint32_t x, uint32_t y,
278 uint32_t width, uint32_t height);
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 int (*create_surface)(struct weston_surface *surface);
284 void (*surface_set_color)(struct weston_surface *surface,
285 float red, float green,
286 float blue, float alpha);
287 void (*destroy_surface)(struct weston_surface *surface);
288 void (*destroy)(struct weston_compositor *ec);
291 struct weston_compositor {
292 struct wl_signal destroy_signal;
294 struct wl_display *wl_display;
295 struct weston_shell_interface shell_interface;
297 struct wl_signal activate_signal;
298 struct wl_signal kill_signal;
299 struct wl_signal idle_signal;
300 struct wl_signal wake_signal;
302 struct wl_signal show_input_panel_signal;
303 struct wl_signal hide_input_panel_signal;
305 struct wl_signal seat_created_signal;
307 struct wl_event_loop *input_loop;
308 struct wl_event_source *input_loop_source;
310 struct weston_layer fade_layer;
311 struct weston_layer cursor_layer;
313 struct wl_list output_list;
314 struct wl_list seat_list;
315 struct wl_list layer_list;
316 struct wl_list surface_list;
317 struct wl_list key_binding_list;
318 struct wl_list button_binding_list;
319 struct wl_list axis_binding_list;
320 struct wl_list debug_binding_list;
323 struct wl_event_source *idle_source;
324 uint32_t idle_inhibit;
325 int option_idle_time; /* default timeout, s */
326 int idle_time; /* effective timeout, s */
329 struct wl_array vertices;
330 struct wl_array indices; /* only used in compositor-wayland */
331 struct wl_array vtxcnt;
332 struct weston_plane primary_plane;
337 struct weston_renderer *renderer;
339 pixman_format_code_t read_format;
341 void (*destroy)(struct weston_compositor *ec);
342 void (*restore)(struct weston_compositor *ec);
343 int (*authenticate)(struct weston_compositor *c, uint32_t id);
345 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
349 uint32_t output_id_pool;
351 struct xkb_rule_names xkb_names;
352 struct xkb_context *xkb_context;
353 struct weston_xkb_info xkb_info;
356 struct weston_buffer_reference {
357 struct wl_buffer *buffer;
358 struct wl_listener destroy_listener;
361 struct weston_region {
362 struct wl_resource resource;
363 pixman_region32_t region;
366 /* Using weston_surface transformations
368 * To add a transformation to a surface, create a struct weston_transform, and
369 * add it to the list surface->geometry.transformation_list. Whenever you
370 * change the list, anything under surface->geometry, or anything in the
371 * weston_transforms linked into the list, you must set
372 * surface->geometry.dirty = 1.
374 * The order in the list defines the order of transformations. Let the list
375 * contain the transformation matrices M1, ..., Mn as head to tail. The
376 * transformation is applied to surface-local coordinate vector p as
377 * P = Mn * ... * M2 * M1 * p
378 * to produce the global coordinate vector P. The total transform
380 * is cached in surface->transform.matrix, and the inverse of it in
381 * surface->transform.inverse.
383 * The list always contains surface->transform.position transformation, which
384 * is the translation by surface->geometry.x and y.
386 * If you want to apply a transformation in local coordinates, add your
387 * weston_transform to the head of the list. If you want to apply a
388 * transformation in global coordinates, add it to the tail of the list.
391 struct weston_surface {
392 struct wl_surface surface;
393 struct weston_compositor *compositor;
394 pixman_region32_t clip;
395 pixman_region32_t damage;
396 pixman_region32_t opaque;
397 pixman_region32_t input;
399 struct wl_list layer_link;
401 struct weston_plane *plane;
403 void *renderer_state;
405 /* Surface geometry state, mutable.
406 * If you change anything, set dirty = 1.
407 * That includes the transformations referenced from the list.
410 float x, y; /* surface translation on display */
411 int32_t width, height;
413 /* struct weston_transform */
414 struct wl_list transformation_list;
419 /* State derived from geometry state, read-only.
420 * This is updated by weston_surface_update_transform().
423 pixman_region32_t boundingbox;
424 pixman_region32_t opaque;
426 /* matrix and inverse are used only if enabled = 1.
427 * If enabled = 0, use x, y, width, height directly.
430 struct weston_matrix matrix;
431 struct weston_matrix inverse;
433 struct weston_transform position; /* matrix from x, y */
437 * Which output to vsync this surface to.
438 * Used to determine, whether to send or queue frame events.
439 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
441 struct weston_output *output;
444 * A more complete representation of all outputs this surface is
447 uint32_t output_mask;
449 struct wl_list frame_callback_list;
451 struct weston_buffer_reference buffer_ref;
452 uint32_t buffer_transform;
453 int keep_buffer; /* bool for backends to prevent early release */
455 /* All the pending state, that wl_surface.commit will apply. */
457 /* wl_surface.attach */
459 struct wl_buffer *buffer;
460 struct wl_listener buffer_destroy_listener;
464 /* wl_surface.damage */
465 pixman_region32_t damage;
467 /* wl_surface.set_opaque_region */
468 pixman_region32_t opaque;
470 /* wl_surface.set_input_region */
471 pixman_region32_t input;
473 /* wl_surface.frame */
474 struct wl_list frame_callback_list;
476 /* wl_surface.set_buffer_transform */
477 uint32_t buffer_transform;
481 * If non-NULL, this function will be called on surface::attach after
482 * a new buffer has been set up for this surface. The integer params
483 * are the sx and sy paramerters supplied to surface::attach .
485 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy, int32_t width, int32_t height);
489 enum weston_key_state_update {
490 STATE_UPDATE_AUTOMATIC,
495 weston_version(int *major, int *minor, int *micro);
498 weston_surface_update_transform(struct weston_surface *surface);
501 weston_surface_to_global_fixed(struct weston_surface *surface,
502 wl_fixed_t sx, wl_fixed_t sy,
503 wl_fixed_t *x, wl_fixed_t *y);
505 weston_surface_to_global_float(struct weston_surface *surface,
506 float sx, float sy, float *x, float *y);
509 weston_surface_from_global_float(struct weston_surface *surface,
510 float x, float y, float *sx, float *sy);
512 weston_surface_from_global(struct weston_surface *surface,
513 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
515 weston_surface_from_global_fixed(struct weston_surface *surface,
516 wl_fixed_t x, wl_fixed_t y,
517 wl_fixed_t *sx, wl_fixed_t *sy);
519 weston_surface_buffer_width(struct weston_surface *surface);
521 weston_surface_buffer_height(struct weston_surface *surface);
524 weston_surface_to_buffer_float(struct weston_surface *surface,
525 float x, float y, float *bx, float *by);
527 weston_surface_to_buffer_rect(struct weston_surface *surface,
528 pixman_box32_t rect);
531 weston_spring_init(struct weston_spring *spring,
532 double k, double current, double target);
534 weston_spring_update(struct weston_spring *spring, uint32_t msec);
536 weston_spring_done(struct weston_spring *spring);
539 weston_surface_activate(struct weston_surface *surface,
540 struct weston_seat *seat);
542 notify_motion(struct weston_seat *seat, uint32_t time,
543 wl_fixed_t x, wl_fixed_t y);
545 notify_button(struct weston_seat *seat, uint32_t time, int32_t button,
546 enum wl_pointer_button_state state);
548 notify_axis(struct weston_seat *seat, uint32_t time, uint32_t axis,
551 notify_key(struct weston_seat *seat, uint32_t time, uint32_t key,
552 enum wl_keyboard_key_state state,
553 enum weston_key_state_update update_state);
555 notify_modifiers(struct weston_seat *seat, uint32_t serial);
558 notify_pointer_focus(struct weston_seat *seat, struct weston_output *output,
559 wl_fixed_t x, wl_fixed_t y);
562 notify_keyboard_focus_in(struct weston_seat *seat, struct wl_array *keys,
563 enum weston_key_state_update update_state);
565 notify_keyboard_focus_out(struct weston_seat *seat);
568 notify_touch(struct weston_seat *seat, uint32_t time, int touch_id,
569 wl_fixed_t x, wl_fixed_t y, int touch_type);
572 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
575 weston_plane_init(struct weston_plane *plane, int32_t x, int32_t y);
577 weston_plane_release(struct weston_plane *plane);
580 weston_output_finish_frame(struct weston_output *output, uint32_t msecs);
582 weston_output_schedule_repaint(struct weston_output *output);
584 weston_output_damage(struct weston_output *output);
586 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
588 weston_compositor_fade(struct weston_compositor *compositor, float tint);
590 weston_compositor_damage_all(struct weston_compositor *compositor);
592 weston_compositor_unlock(struct weston_compositor *compositor);
594 weston_compositor_wake(struct weston_compositor *compositor);
596 weston_compositor_sleep(struct weston_compositor *compositor);
598 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
601 struct weston_binding;
602 typedef void (*weston_key_binding_handler_t)(struct wl_seat *seat,
603 uint32_t time, uint32_t key,
605 struct weston_binding *
606 weston_compositor_add_key_binding(struct weston_compositor *compositor,
608 enum weston_keyboard_modifier modifier,
609 weston_key_binding_handler_t binding,
612 typedef void (*weston_button_binding_handler_t)(struct wl_seat *seat,
613 uint32_t time, uint32_t button,
615 struct weston_binding *
616 weston_compositor_add_button_binding(struct weston_compositor *compositor,
618 enum weston_keyboard_modifier modifier,
619 weston_button_binding_handler_t binding,
622 typedef void (*weston_axis_binding_handler_t)(struct wl_seat *seat,
623 uint32_t time, uint32_t axis,
624 wl_fixed_t value, void *data);
625 struct weston_binding *
626 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
628 enum weston_keyboard_modifier modifier,
629 weston_axis_binding_handler_t binding,
631 struct weston_binding *
632 weston_compositor_add_debug_binding(struct weston_compositor *compositor,
634 weston_key_binding_handler_t binding,
637 weston_binding_destroy(struct weston_binding *binding);
640 weston_binding_list_destroy_all(struct wl_list *list);
643 weston_compositor_run_key_binding(struct weston_compositor *compositor,
644 struct weston_seat *seat, uint32_t time,
646 enum wl_keyboard_key_state state);
648 weston_compositor_run_button_binding(struct weston_compositor *compositor,
649 struct weston_seat *seat, uint32_t time,
651 enum wl_pointer_button_state value);
653 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
654 struct weston_seat *seat, uint32_t time,
655 uint32_t axis, int32_t value);
657 weston_compositor_run_debug_binding(struct weston_compositor *compositor,
658 struct weston_seat *seat, uint32_t time,
660 enum wl_keyboard_key_state state);
663 weston_environment_get_fd(const char *env);
666 weston_compositor_top(struct weston_compositor *compositor);
668 struct weston_surface *
669 weston_surface_create(struct weston_compositor *compositor);
672 weston_surface_configure(struct weston_surface *surface,
673 float x, float y, int width, int height);
676 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
679 weston_surface_set_position(struct weston_surface *surface,
683 weston_surface_is_mapped(struct weston_surface *surface);
686 weston_surface_schedule_repaint(struct weston_surface *surface);
689 weston_surface_damage(struct weston_surface *surface);
692 weston_surface_damage_below(struct weston_surface *surface);
695 weston_surface_move_to_plane(struct weston_surface *surface,
696 struct weston_plane *plane);
698 weston_surface_unmap(struct weston_surface *surface);
701 weston_buffer_reference(struct weston_buffer_reference *ref,
702 struct wl_buffer *buffer);
705 weston_compositor_get_time(void);
708 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display,
709 int *argc, char *argv[], const char *config_file);
711 weston_compositor_shutdown(struct weston_compositor *ec);
713 weston_text_cursor_position_notify(struct weston_surface *surface,
714 wl_fixed_t x, wl_fixed_t y);
716 weston_output_init_zoom(struct weston_output *output);
718 weston_output_update_zoom(struct weston_output *output, uint32_t type);
720 weston_output_update_matrix(struct weston_output *output);
722 weston_output_move(struct weston_output *output, int x, int y);
724 weston_output_init(struct weston_output *output, struct weston_compositor *c,
725 int x, int y, int width, int height, uint32_t transform);
727 weston_output_destroy(struct weston_output *output);
730 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
732 weston_seat_init_pointer(struct weston_seat *seat);
734 weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
736 weston_seat_init_touch(struct weston_seat *seat);
739 weston_seat_release(struct weston_seat *seat);
741 /* String literal of spaces, the same width as the timestamp. */
742 #define STAMP_SPACE " "
745 weston_log_file_open(const char *filename);
747 weston_log_file_close(void);
749 weston_log(const char *fmt, ...)
750 __attribute__ ((format (printf, 1, 2)));
752 weston_log_continue(const char *fmt, ...)
753 __attribute__ ((format (printf, 1, 2)));
760 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
763 tty_create(struct weston_compositor *compositor,
764 tty_vt_func_t vt_func, int tty_nr);
767 tty_destroy(struct tty *tty);
770 tty_reset(struct tty *tty);
773 tty_activate_vt(struct tty *tty, int vt);
776 screenshooter_create(struct weston_compositor *ec);
779 clipboard_create(struct weston_seat *seat);
782 text_cursor_position_notifier_create(struct weston_compositor *ec);
785 text_backend_init(struct weston_compositor *ec);
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 float start, float end, float k,
816 weston_surface_animation_done_func_t done, void *data);
818 weston_fade_update(struct weston_surface_animation *fade,
819 float start, float end, float k);
821 struct weston_surface_animation *
822 weston_slide_run(struct weston_surface *surface, float start, float stop,
823 weston_surface_animation_done_func_t done, void *data);
826 weston_surface_set_color(struct weston_surface *surface,
827 float red, float green, float blue, float alpha);
830 weston_surface_destroy(struct weston_surface *surface);
833 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);
836 noop_renderer_init(struct weston_compositor *ec);
838 struct weston_compositor *
839 backend_init(struct wl_display *display, int *argc, char *argv[],
840 const char *config_file);
843 module_init(struct weston_compositor *compositor,
844 int *argc, char *argv[], const char *config_file);
847 weston_transformed_coord(int width, int height,
848 enum wl_output_transform transform,
849 float sx, float sy, float *bx, float *by);
851 weston_transformed_rect(int width, int height,
852 enum wl_output_transform transform,
853 pixman_box32_t rect);