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;
51 enum weston_keyboard_modifier {
52 MODIFIER_CTRL = (1 << 0),
53 MODIFIER_ALT = (1 << 1),
54 MODIFIER_SUPER = (1 << 2),
58 LED_NUM_LOCK = (1 << 0),
59 LED_CAPS_LOCK = (1 << 1),
60 LED_SCROLL_LOCK = (1 << 2),
65 int32_t width, height;
70 struct weston_shell_client {
71 void (*send_configure)(struct weston_surface *surface,
72 uint32_t edges, int32_t width, int32_t height);
75 struct weston_shell_interface {
76 void *shell; /* either desktop or tablet */
78 struct shell_surface *(*create_shell_surface)(void *shell,
79 struct weston_surface *surface,
80 const struct weston_shell_client *client);
82 void (*set_toplevel)(struct shell_surface *shsurf);
84 void (*set_transient)(struct shell_surface *shsurf,
85 struct shell_surface *pshsurf,
86 int x, int y, uint32_t flags);
87 int (*move)(struct shell_surface *shsurf, struct weston_seat *ws);
88 int (*resize)(struct shell_surface *shsurf,
89 struct weston_seat *ws, uint32_t edges);
93 struct weston_border {
94 int32_t left, right, top, bottom;
97 struct weston_animation {
98 void (*frame)(struct weston_animation *animation,
99 struct weston_output *output, uint32_t msecs);
104 struct weston_spring {
118 struct weston_output_zoom {
125 float trans_x, trans_y;
126 struct weston_animation animation_z;
127 struct weston_spring spring_z;
130 /* bit compatible with drm definitions. */
138 struct weston_read_pixels {
140 int x, y, width, height;
141 void (*done)(struct weston_read_pixels *read_pixels,
142 struct weston_output *output);
146 struct weston_output {
150 struct wl_list resource_list;
151 struct wl_global *global;
152 struct weston_compositor *compositor;
153 struct weston_matrix matrix;
154 struct wl_list frame_callback_list;
155 struct wl_list animation_list;
156 int32_t x, y, mm_width, mm_height;
157 struct weston_border border;
158 pixman_region32_t region;
159 pixman_region32_t previous_damage;
162 int repaint_scheduled;
163 struct weston_output_zoom zoom;
165 struct wl_list read_pixels_list;
166 struct wl_signal frame_signal;
171 struct weston_mode *current;
172 struct weston_mode *origin;
173 struct wl_list mode_list;
175 void (*repaint)(struct weston_output *output,
176 pixman_region32_t *damage);
177 void (*destroy)(struct weston_output *output);
178 void (*assign_planes)(struct weston_output *output);
179 int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
181 /* backlight values are on 0-255 range, where higher is brighter */
182 uint32_t backlight_current;
183 void (*set_backlight)(struct weston_output *output, uint32_t value);
184 void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
187 struct weston_xkb_info {
188 struct xkb_keymap *keymap;
192 xkb_mod_index_t ctrl_mod;
193 xkb_mod_index_t alt_mod;
194 xkb_mod_index_t super_mod;
195 xkb_led_index_t num_led;
196 xkb_led_index_t caps_led;
197 xkb_led_index_t scroll_led;
202 struct wl_pointer pointer;
204 struct wl_keyboard keyboard;
206 struct wl_touch touch;
209 struct weston_compositor *compositor;
210 struct weston_surface *sprite;
211 struct weston_surface *drag_surface;
212 struct wl_listener drag_surface_destroy_listener;
213 int32_t hotspot_x, hotspot_y;
215 enum weston_keyboard_modifier modifier_state;
217 struct wl_surface *saved_kbd_focus;
218 struct wl_listener saved_kbd_focus_listener;
221 struct wl_surface *touch_focus;
222 struct wl_listener touch_focus_listener;
223 struct wl_resource *touch_focus_resource;
224 struct wl_listener touch_focus_resource_listener;
226 struct wl_listener new_drag_icon_listener;
228 void (*led_update)(struct weston_seat *ws, enum weston_led leds);
230 struct weston_xkb_info xkb_info;
232 struct xkb_state *state;
233 uint32_t mods_depressed;
234 uint32_t mods_latched;
235 uint32_t mods_locked;
237 enum weston_led leds;
241 struct weston_shader {
243 GLuint vertex_shader, fragment_shader;
248 GLint texwidth_uniform;
249 GLint opaque_uniform;
253 WESTON_COMPOSITOR_ACTIVE,
254 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
255 WESTON_COMPOSITOR_SLEEPING /* no rendering, no frame events */
258 struct weston_layer {
259 struct wl_list surface_list;
263 struct weston_compositor {
265 struct wl_signal destroy_signal;
271 struct weston_shader texture_shader;
272 struct weston_shader solid_shader;
273 struct weston_shader *current_shader;
274 struct wl_display *wl_display;
275 struct weston_shell_interface shell_interface;
277 struct wl_signal activate_signal;
278 struct wl_signal lock_signal;
279 struct wl_signal unlock_signal;
281 struct wl_event_loop *input_loop;
282 struct wl_event_source *input_loop_source;
284 /* There can be more than one, but not right now... */
285 struct weston_seat *seat;
287 struct weston_layer fade_layer;
288 struct weston_layer cursor_layer;
290 struct wl_list output_list;
291 struct wl_list seat_list;
292 struct wl_list layer_list;
293 struct wl_list surface_list;
294 struct wl_list key_binding_list;
295 struct wl_list button_binding_list;
296 struct wl_list axis_binding_list;
298 struct weston_spring spring;
299 struct weston_animation animation;
300 struct weston_surface *surface;
304 struct wl_event_source *idle_source;
305 uint32_t idle_inhibit;
306 int option_idle_time; /* default timeout, s */
307 int idle_time; /* effective timeout, s */
310 struct wl_array vertices, indices;
311 pixman_region32_t damage;
315 PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
316 image_target_renderbuffer_storage;
317 PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
318 PFNEGLCREATEIMAGEKHRPROC create_image;
319 PFNEGLDESTROYIMAGEKHRPROC destroy_image;
321 int has_unpack_subimage;
324 PFNEGLBINDWAYLANDDISPLAYWL bind_display;
325 PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
326 int has_bind_display;
328 void (*destroy)(struct weston_compositor *ec);
329 int (*authenticate)(struct weston_compositor *c, uint32_t id);
331 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
335 uint32_t output_id_pool;
337 struct xkb_rule_names xkb_names;
338 struct xkb_context *xkb_context;
339 struct weston_xkb_info xkb_info;
342 enum weston_output_flags {
343 WL_OUTPUT_FLIPPED = 0x01
346 struct weston_region {
347 struct wl_resource resource;
348 pixman_region32_t region;
351 /* Using weston_surface transformations
353 * To add a transformation to a surface, create a struct weston_transform, and
354 * add it to the list surface->geometry.transformation_list. Whenever you
355 * change the list, anything under surface->geometry, or anything in the
356 * weston_transforms linked into the list, you must set
357 * surface->geometry.dirty = 1.
359 * The order in the list defines the order of transformations. Let the list
360 * contain the transformation matrices M1, ..., Mn as head to tail. The
361 * transformation is applied to surface-local coordinate vector p as
362 * P = Mn * ... * M2 * M1 * p
363 * to produce the global coordinate vector P. The total transform
365 * is cached in surface->transform.matrix, and the inverse of it in
366 * surface->transform.inverse.
368 * The list always contains surface->transform.position transformation, which
369 * is the translation by surface->geometry.x and y.
371 * If you want to apply a transformation in local coordinates, add your
372 * weston_transform to the head of the list. If you want to apply a
373 * transformation in global coordinates, add it to the tail of the list.
376 struct weston_surface {
377 struct wl_surface surface;
378 struct weston_compositor *compositor;
380 pixman_region32_t clip;
381 pixman_region32_t damage;
382 pixman_region32_t opaque;
383 pixman_region32_t input;
386 struct wl_list layer_link;
387 struct weston_shader *shader;
389 GLfloat opaque_rect[4];
393 /* Surface geometry state, mutable.
394 * If you change anything, set dirty = 1.
395 * That includes the transformations referenced from the list.
398 GLfloat x, y; /* surface translation on display */
399 int32_t width, height;
401 /* struct weston_transform */
402 struct wl_list transformation_list;
407 /* State derived from geometry state, read-only.
408 * This is updated by weston_surface_update_transform().
411 pixman_region32_t boundingbox;
412 pixman_region32_t opaque;
414 /* matrix and inverse are used only if enabled = 1.
415 * If enabled = 0, use x, y, width, height directly.
418 struct weston_matrix matrix;
419 struct weston_matrix inverse;
421 struct weston_transform position; /* matrix from x, y */
425 * Which output to vsync this surface to.
426 * Used to determine, whether to send or queue frame events.
427 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
429 struct weston_output *output;
432 * A more complete representation of all outputs this surface is
435 uint32_t output_mask;
437 struct wl_list frame_callback_list;
441 struct wl_buffer *buffer;
442 struct wl_listener buffer_destroy_listener;
445 * If non-NULL, this function will be called on surface::attach after
446 * a new buffer has been set up for this surface. The integer params
447 * are the sx and sy paramerters supplied to surface::attach .
449 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
454 weston_surface_update_transform(struct weston_surface *surface);
457 weston_surface_to_global_fixed(struct weston_surface *surface,
458 wl_fixed_t sx, wl_fixed_t sy,
459 wl_fixed_t *x, wl_fixed_t *y);
461 weston_surface_to_global_float(struct weston_surface *surface,
462 GLfloat sx, GLfloat sy, GLfloat *x, GLfloat *y);
465 weston_surface_from_global(struct weston_surface *surface,
466 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
468 weston_surface_from_global_fixed(struct weston_surface *surface,
469 wl_fixed_t x, wl_fixed_t y,
470 wl_fixed_t *sx, wl_fixed_t *sy);
473 weston_spring_init(struct weston_spring *spring,
474 double k, double current, double target);
476 weston_spring_update(struct weston_spring *spring, uint32_t msec);
478 weston_spring_done(struct weston_spring *spring);
481 weston_surface_activate(struct weston_surface *surface,
482 struct weston_seat *seat);
484 weston_surface_draw(struct weston_surface *es,
485 struct weston_output *output, pixman_region32_t *damage);
488 notify_motion(struct wl_seat *seat, uint32_t time,
489 wl_fixed_t x, wl_fixed_t y);
491 notify_button(struct wl_seat *seat, uint32_t time, int32_t button,
492 enum wl_pointer_button_state state);
494 notify_axis(struct wl_seat *seat, uint32_t time, uint32_t axis,
497 notify_key(struct wl_seat *seat, uint32_t time, uint32_t key,
498 enum wl_keyboard_key_state state);
501 notify_pointer_focus(struct wl_seat *seat, struct weston_output *output,
502 wl_fixed_t x, wl_fixed_t y);
505 notify_keyboard_focus(struct wl_seat *seat, struct wl_array *keys);
508 notify_touch(struct wl_seat *seat, uint32_t time, int touch_id,
509 wl_fixed_t x, wl_fixed_t y, int touch_type);
512 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
515 weston_output_finish_frame(struct weston_output *output, int msecs);
517 weston_output_damage(struct weston_output *output);
519 weston_output_do_read_pixels(struct weston_output *output);
521 weston_compositor_repick(struct weston_compositor *compositor);
523 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
525 weston_compositor_fade(struct weston_compositor *compositor, float tint);
527 weston_compositor_damage_all(struct weston_compositor *compositor);
529 weston_compositor_unlock(struct weston_compositor *compositor);
531 weston_compositor_wake(struct weston_compositor *compositor);
533 weston_compositor_activity(struct weston_compositor *compositor);
535 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
538 struct weston_binding;
539 typedef void (*weston_key_binding_handler_t)(struct wl_seat *seat,
540 uint32_t time, uint32_t key,
542 struct weston_binding *
543 weston_compositor_add_key_binding(struct weston_compositor *compositor,
545 enum weston_keyboard_modifier modifier,
546 weston_key_binding_handler_t binding,
549 typedef void (*weston_button_binding_handler_t)(struct wl_seat *seat,
550 uint32_t time, uint32_t button,
552 struct weston_binding *
553 weston_compositor_add_button_binding(struct weston_compositor *compositor,
555 enum weston_keyboard_modifier modifier,
556 weston_button_binding_handler_t binding,
559 typedef void (*weston_axis_binding_handler_t)(struct wl_seat *seat,
560 uint32_t time, uint32_t axis,
561 wl_fixed_t value, void *data);
562 struct weston_binding *
563 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
565 enum weston_keyboard_modifier modifier,
566 weston_axis_binding_handler_t binding,
569 weston_binding_destroy(struct weston_binding *binding);
572 weston_binding_list_destroy_all(struct wl_list *list);
575 weston_compositor_run_key_binding(struct weston_compositor *compositor,
576 struct weston_seat *seat, uint32_t time,
578 enum wl_keyboard_key_state state);
580 weston_compositor_run_button_binding(struct weston_compositor *compositor,
581 struct weston_seat *seat, uint32_t time,
583 enum wl_pointer_button_state value);
585 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
586 struct weston_seat *seat, uint32_t time,
587 uint32_t axis, int32_t value);
590 weston_environment_get_fd(const char *env);
593 weston_compositor_top(struct weston_compositor *compositor);
595 struct weston_surface *
596 weston_surface_create(struct weston_compositor *compositor);
599 weston_surface_configure(struct weston_surface *surface,
600 GLfloat x, GLfloat y, int width, int height);
603 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
606 weston_surface_set_position(struct weston_surface *surface,
607 GLfloat x, GLfloat y);
610 weston_surface_is_mapped(struct weston_surface *surface);
613 weston_surface_assign_output(struct weston_surface *surface);
616 weston_surface_damage(struct weston_surface *surface);
619 weston_surface_damage_below(struct weston_surface *surface);
622 weston_buffer_post_release(struct wl_buffer *buffer);
625 weston_compositor_get_time(void);
628 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display,
629 int argc, char *argv[], const char *config_file);
631 weston_compositor_shutdown(struct weston_compositor *ec);
633 weston_text_cursor_position_notify(struct weston_surface *surface,
634 wl_fixed_t x, wl_fixed_t y);
636 weston_output_update_zoom(struct weston_output *output,
637 wl_fixed_t x, wl_fixed_t y,
640 weston_output_update_matrix(struct weston_output *output);
642 weston_output_move(struct weston_output *output, int x, int y);
644 weston_output_init(struct weston_output *output, struct weston_compositor *c,
645 int x, int y, int width, int height, uint32_t flags);
647 weston_output_destroy(struct weston_output *output);
650 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
652 weston_seat_init_pointer(struct weston_seat *seat);
654 weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
656 weston_seat_init_touch(struct weston_seat *seat);
659 weston_seat_release(struct weston_seat *seat);
666 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
669 tty_create(struct weston_compositor *compositor,
670 tty_vt_func_t vt_func, int tty_nr);
673 tty_destroy(struct tty *tty);
676 tty_activate_vt(struct tty *tty, int vt);
679 screenshooter_create(struct weston_compositor *ec);
682 clipboard_create(struct weston_seat *seat);
685 text_cursor_position_notifier_create(struct weston_compositor *ec);
687 struct weston_process;
688 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
691 struct weston_process {
693 weston_process_cleanup_func_t cleanup;
698 weston_client_launch(struct weston_compositor *compositor,
699 struct weston_process *proc,
701 weston_process_cleanup_func_t cleanup);
704 weston_watch_process(struct weston_process *process);
707 weston_xserver_init(struct weston_compositor *compositor);
710 typedef void (*weston_zoom_done_func_t)(struct weston_zoom *zoom, void *data);
713 weston_zoom_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
714 weston_zoom_done_func_t done, void *data);
717 typedef void (*weston_fade_done_func_t)(struct weston_fade *fade, void *data);
720 weston_fade_run(struct weston_surface *surface,
721 weston_fade_done_func_t done, void *data);
725 weston_surface_set_color(struct weston_surface *surface,
726 GLfloat red, GLfloat green, GLfloat blue, GLfloat alpha);
729 weston_surface_destroy(struct weston_surface *surface);
731 struct weston_compositor *
732 backend_init(struct wl_display *display, int argc, char *argv[],
733 const char *config_file);
736 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);