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;
102 struct weston_output_zoom {
106 float trans_x, trans_y;
109 /* bit compatible with drm definitions. */
117 struct weston_read_pixels {
119 int x, y, width, height;
120 void (*done)(struct weston_read_pixels *read_pixels,
121 struct weston_output *output);
125 struct weston_output {
129 struct wl_list resource_list;
130 struct wl_global *global;
131 struct weston_compositor *compositor;
132 struct weston_matrix matrix;
133 struct wl_list frame_callback_list;
134 struct wl_list animation_list;
135 int32_t x, y, mm_width, mm_height;
136 struct weston_border border;
137 pixman_region32_t region;
138 pixman_region32_t previous_damage;
141 int repaint_scheduled;
142 struct weston_output_zoom zoom;
144 struct wl_list read_pixels_list;
145 struct wl_signal frame_signal;
150 struct weston_mode *current;
151 struct weston_mode *origin;
152 struct wl_list mode_list;
154 void (*repaint)(struct weston_output *output,
155 pixman_region32_t *damage);
156 void (*destroy)(struct weston_output *output);
157 void (*assign_planes)(struct weston_output *output);
158 int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
160 /* backlight values are on 0-255 range, where higher is brighter */
161 uint32_t backlight_current;
162 void (*set_backlight)(struct weston_output *output, uint32_t value);
163 void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
166 struct weston_xkb_info {
167 struct xkb_keymap *keymap;
171 xkb_mod_index_t ctrl_mod;
172 xkb_mod_index_t alt_mod;
173 xkb_mod_index_t super_mod;
174 xkb_led_index_t num_led;
175 xkb_led_index_t caps_led;
176 xkb_led_index_t scroll_led;
181 struct wl_pointer pointer;
183 struct wl_keyboard keyboard;
185 struct wl_touch touch;
188 struct weston_compositor *compositor;
189 struct weston_surface *sprite;
190 struct weston_surface *drag_surface;
191 struct wl_listener drag_surface_destroy_listener;
192 int32_t hotspot_x, hotspot_y;
194 enum weston_keyboard_modifier modifier_state;
196 struct wl_surface *saved_kbd_focus;
197 struct wl_listener saved_kbd_focus_listener;
200 struct wl_surface *touch_focus;
201 struct wl_listener touch_focus_listener;
202 struct wl_resource *touch_focus_resource;
203 struct wl_listener touch_focus_resource_listener;
205 struct wl_listener new_drag_icon_listener;
207 void (*led_update)(struct weston_seat *ws, enum weston_led leds);
209 struct weston_xkb_info xkb_info;
211 struct xkb_state *state;
212 uint32_t mods_depressed;
213 uint32_t mods_latched;
214 uint32_t mods_locked;
216 enum weston_led leds;
220 struct weston_shader {
222 GLuint vertex_shader, fragment_shader;
227 GLint texwidth_uniform;
228 GLint opaque_uniform;
231 struct weston_animation {
232 void (*frame)(struct weston_animation *animation,
233 struct weston_output *output, uint32_t msecs);
237 struct weston_spring {
247 WESTON_COMPOSITOR_ACTIVE,
248 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
249 WESTON_COMPOSITOR_SLEEPING /* no rendering, no frame events */
252 struct weston_layer {
253 struct wl_list surface_list;
257 struct weston_compositor {
259 struct wl_signal destroy_signal;
265 struct weston_shader texture_shader;
266 struct weston_shader solid_shader;
267 struct weston_shader *current_shader;
268 struct wl_display *wl_display;
269 struct weston_shell_interface shell_interface;
271 struct wl_signal activate_signal;
272 struct wl_signal lock_signal;
273 struct wl_signal unlock_signal;
275 struct wl_event_loop *input_loop;
276 struct wl_event_source *input_loop_source;
278 /* There can be more than one, but not right now... */
279 struct weston_seat *seat;
281 struct weston_layer fade_layer;
282 struct weston_layer cursor_layer;
284 struct wl_list output_list;
285 struct wl_list seat_list;
286 struct wl_list layer_list;
287 struct wl_list surface_list;
288 struct wl_list key_binding_list;
289 struct wl_list button_binding_list;
290 struct wl_list axis_binding_list;
292 struct weston_spring spring;
293 struct weston_animation animation;
294 struct weston_surface *surface;
298 struct wl_event_source *idle_source;
299 uint32_t idle_inhibit;
300 int option_idle_time; /* default timeout, s */
301 int idle_time; /* effective timeout, s */
304 struct wl_array vertices, indices;
305 pixman_region32_t damage;
309 PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
310 image_target_renderbuffer_storage;
311 PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
312 PFNEGLCREATEIMAGEKHRPROC create_image;
313 PFNEGLDESTROYIMAGEKHRPROC destroy_image;
315 int has_unpack_subimage;
318 PFNEGLBINDWAYLANDDISPLAYWL bind_display;
319 PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
320 int has_bind_display;
322 void (*destroy)(struct weston_compositor *ec);
323 int (*authenticate)(struct weston_compositor *c, uint32_t id);
325 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
329 uint32_t output_id_pool;
331 struct xkb_rule_names xkb_names;
332 struct xkb_context *xkb_context;
333 struct weston_xkb_info xkb_info;
336 enum weston_output_flags {
337 WL_OUTPUT_FLIPPED = 0x01
340 struct weston_region {
341 struct wl_resource resource;
342 pixman_region32_t region;
345 /* Using weston_surface transformations
347 * To add a transformation to a surface, create a struct weston_transform, and
348 * add it to the list surface->geometry.transformation_list. Whenever you
349 * change the list, anything under surface->geometry, or anything in the
350 * weston_transforms linked into the list, you must set
351 * surface->geometry.dirty = 1.
353 * The order in the list defines the order of transformations. Let the list
354 * contain the transformation matrices M1, ..., Mn as head to tail. The
355 * transformation is applied to surface-local coordinate vector p as
356 * P = Mn * ... * M2 * M1 * p
357 * to produce the global coordinate vector P. The total transform
359 * is cached in surface->transform.matrix, and the inverse of it in
360 * surface->transform.inverse.
362 * The list always contains surface->transform.position transformation, which
363 * is the translation by surface->geometry.x and y.
365 * If you want to apply a transformation in local coordinates, add your
366 * weston_transform to the head of the list. If you want to apply a
367 * transformation in global coordinates, add it to the tail of the list.
370 struct weston_surface {
371 struct wl_surface surface;
372 struct weston_compositor *compositor;
374 pixman_region32_t clip;
375 pixman_region32_t damage;
376 pixman_region32_t opaque;
377 pixman_region32_t input;
380 struct wl_list layer_link;
381 struct weston_shader *shader;
383 GLfloat opaque_rect[4];
387 /* Surface geometry state, mutable.
388 * If you change anything, set dirty = 1.
389 * That includes the transformations referenced from the list.
392 GLfloat x, y; /* surface translation on display */
393 int32_t width, height;
395 /* struct weston_transform */
396 struct wl_list transformation_list;
401 /* State derived from geometry state, read-only.
402 * This is updated by weston_surface_update_transform().
405 pixman_region32_t boundingbox;
406 pixman_region32_t opaque;
408 /* matrix and inverse are used only if enabled = 1.
409 * If enabled = 0, use x, y, width, height directly.
412 struct weston_matrix matrix;
413 struct weston_matrix inverse;
415 struct weston_transform position; /* matrix from x, y */
419 * Which output to vsync this surface to.
420 * Used to determine, whether to send or queue frame events.
421 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
423 struct weston_output *output;
426 * A more complete representation of all outputs this surface is
429 uint32_t output_mask;
431 struct wl_list frame_callback_list;
435 struct wl_buffer *buffer;
436 struct wl_listener buffer_destroy_listener;
439 * If non-NULL, this function will be called on surface::attach after
440 * a new buffer has been set up for this surface. The integer params
441 * are the sx and sy paramerters supplied to surface::attach .
443 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
448 weston_surface_update_transform(struct weston_surface *surface);
451 weston_surface_to_global_fixed(struct weston_surface *surface,
452 wl_fixed_t sx, wl_fixed_t sy,
453 wl_fixed_t *x, wl_fixed_t *y);
455 weston_surface_to_global_float(struct weston_surface *surface,
456 GLfloat sx, GLfloat sy, GLfloat *x, GLfloat *y);
459 weston_surface_from_global(struct weston_surface *surface,
460 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
462 weston_surface_from_global_fixed(struct weston_surface *surface,
463 wl_fixed_t x, wl_fixed_t y,
464 wl_fixed_t *sx, wl_fixed_t *sy);
467 weston_spring_init(struct weston_spring *spring,
468 double k, double current, double target);
470 weston_spring_update(struct weston_spring *spring, uint32_t msec);
472 weston_spring_done(struct weston_spring *spring);
475 weston_surface_activate(struct weston_surface *surface,
476 struct weston_seat *seat);
478 weston_surface_draw(struct weston_surface *es,
479 struct weston_output *output, pixman_region32_t *damage);
482 notify_motion(struct wl_seat *seat, uint32_t time,
483 wl_fixed_t x, wl_fixed_t y);
485 notify_button(struct wl_seat *seat, uint32_t time, int32_t button,
486 enum wl_pointer_button_state state);
488 notify_axis(struct wl_seat *seat, uint32_t time, uint32_t axis,
491 notify_key(struct wl_seat *seat, uint32_t time, uint32_t key,
492 enum wl_keyboard_key_state state);
495 notify_pointer_focus(struct wl_seat *seat, struct weston_output *output,
496 wl_fixed_t x, wl_fixed_t y);
499 notify_keyboard_focus(struct wl_seat *seat, struct wl_array *keys);
502 notify_touch(struct wl_seat *seat, uint32_t time, int touch_id,
503 wl_fixed_t x, wl_fixed_t y, int touch_type);
506 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
509 weston_output_finish_frame(struct weston_output *output, int msecs);
511 weston_output_damage(struct weston_output *output);
513 weston_output_do_read_pixels(struct weston_output *output);
515 weston_compositor_repick(struct weston_compositor *compositor);
517 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
519 weston_compositor_fade(struct weston_compositor *compositor, float tint);
521 weston_compositor_damage_all(struct weston_compositor *compositor);
523 weston_compositor_unlock(struct weston_compositor *compositor);
525 weston_compositor_wake(struct weston_compositor *compositor);
527 weston_compositor_activity(struct weston_compositor *compositor);
529 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
532 struct weston_binding;
533 typedef void (*weston_key_binding_handler_t)(struct wl_seat *seat,
534 uint32_t time, uint32_t key,
536 struct weston_binding *
537 weston_compositor_add_key_binding(struct weston_compositor *compositor,
539 enum weston_keyboard_modifier modifier,
540 weston_key_binding_handler_t binding,
543 typedef void (*weston_button_binding_handler_t)(struct wl_seat *seat,
544 uint32_t time, uint32_t button,
546 struct weston_binding *
547 weston_compositor_add_button_binding(struct weston_compositor *compositor,
549 enum weston_keyboard_modifier modifier,
550 weston_button_binding_handler_t binding,
553 typedef void (*weston_axis_binding_handler_t)(struct wl_seat *seat,
554 uint32_t time, uint32_t axis,
555 wl_fixed_t value, void *data);
556 struct weston_binding *
557 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
559 enum weston_keyboard_modifier modifier,
560 weston_axis_binding_handler_t binding,
563 weston_binding_destroy(struct weston_binding *binding);
566 weston_binding_list_destroy_all(struct wl_list *list);
569 weston_compositor_run_key_binding(struct weston_compositor *compositor,
570 struct weston_seat *seat, uint32_t time,
572 enum wl_keyboard_key_state state);
574 weston_compositor_run_button_binding(struct weston_compositor *compositor,
575 struct weston_seat *seat, uint32_t time,
577 enum wl_pointer_button_state value);
579 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
580 struct weston_seat *seat, uint32_t time,
581 uint32_t axis, int32_t value);
584 weston_environment_get_fd(const char *env);
587 weston_compositor_top(struct weston_compositor *compositor);
589 struct weston_surface *
590 weston_surface_create(struct weston_compositor *compositor);
593 weston_surface_configure(struct weston_surface *surface,
594 GLfloat x, GLfloat y, int width, int height);
597 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
600 weston_surface_set_position(struct weston_surface *surface,
601 GLfloat x, GLfloat y);
604 weston_surface_is_mapped(struct weston_surface *surface);
607 weston_surface_assign_output(struct weston_surface *surface);
610 weston_surface_damage(struct weston_surface *surface);
613 weston_surface_damage_below(struct weston_surface *surface);
616 weston_buffer_post_release(struct wl_buffer *buffer);
619 weston_compositor_get_time(void);
622 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display,
623 int argc, char *argv[], const char *config_file);
625 weston_compositor_shutdown(struct weston_compositor *ec);
627 weston_text_cursor_position_notify(struct weston_surface *surface,
628 wl_fixed_t x, wl_fixed_t y);
630 weston_output_update_zoom(struct weston_output *output,
631 wl_fixed_t x, wl_fixed_t y,
634 weston_output_update_matrix(struct weston_output *output);
636 weston_output_move(struct weston_output *output, int x, int y);
638 weston_output_init(struct weston_output *output, struct weston_compositor *c,
639 int x, int y, int width, int height, uint32_t flags);
641 weston_output_destroy(struct weston_output *output);
644 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
646 weston_seat_init_pointer(struct weston_seat *seat);
648 weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
650 weston_seat_init_touch(struct weston_seat *seat);
653 weston_seat_release(struct weston_seat *seat);
660 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
663 tty_create(struct weston_compositor *compositor,
664 tty_vt_func_t vt_func, int tty_nr);
667 tty_destroy(struct tty *tty);
670 tty_activate_vt(struct tty *tty, int vt);
673 screenshooter_create(struct weston_compositor *ec);
676 clipboard_create(struct weston_seat *seat);
679 text_cursor_position_notifier_create(struct weston_compositor *ec);
681 struct weston_process;
682 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
685 struct weston_process {
687 weston_process_cleanup_func_t cleanup;
692 weston_client_launch(struct weston_compositor *compositor,
693 struct weston_process *proc,
695 weston_process_cleanup_func_t cleanup);
698 weston_watch_process(struct weston_process *process);
701 weston_xserver_init(struct weston_compositor *compositor);
704 typedef void (*weston_zoom_done_func_t)(struct weston_zoom *zoom, void *data);
707 weston_zoom_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
708 weston_zoom_done_func_t done, void *data);
711 typedef void (*weston_fade_done_func_t)(struct weston_fade *fade, void *data);
714 weston_fade_run(struct weston_surface *surface,
715 weston_fade_done_func_t done, void *data);
719 weston_surface_set_color(struct weston_surface *surface,
720 GLfloat red, GLfloat green, GLfloat blue, GLfloat alpha);
723 weston_surface_destroy(struct weston_surface *surface);
725 struct weston_compositor *
726 backend_init(struct wl_display *display, int argc, char *argv[],
727 const char *config_file);
730 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);