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_compositor {
272 struct wl_signal destroy_signal;
274 EGLDisplay egl_display;
275 EGLContext egl_context;
276 EGLConfig egl_config;
278 struct weston_shader texture_shader_rgba;
279 struct weston_shader texture_shader_rgbx;
280 struct weston_shader texture_shader_egl_external;
281 struct weston_shader texture_shader_y_uv;
282 struct weston_shader texture_shader_y_u_v;
283 struct weston_shader texture_shader_y_xuxv;
284 struct weston_shader solid_shader;
285 struct weston_shader *current_shader;
286 struct wl_display *wl_display;
287 struct weston_shell_interface shell_interface;
289 struct wl_signal activate_signal;
290 struct wl_signal lock_signal;
291 struct wl_signal unlock_signal;
293 struct wl_signal show_input_panel_signal;
294 struct wl_signal hide_input_panel_signal;
296 struct wl_event_loop *input_loop;
297 struct wl_event_source *input_loop_source;
299 struct weston_layer fade_layer;
300 struct weston_layer cursor_layer;
302 struct wl_list output_list;
303 struct wl_list seat_list;
304 struct wl_list layer_list;
305 struct wl_list surface_list;
306 struct wl_list key_binding_list;
307 struct wl_list button_binding_list;
308 struct wl_list axis_binding_list;
310 struct weston_spring spring;
311 struct weston_animation animation;
312 struct weston_surface *surface;
316 struct wl_event_source *idle_source;
317 uint32_t idle_inhibit;
318 int option_idle_time; /* default timeout, s */
319 int idle_time; /* effective timeout, s */
322 struct wl_array vertices;
323 struct wl_array indices; /* only used in compositor-wayland */
324 struct wl_array vtxcnt;
325 struct weston_plane primary_plane;
330 PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
331 image_target_renderbuffer_storage;
332 PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
333 PFNEGLCREATEIMAGEKHRPROC create_image;
334 PFNEGLDESTROYIMAGEKHRPROC destroy_image;
336 int has_unpack_subimage;
339 PFNEGLBINDWAYLANDDISPLAYWL bind_display;
340 PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
341 PFNEGLQUERYWAYLANDBUFFERWL query_buffer;
342 int has_bind_display;
344 void (*destroy)(struct weston_compositor *ec);
345 void (*restore)(struct weston_compositor *ec);
346 int (*authenticate)(struct weston_compositor *c, uint32_t id);
348 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
352 uint32_t output_id_pool;
354 struct xkb_rule_names xkb_names;
355 struct xkb_context *xkb_context;
356 struct weston_xkb_info xkb_info;
359 struct weston_region {
360 struct wl_resource resource;
361 pixman_region32_t region;
364 /* Using weston_surface transformations
366 * To add a transformation to a surface, create a struct weston_transform, and
367 * add it to the list surface->geometry.transformation_list. Whenever you
368 * change the list, anything under surface->geometry, or anything in the
369 * weston_transforms linked into the list, you must set
370 * surface->geometry.dirty = 1.
372 * The order in the list defines the order of transformations. Let the list
373 * contain the transformation matrices M1, ..., Mn as head to tail. The
374 * transformation is applied to surface-local coordinate vector p as
375 * P = Mn * ... * M2 * M1 * p
376 * to produce the global coordinate vector P. The total transform
378 * is cached in surface->transform.matrix, and the inverse of it in
379 * surface->transform.inverse.
381 * The list always contains surface->transform.position transformation, which
382 * is the translation by surface->geometry.x and y.
384 * If you want to apply a transformation in local coordinates, add your
385 * weston_transform to the head of the list. If you want to apply a
386 * transformation in global coordinates, add it to the tail of the list.
389 struct weston_surface {
390 struct wl_surface surface;
391 struct weston_compositor *compositor;
394 pixman_region32_t clip;
395 pixman_region32_t damage;
396 pixman_region32_t opaque;
397 pixman_region32_t input;
400 struct wl_list layer_link;
401 struct weston_shader *shader;
404 struct weston_plane *plane;
406 /* Surface geometry state, mutable.
407 * If you change anything, set dirty = 1.
408 * That includes the transformations referenced from the list.
411 GLfloat x, y; /* surface translation on display */
412 int32_t width, height;
414 /* struct weston_transform */
415 struct wl_list transformation_list;
420 /* State derived from geometry state, read-only.
421 * This is updated by weston_surface_update_transform().
424 pixman_region32_t boundingbox;
425 pixman_region32_t opaque;
427 /* matrix and inverse are used only if enabled = 1.
428 * If enabled = 0, use x, y, width, height directly.
431 struct weston_matrix matrix;
432 struct weston_matrix inverse;
434 struct weston_transform position; /* matrix from x, y */
438 * Which output to vsync this surface to.
439 * Used to determine, whether to send or queue frame events.
440 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
442 struct weston_output *output;
445 * A more complete representation of all outputs this surface is
448 uint32_t output_mask;
450 struct wl_list frame_callback_list;
452 EGLImageKHR images[3];
456 struct wl_buffer *buffer;
457 struct wl_listener buffer_destroy_listener;
460 * If non-NULL, this function will be called on surface::attach after
461 * a new buffer has been set up for this surface. The integer params
462 * are the sx and sy paramerters supplied to surface::attach .
464 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
468 enum weston_key_state_update {
469 STATE_UPDATE_AUTOMATIC,
474 weston_surface_update_transform(struct weston_surface *surface);
477 weston_surface_to_global_fixed(struct weston_surface *surface,
478 wl_fixed_t sx, wl_fixed_t sy,
479 wl_fixed_t *x, wl_fixed_t *y);
481 weston_surface_to_global_float(struct weston_surface *surface,
482 GLfloat sx, GLfloat sy, GLfloat *x, GLfloat *y);
485 weston_surface_from_global_float(struct weston_surface *surface,
486 GLfloat x, GLfloat y, GLfloat *sx, GLfloat *sy);
488 weston_surface_from_global(struct weston_surface *surface,
489 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
491 weston_surface_from_global_fixed(struct weston_surface *surface,
492 wl_fixed_t x, wl_fixed_t y,
493 wl_fixed_t *sx, wl_fixed_t *sy);
496 weston_spring_init(struct weston_spring *spring,
497 double k, double current, double target);
499 weston_spring_update(struct weston_spring *spring, uint32_t msec);
501 weston_spring_done(struct weston_spring *spring);
504 weston_surface_activate(struct weston_surface *surface,
505 struct weston_seat *seat);
507 notify_motion(struct weston_seat *seat, uint32_t time,
508 wl_fixed_t x, wl_fixed_t y);
510 notify_button(struct weston_seat *seat, uint32_t time, int32_t button,
511 enum wl_pointer_button_state state);
513 notify_axis(struct weston_seat *seat, uint32_t time, uint32_t axis,
516 notify_key(struct weston_seat *seat, uint32_t time, uint32_t key,
517 enum wl_keyboard_key_state state,
518 enum weston_key_state_update update_state);
520 notify_modifiers(struct weston_seat *seat, uint32_t serial);
523 notify_pointer_focus(struct weston_seat *seat, struct weston_output *output,
524 wl_fixed_t x, wl_fixed_t y);
527 notify_keyboard_focus_in(struct weston_seat *seat, struct wl_array *keys,
528 enum weston_key_state_update update_state);
530 notify_keyboard_focus_out(struct weston_seat *seat);
533 notify_touch(struct weston_seat *seat, uint32_t time, int touch_id,
534 wl_fixed_t x, wl_fixed_t y, int touch_type);
537 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
540 weston_plane_init(struct weston_plane *plane, int32_t x, int32_t y);
542 weston_plane_release(struct weston_plane *plane);
545 weston_output_finish_frame(struct weston_output *output, uint32_t msecs);
547 weston_output_schedule_repaint(struct weston_output *output);
549 weston_output_damage(struct weston_output *output);
551 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
553 weston_compositor_fade(struct weston_compositor *compositor, float tint);
555 weston_compositor_damage_all(struct weston_compositor *compositor);
557 weston_compositor_unlock(struct weston_compositor *compositor);
559 weston_compositor_wake(struct weston_compositor *compositor);
561 weston_compositor_activity(struct weston_compositor *compositor);
563 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
566 struct weston_binding;
567 typedef void (*weston_key_binding_handler_t)(struct wl_seat *seat,
568 uint32_t time, uint32_t key,
570 struct weston_binding *
571 weston_compositor_add_key_binding(struct weston_compositor *compositor,
573 enum weston_keyboard_modifier modifier,
574 weston_key_binding_handler_t binding,
577 typedef void (*weston_button_binding_handler_t)(struct wl_seat *seat,
578 uint32_t time, uint32_t button,
580 struct weston_binding *
581 weston_compositor_add_button_binding(struct weston_compositor *compositor,
583 enum weston_keyboard_modifier modifier,
584 weston_button_binding_handler_t binding,
587 typedef void (*weston_axis_binding_handler_t)(struct wl_seat *seat,
588 uint32_t time, uint32_t axis,
589 wl_fixed_t value, void *data);
590 struct weston_binding *
591 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
593 enum weston_keyboard_modifier modifier,
594 weston_axis_binding_handler_t binding,
597 weston_binding_destroy(struct weston_binding *binding);
600 weston_binding_list_destroy_all(struct wl_list *list);
603 weston_compositor_run_key_binding(struct weston_compositor *compositor,
604 struct weston_seat *seat, uint32_t time,
606 enum wl_keyboard_key_state state);
608 weston_compositor_run_button_binding(struct weston_compositor *compositor,
609 struct weston_seat *seat, uint32_t time,
611 enum wl_pointer_button_state value);
613 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
614 struct weston_seat *seat, uint32_t time,
615 uint32_t axis, int32_t value);
618 weston_environment_get_fd(const char *env);
621 weston_compositor_top(struct weston_compositor *compositor);
623 struct weston_surface *
624 weston_surface_create(struct weston_compositor *compositor);
627 weston_surface_configure(struct weston_surface *surface,
628 GLfloat x, GLfloat y, int width, int height);
631 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
634 weston_surface_set_position(struct weston_surface *surface,
635 GLfloat x, GLfloat y);
638 weston_surface_is_mapped(struct weston_surface *surface);
641 weston_surface_assign_output(struct weston_surface *surface);
644 weston_surface_schedule_repaint(struct weston_surface *surface);
647 weston_surface_damage(struct weston_surface *surface);
650 weston_surface_damage_below(struct weston_surface *surface);
653 weston_surface_move_to_plane(struct weston_surface *surface,
654 struct weston_plane *plane);
656 weston_surface_unmap(struct weston_surface *surface);
659 weston_buffer_post_release(struct wl_buffer *buffer);
662 weston_compositor_get_time(void);
665 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display,
666 int argc, char *argv[], const char *config_file);
668 weston_compositor_init_gl(struct weston_compositor *ec);
670 weston_compositor_shutdown(struct weston_compositor *ec);
672 weston_text_cursor_position_notify(struct weston_surface *surface,
673 wl_fixed_t x, wl_fixed_t y);
675 weston_output_init_zoom(struct weston_output *output);
677 weston_output_update_zoom(struct weston_output *output, uint32_t type);
679 weston_output_update_matrix(struct weston_output *output);
681 weston_output_move(struct weston_output *output, int x, int y);
683 weston_output_init(struct weston_output *output, struct weston_compositor *c,
684 int x, int y, int width, int height, uint32_t transform);
686 weston_output_destroy(struct weston_output *output);
689 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
691 weston_seat_init_pointer(struct weston_seat *seat);
693 weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
695 weston_seat_init_touch(struct weston_seat *seat);
698 weston_seat_release(struct weston_seat *seat);
700 /* String literal of spaces, the same width as the timestamp. */
701 #define STAMP_SPACE " "
704 weston_log_file_open(const char *filename);
706 weston_log_file_close(void);
708 weston_log(const char *fmt, ...)
709 __attribute__ ((format (printf, 1, 2)));
711 weston_log_continue(const char *fmt, ...)
712 __attribute__ ((format (printf, 1, 2)));
719 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
722 tty_create(struct weston_compositor *compositor,
723 tty_vt_func_t vt_func, int tty_nr);
726 tty_destroy(struct tty *tty);
729 tty_reset(struct tty *tty);
732 tty_activate_vt(struct tty *tty, int vt);
735 screenshooter_create(struct weston_compositor *ec);
738 clipboard_create(struct weston_seat *seat);
741 text_cursor_position_notifier_create(struct weston_compositor *ec);
744 input_method_create(struct weston_compositor *ec,
745 struct weston_seat *seat);
747 struct weston_process;
748 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
751 struct weston_process {
753 weston_process_cleanup_func_t cleanup;
758 weston_client_launch(struct weston_compositor *compositor,
759 struct weston_process *proc,
761 weston_process_cleanup_func_t cleanup);
764 weston_watch_process(struct weston_process *process);
767 weston_xserver_init(struct weston_compositor *compositor);
769 struct weston_surface_animation;
770 typedef void (*weston_surface_animation_done_func_t)(struct weston_surface_animation *animation, void *data);
772 struct weston_surface_animation *
773 weston_zoom_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
774 weston_surface_animation_done_func_t done, void *data);
776 struct weston_surface_animation *
777 weston_fade_run(struct weston_surface *surface,
778 weston_surface_animation_done_func_t done, void *data);
779 struct weston_surface_animation *
780 weston_slide_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
781 weston_surface_animation_done_func_t done, void *data);
784 weston_surface_set_color(struct weston_surface *surface,
785 GLfloat red, GLfloat green, GLfloat blue, GLfloat alpha);
788 weston_surface_destroy(struct weston_surface *surface);
790 struct weston_compositor *
791 backend_init(struct wl_display *display, int argc, char *argv[],
792 const char *config_file);
795 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);
798 gles2_renderer_repaint_output(struct weston_output *output,
799 pixman_region32_t *output_damage);