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;
164 pixman_region32_t buffer_damage[2];
166 int repaint_scheduled;
167 struct weston_output_zoom zoom;
169 struct wl_signal frame_signal;
177 struct weston_mode *current;
178 struct weston_mode *origin;
179 struct wl_list mode_list;
181 void (*repaint)(struct weston_output *output,
182 pixman_region32_t *damage);
183 void (*destroy)(struct weston_output *output);
184 void (*assign_planes)(struct weston_output *output);
185 int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
187 /* backlight values are on 0-255 range, where higher is brighter */
188 uint32_t backlight_current;
189 void (*set_backlight)(struct weston_output *output, uint32_t value);
190 void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
193 struct weston_xkb_info {
194 struct xkb_keymap *keymap;
198 xkb_mod_index_t shift_mod;
199 xkb_mod_index_t caps_mod;
200 xkb_mod_index_t ctrl_mod;
201 xkb_mod_index_t alt_mod;
202 xkb_mod_index_t mod2_mod;
203 xkb_mod_index_t mod3_mod;
204 xkb_mod_index_t super_mod;
205 xkb_mod_index_t mod5_mod;
206 xkb_led_index_t num_led;
207 xkb_led_index_t caps_led;
208 xkb_led_index_t scroll_led;
213 struct wl_pointer pointer;
215 struct wl_keyboard keyboard;
217 struct wl_touch touch;
220 struct weston_compositor *compositor;
221 struct weston_surface *sprite;
222 struct wl_listener sprite_destroy_listener;
223 struct weston_surface *drag_surface;
224 struct wl_listener drag_surface_destroy_listener;
225 int32_t hotspot_x, hotspot_y;
227 enum weston_keyboard_modifier modifier_state;
228 struct wl_surface *saved_kbd_focus;
229 struct wl_listener saved_kbd_focus_listener;
233 struct wl_listener new_drag_icon_listener;
235 void (*led_update)(struct weston_seat *ws, enum weston_led leds);
237 struct weston_xkb_info xkb_info;
239 struct xkb_state *state;
240 enum weston_led leds;
243 struct input_method *input_method;
246 struct weston_shader {
248 GLuint vertex_shader, fragment_shader;
250 GLint tex_uniforms[3];
256 WESTON_COMPOSITOR_ACTIVE,
257 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
258 WESTON_COMPOSITOR_SLEEPING /* no rendering, no frame events */
261 struct weston_layer {
262 struct wl_list surface_list;
266 struct weston_plane {
267 pixman_region32_t damage;
271 struct weston_renderer {
272 void (*repaint_output)(struct weston_output *output,
273 pixman_region32_t *output_damage);
274 void (*flush_damage)(struct weston_surface *surface);
275 void (*attach)(struct weston_surface *es, struct wl_buffer *buffer);
276 void (*destroy_surface)(struct weston_surface *surface);
279 struct weston_compositor {
280 struct wl_signal destroy_signal;
282 EGLDisplay egl_display;
283 EGLContext egl_context;
284 EGLConfig egl_config;
285 struct weston_shader texture_shader_rgba;
286 struct weston_shader texture_shader_rgbx;
287 struct weston_shader texture_shader_egl_external;
288 struct weston_shader texture_shader_y_uv;
289 struct weston_shader texture_shader_y_u_v;
290 struct weston_shader texture_shader_y_xuxv;
291 struct weston_shader solid_shader;
292 struct weston_shader *current_shader;
293 struct wl_display *wl_display;
294 struct weston_shell_interface shell_interface;
296 struct wl_signal activate_signal;
297 struct wl_signal kill_signal;
298 struct wl_signal lock_signal;
299 struct wl_signal unlock_signal;
301 struct wl_signal show_input_panel_signal;
302 struct wl_signal hide_input_panel_signal;
304 struct wl_event_loop *input_loop;
305 struct wl_event_source *input_loop_source;
307 struct weston_layer fade_layer;
308 struct weston_layer cursor_layer;
310 struct wl_list output_list;
311 struct wl_list seat_list;
312 struct wl_list layer_list;
313 struct wl_list surface_list;
314 struct wl_list key_binding_list;
315 struct wl_list button_binding_list;
316 struct wl_list axis_binding_list;
318 struct weston_spring spring;
319 struct weston_animation animation;
320 struct weston_surface *surface;
324 struct wl_event_source *idle_source;
325 uint32_t idle_inhibit;
326 int option_idle_time; /* default timeout, s */
327 int idle_time; /* effective timeout, s */
330 struct wl_array vertices;
331 struct wl_array indices; /* only used in compositor-wayland */
332 struct wl_array vtxcnt;
333 struct weston_plane primary_plane;
338 struct weston_renderer *renderer;
340 PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
341 image_target_renderbuffer_storage;
342 PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
343 PFNEGLCREATEIMAGEKHRPROC create_image;
344 PFNEGLDESTROYIMAGEKHRPROC destroy_image;
346 int has_unpack_subimage;
349 PFNEGLBINDWAYLANDDISPLAYWL bind_display;
350 PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
351 PFNEGLQUERYWAYLANDBUFFERWL query_buffer;
352 int has_bind_display;
354 void (*destroy)(struct weston_compositor *ec);
355 void (*restore)(struct weston_compositor *ec);
356 int (*authenticate)(struct weston_compositor *c, uint32_t id);
358 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
362 uint32_t output_id_pool;
364 struct xkb_rule_names xkb_names;
365 struct xkb_context *xkb_context;
366 struct weston_xkb_info xkb_info;
369 struct weston_region {
370 struct wl_resource resource;
371 pixman_region32_t region;
374 /* Using weston_surface transformations
376 * To add a transformation to a surface, create a struct weston_transform, and
377 * add it to the list surface->geometry.transformation_list. Whenever you
378 * change the list, anything under surface->geometry, or anything in the
379 * weston_transforms linked into the list, you must set
380 * surface->geometry.dirty = 1.
382 * The order in the list defines the order of transformations. Let the list
383 * contain the transformation matrices M1, ..., Mn as head to tail. The
384 * transformation is applied to surface-local coordinate vector p as
385 * P = Mn * ... * M2 * M1 * p
386 * to produce the global coordinate vector P. The total transform
388 * is cached in surface->transform.matrix, and the inverse of it in
389 * surface->transform.inverse.
391 * The list always contains surface->transform.position transformation, which
392 * is the translation by surface->geometry.x and y.
394 * If you want to apply a transformation in local coordinates, add your
395 * weston_transform to the head of the list. If you want to apply a
396 * transformation in global coordinates, add it to the tail of the list.
399 struct weston_surface {
400 struct wl_surface surface;
401 struct weston_compositor *compositor;
404 pixman_region32_t clip;
405 pixman_region32_t damage;
406 pixman_region32_t opaque;
407 pixman_region32_t input;
410 struct wl_list layer_link;
411 struct weston_shader *shader;
414 struct weston_plane *plane;
416 /* Surface geometry state, mutable.
417 * If you change anything, set dirty = 1.
418 * That includes the transformations referenced from the list.
421 float x, y; /* surface translation on display */
422 int32_t width, height;
424 /* struct weston_transform */
425 struct wl_list transformation_list;
430 /* State derived from geometry state, read-only.
431 * This is updated by weston_surface_update_transform().
434 pixman_region32_t boundingbox;
435 pixman_region32_t opaque;
437 /* matrix and inverse are used only if enabled = 1.
438 * If enabled = 0, use x, y, width, height directly.
441 struct weston_matrix matrix;
442 struct weston_matrix inverse;
444 struct weston_transform position; /* matrix from x, y */
448 * Which output to vsync this surface to.
449 * Used to determine, whether to send or queue frame events.
450 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
452 struct weston_output *output;
455 * A more complete representation of all outputs this surface is
458 uint32_t output_mask;
460 struct wl_list frame_callback_list;
462 EGLImageKHR images[3];
466 struct wl_buffer *buffer;
467 struct wl_listener buffer_destroy_listener;
469 /* All the pending state, that wl_surface.commit will apply. */
471 /* wl_surface.attach */
473 struct wl_buffer *buffer;
474 struct wl_listener buffer_destroy_listener;
478 /* wl_surface.damage */
479 pixman_region32_t damage;
481 /* wl_surface.set_opaque_region */
482 pixman_region32_t opaque;
484 /* wl_surface.set_input_region */
485 pixman_region32_t input;
489 * If non-NULL, this function will be called on surface::attach after
490 * a new buffer has been set up for this surface. The integer params
491 * are the sx and sy paramerters supplied to surface::attach .
493 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
497 enum weston_key_state_update {
498 STATE_UPDATE_AUTOMATIC,
503 weston_surface_update_transform(struct weston_surface *surface);
506 weston_surface_to_global_fixed(struct weston_surface *surface,
507 wl_fixed_t sx, wl_fixed_t sy,
508 wl_fixed_t *x, wl_fixed_t *y);
510 weston_surface_to_global_float(struct weston_surface *surface,
511 float sx, float sy, float *x, float *y);
514 weston_surface_from_global_float(struct weston_surface *surface,
515 float x, float y, float *sx, float *sy);
517 weston_surface_from_global(struct weston_surface *surface,
518 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
520 weston_surface_from_global_fixed(struct weston_surface *surface,
521 wl_fixed_t x, wl_fixed_t y,
522 wl_fixed_t *sx, wl_fixed_t *sy);
525 weston_spring_init(struct weston_spring *spring,
526 double k, double current, double target);
528 weston_spring_update(struct weston_spring *spring, uint32_t msec);
530 weston_spring_done(struct weston_spring *spring);
533 weston_surface_activate(struct weston_surface *surface,
534 struct weston_seat *seat);
536 notify_motion(struct weston_seat *seat, uint32_t time,
537 wl_fixed_t x, wl_fixed_t y);
539 notify_button(struct weston_seat *seat, uint32_t time, int32_t button,
540 enum wl_pointer_button_state state);
542 notify_axis(struct weston_seat *seat, uint32_t time, uint32_t axis,
545 notify_key(struct weston_seat *seat, uint32_t time, uint32_t key,
546 enum wl_keyboard_key_state state,
547 enum weston_key_state_update update_state);
549 notify_modifiers(struct weston_seat *seat, uint32_t serial);
552 notify_pointer_focus(struct weston_seat *seat, struct weston_output *output,
553 wl_fixed_t x, wl_fixed_t y);
556 notify_keyboard_focus_in(struct weston_seat *seat, struct wl_array *keys,
557 enum weston_key_state_update update_state);
559 notify_keyboard_focus_out(struct weston_seat *seat);
562 notify_touch(struct weston_seat *seat, uint32_t time, int touch_id,
563 wl_fixed_t x, wl_fixed_t y, int touch_type);
566 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
569 weston_plane_init(struct weston_plane *plane, int32_t x, int32_t y);
571 weston_plane_release(struct weston_plane *plane);
574 weston_output_finish_frame(struct weston_output *output, uint32_t msecs);
576 weston_output_schedule_repaint(struct weston_output *output);
578 weston_output_damage(struct weston_output *output);
580 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
582 weston_compositor_fade(struct weston_compositor *compositor, float tint);
584 weston_compositor_damage_all(struct weston_compositor *compositor);
586 weston_compositor_unlock(struct weston_compositor *compositor);
588 weston_compositor_wake(struct weston_compositor *compositor);
590 weston_compositor_activity(struct weston_compositor *compositor);
592 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
595 struct weston_binding;
596 typedef void (*weston_key_binding_handler_t)(struct wl_seat *seat,
597 uint32_t time, uint32_t key,
599 struct weston_binding *
600 weston_compositor_add_key_binding(struct weston_compositor *compositor,
602 enum weston_keyboard_modifier modifier,
603 weston_key_binding_handler_t binding,
606 typedef void (*weston_button_binding_handler_t)(struct wl_seat *seat,
607 uint32_t time, uint32_t button,
609 struct weston_binding *
610 weston_compositor_add_button_binding(struct weston_compositor *compositor,
612 enum weston_keyboard_modifier modifier,
613 weston_button_binding_handler_t binding,
616 typedef void (*weston_axis_binding_handler_t)(struct wl_seat *seat,
617 uint32_t time, uint32_t axis,
618 wl_fixed_t value, void *data);
619 struct weston_binding *
620 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
622 enum weston_keyboard_modifier modifier,
623 weston_axis_binding_handler_t binding,
626 weston_binding_destroy(struct weston_binding *binding);
629 weston_binding_list_destroy_all(struct wl_list *list);
632 weston_compositor_run_key_binding(struct weston_compositor *compositor,
633 struct weston_seat *seat, uint32_t time,
635 enum wl_keyboard_key_state state);
637 weston_compositor_run_button_binding(struct weston_compositor *compositor,
638 struct weston_seat *seat, uint32_t time,
640 enum wl_pointer_button_state value);
642 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
643 struct weston_seat *seat, uint32_t time,
644 uint32_t axis, int32_t value);
647 weston_environment_get_fd(const char *env);
650 weston_compositor_top(struct weston_compositor *compositor);
652 struct weston_surface *
653 weston_surface_create(struct weston_compositor *compositor);
656 weston_surface_configure(struct weston_surface *surface,
657 float x, float y, int width, int height);
660 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
663 weston_surface_set_position(struct weston_surface *surface,
667 weston_surface_is_mapped(struct weston_surface *surface);
670 weston_surface_schedule_repaint(struct weston_surface *surface);
673 weston_surface_damage(struct weston_surface *surface);
676 weston_surface_damage_below(struct weston_surface *surface);
679 weston_surface_move_to_plane(struct weston_surface *surface,
680 struct weston_plane *plane);
682 weston_surface_unmap(struct weston_surface *surface);
685 weston_buffer_post_release(struct wl_buffer *buffer);
688 weston_compositor_get_time(void);
691 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display,
692 int argc, char *argv[], const char *config_file);
694 weston_compositor_shutdown(struct weston_compositor *ec);
696 weston_text_cursor_position_notify(struct weston_surface *surface,
697 wl_fixed_t x, wl_fixed_t y);
699 weston_output_init_zoom(struct weston_output *output);
701 weston_output_update_zoom(struct weston_output *output, uint32_t type);
703 weston_output_update_matrix(struct weston_output *output);
705 weston_output_move(struct weston_output *output, int x, int y);
707 weston_output_init(struct weston_output *output, struct weston_compositor *c,
708 int x, int y, int width, int height, uint32_t transform);
710 weston_output_destroy(struct weston_output *output);
713 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
715 weston_seat_init_pointer(struct weston_seat *seat);
717 weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
719 weston_seat_init_touch(struct weston_seat *seat);
722 weston_seat_release(struct weston_seat *seat);
724 /* String literal of spaces, the same width as the timestamp. */
725 #define STAMP_SPACE " "
728 weston_log_file_open(const char *filename);
730 weston_log_file_close(void);
732 weston_log(const char *fmt, ...)
733 __attribute__ ((format (printf, 1, 2)));
735 weston_log_continue(const char *fmt, ...)
736 __attribute__ ((format (printf, 1, 2)));
743 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
746 tty_create(struct weston_compositor *compositor,
747 tty_vt_func_t vt_func, int tty_nr);
750 tty_destroy(struct tty *tty);
753 tty_reset(struct tty *tty);
756 tty_activate_vt(struct tty *tty, int vt);
759 screenshooter_create(struct weston_compositor *ec);
762 clipboard_create(struct weston_seat *seat);
765 text_cursor_position_notifier_create(struct weston_compositor *ec);
768 text_model_factory_create(struct weston_compositor *ec);
771 input_method_create(struct weston_compositor *ec,
772 struct weston_seat *seat);
774 struct weston_process;
775 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
778 struct weston_process {
780 weston_process_cleanup_func_t cleanup;
785 weston_client_launch(struct weston_compositor *compositor,
786 struct weston_process *proc,
788 weston_process_cleanup_func_t cleanup);
791 weston_watch_process(struct weston_process *process);
793 struct weston_surface_animation;
794 typedef void (*weston_surface_animation_done_func_t)(struct weston_surface_animation *animation, void *data);
796 struct weston_surface_animation *
797 weston_zoom_run(struct weston_surface *surface, float start, float stop,
798 weston_surface_animation_done_func_t done, void *data);
800 struct weston_surface_animation *
801 weston_fade_run(struct weston_surface *surface,
802 weston_surface_animation_done_func_t done, void *data);
803 struct weston_surface_animation *
804 weston_slide_run(struct weston_surface *surface, float start, float stop,
805 weston_surface_animation_done_func_t done, void *data);
808 weston_surface_set_color(struct weston_surface *surface,
809 float red, float green, float blue, float alpha);
812 weston_surface_destroy(struct weston_surface *surface);
815 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);
818 gles2_renderer_init(struct weston_compositor *ec);
820 gles2_renderer_destroy(struct weston_compositor *ec);
822 struct weston_compositor *
823 backend_init(struct wl_display *display, int argc, char *argv[],
824 const char *config_file);
827 module_init(struct weston_compositor *compositor);