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 int32_t x, y, mm_width, mm_height;
135 struct weston_border border;
136 pixman_region32_t region;
137 pixman_region32_t previous_damage;
140 int repaint_scheduled;
141 struct weston_output_zoom zoom;
143 struct wl_list read_pixels_list;
144 struct wl_signal frame_signal;
149 struct weston_mode *current;
150 struct weston_mode *origin;
151 struct wl_list mode_list;
153 void (*repaint)(struct weston_output *output,
154 pixman_region32_t *damage);
155 void (*destroy)(struct weston_output *output);
156 void (*assign_planes)(struct weston_output *output);
157 int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
159 /* backlight values are on 0-255 range, where higher is brighter */
160 uint32_t backlight_current;
161 void (*set_backlight)(struct weston_output *output, uint32_t value);
162 void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
165 struct weston_xkb_info {
166 struct xkb_keymap *keymap;
170 xkb_mod_index_t ctrl_mod;
171 xkb_mod_index_t alt_mod;
172 xkb_mod_index_t super_mod;
173 xkb_led_index_t num_led;
174 xkb_led_index_t caps_led;
175 xkb_led_index_t scroll_led;
180 struct wl_pointer pointer;
182 struct wl_keyboard keyboard;
184 struct wl_touch touch;
187 struct weston_compositor *compositor;
188 struct weston_surface *sprite;
189 struct weston_surface *drag_surface;
190 struct wl_listener drag_surface_destroy_listener;
191 int32_t hotspot_x, hotspot_y;
193 enum weston_keyboard_modifier modifier_state;
195 struct wl_surface *saved_kbd_focus;
196 struct wl_listener saved_kbd_focus_listener;
199 struct wl_surface *touch_focus;
200 struct wl_listener touch_focus_listener;
201 struct wl_resource *touch_focus_resource;
202 struct wl_listener touch_focus_resource_listener;
204 struct wl_listener new_drag_icon_listener;
206 void (*led_update)(struct weston_seat *ws, enum weston_led leds);
208 struct weston_xkb_info xkb_info;
210 struct xkb_state *state;
211 uint32_t mods_depressed;
212 uint32_t mods_latched;
213 uint32_t mods_locked;
215 enum weston_led leds;
219 struct weston_shader {
221 GLuint vertex_shader, fragment_shader;
225 GLint brightness_uniform;
226 GLint saturation_uniform;
228 GLint texwidth_uniform;
229 GLint opaque_uniform;
232 struct weston_animation {
233 void (*frame)(struct weston_animation *animation,
234 struct weston_output *output, uint32_t msecs);
238 struct weston_spring {
248 WESTON_COMPOSITOR_ACTIVE,
249 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
250 WESTON_COMPOSITOR_SLEEPING /* no rendering, no frame events */
253 struct weston_layer {
254 struct wl_list surface_list;
258 struct weston_compositor {
260 struct wl_signal destroy_signal;
266 struct weston_shader texture_shader;
267 struct weston_shader solid_shader;
268 struct weston_shader *current_shader;
269 struct wl_display *wl_display;
270 struct weston_shell_interface shell_interface;
272 struct wl_signal activate_signal;
273 struct wl_signal lock_signal;
274 struct wl_signal unlock_signal;
276 struct wl_event_loop *input_loop;
277 struct wl_event_source *input_loop_source;
279 /* There can be more than one, but not right now... */
280 struct weston_seat *seat;
282 struct weston_layer fade_layer;
283 struct weston_layer cursor_layer;
285 struct wl_list output_list;
286 struct wl_list seat_list;
287 struct wl_list layer_list;
288 struct wl_list surface_list;
289 struct wl_list key_binding_list;
290 struct wl_list button_binding_list;
291 struct wl_list axis_binding_list;
292 struct wl_list animation_list;
294 struct weston_spring spring;
295 struct weston_animation animation;
296 struct weston_surface *surface;
300 struct wl_event_source *idle_source;
301 uint32_t idle_inhibit;
302 int option_idle_time; /* default timeout, s */
303 int idle_time; /* effective timeout, s */
306 struct wl_array vertices, indices;
307 pixman_region32_t damage;
311 PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
312 image_target_renderbuffer_storage;
313 PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
314 PFNEGLCREATEIMAGEKHRPROC create_image;
315 PFNEGLDESTROYIMAGEKHRPROC destroy_image;
317 int has_unpack_subimage;
320 PFNEGLBINDWAYLANDDISPLAYWL bind_display;
321 PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
322 int has_bind_display;
324 void (*destroy)(struct weston_compositor *ec);
325 int (*authenticate)(struct weston_compositor *c, uint32_t id);
327 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
331 uint32_t output_id_pool;
333 struct xkb_rule_names xkb_names;
334 struct xkb_context *xkb_context;
335 struct weston_xkb_info xkb_info;
338 enum weston_output_flags {
339 WL_OUTPUT_FLIPPED = 0x01
342 struct weston_region {
343 struct wl_resource resource;
344 pixman_region32_t region;
347 /* Using weston_surface transformations
349 * To add a transformation to a surface, create a struct weston_transform, and
350 * add it to the list surface->geometry.transformation_list. Whenever you
351 * change the list, anything under surface->geometry, or anything in the
352 * weston_transforms linked into the list, you must set
353 * surface->geometry.dirty = 1.
355 * The order in the list defines the order of transformations. Let the list
356 * contain the transformation matrices M1, ..., Mn as head to tail. The
357 * transformation is applied to surface-local coordinate vector p as
358 * P = Mn * ... * M2 * M1 * p
359 * to produce the global coordinate vector P. The total transform
361 * is cached in surface->transform.matrix, and the inverse of it in
362 * surface->transform.inverse.
364 * The list always contains surface->transform.position transformation, which
365 * is the translation by surface->geometry.x and y.
367 * If you want to apply a transformation in local coordinates, add your
368 * weston_transform to the head of the list. If you want to apply a
369 * transformation in global coordinates, add it to the tail of the list.
372 struct weston_surface {
373 struct wl_surface surface;
374 struct weston_compositor *compositor;
376 pixman_region32_t clip;
377 pixman_region32_t damage;
378 pixman_region32_t opaque;
379 pixman_region32_t input;
382 struct wl_list layer_link;
383 struct weston_shader *shader;
385 GLfloat opaque_rect[4];
391 /* Surface geometry state, mutable.
392 * If you change anything, set dirty = 1.
393 * That includes the transformations referenced from the list.
396 GLfloat x, y; /* surface translation on display */
397 int32_t width, height;
399 /* struct weston_transform */
400 struct wl_list transformation_list;
405 /* State derived from geometry state, read-only.
406 * This is updated by weston_surface_update_transform().
409 pixman_region32_t boundingbox;
410 pixman_region32_t opaque;
412 /* matrix and inverse are used only if enabled = 1.
413 * If enabled = 0, use x, y, width, height directly.
416 struct weston_matrix matrix;
417 struct weston_matrix inverse;
419 struct weston_transform position; /* matrix from x, y */
423 * Which output to vsync this surface to.
424 * Used to determine, whether to send or queue frame events.
425 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
427 struct weston_output *output;
430 * A more complete representation of all outputs this surface is
433 uint32_t output_mask;
435 struct wl_list frame_callback_list;
439 struct wl_buffer *buffer;
440 struct wl_listener buffer_destroy_listener;
443 * If non-NULL, this function will be called on surface::attach after
444 * a new buffer has been set up for this surface. The integer params
445 * are the sx and sy paramerters supplied to surface::attach .
447 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
452 weston_surface_update_transform(struct weston_surface *surface);
455 weston_surface_to_global(struct weston_surface *surface,
456 int32_t sx, int32_t sy, int32_t *x, int32_t *y);
458 weston_surface_to_global_fixed(struct weston_surface *surface,
459 wl_fixed_t sx, wl_fixed_t sy,
460 wl_fixed_t *x, wl_fixed_t *y);
462 weston_surface_to_global_float(struct weston_surface *surface,
463 GLfloat sx, GLfloat sy, GLfloat *x, GLfloat *y);
466 weston_surface_from_global(struct weston_surface *surface,
467 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
469 weston_surface_from_global_fixed(struct weston_surface *surface,
470 wl_fixed_t x, wl_fixed_t y,
471 wl_fixed_t *sx, wl_fixed_t *sy);
474 weston_spring_init(struct weston_spring *spring,
475 double k, double current, double target);
477 weston_spring_update(struct weston_spring *spring, uint32_t msec);
479 weston_spring_done(struct weston_spring *spring);
482 weston_surface_activate(struct weston_surface *surface,
483 struct weston_seat *seat);
485 weston_surface_draw(struct weston_surface *es,
486 struct weston_output *output, pixman_region32_t *damage);
489 notify_motion(struct wl_seat *seat, uint32_t time,
490 wl_fixed_t x, wl_fixed_t y);
492 notify_button(struct wl_seat *seat, uint32_t time, int32_t button,
493 enum wl_pointer_button_state state);
495 notify_axis(struct wl_seat *seat, uint32_t time, uint32_t axis,
498 notify_key(struct wl_seat *seat, uint32_t time, uint32_t key,
499 enum wl_keyboard_key_state state);
502 notify_pointer_focus(struct wl_seat *seat, struct weston_output *output,
503 wl_fixed_t x, wl_fixed_t y);
506 notify_keyboard_focus(struct wl_seat *seat, struct wl_array *keys);
509 notify_touch(struct wl_seat *seat, uint32_t time, int touch_id,
510 wl_fixed_t x, wl_fixed_t y, int touch_type);
513 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
516 weston_output_finish_frame(struct weston_output *output, int msecs);
518 weston_output_damage(struct weston_output *output);
520 weston_output_do_read_pixels(struct weston_output *output);
522 weston_compositor_repick(struct weston_compositor *compositor);
524 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
526 weston_compositor_fade(struct weston_compositor *compositor, float tint);
528 weston_compositor_damage_all(struct weston_compositor *compositor);
530 weston_compositor_unlock(struct weston_compositor *compositor);
532 weston_compositor_wake(struct weston_compositor *compositor);
534 weston_compositor_activity(struct weston_compositor *compositor);
536 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
539 struct weston_binding;
540 typedef void (*weston_key_binding_handler_t)(struct wl_seat *seat,
541 uint32_t time, uint32_t key,
543 struct weston_binding *
544 weston_compositor_add_key_binding(struct weston_compositor *compositor,
546 enum weston_keyboard_modifier modifier,
547 weston_key_binding_handler_t binding,
550 typedef void (*weston_button_binding_handler_t)(struct wl_seat *seat,
551 uint32_t time, uint32_t button,
553 struct weston_binding *
554 weston_compositor_add_button_binding(struct weston_compositor *compositor,
556 enum weston_keyboard_modifier modifier,
557 weston_button_binding_handler_t binding,
560 typedef void (*weston_axis_binding_handler_t)(struct wl_seat *seat,
561 uint32_t time, uint32_t axis,
562 wl_fixed_t value, void *data);
563 struct weston_binding *
564 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
566 enum weston_keyboard_modifier modifier,
567 weston_axis_binding_handler_t binding,
570 weston_binding_destroy(struct weston_binding *binding);
573 weston_binding_list_destroy_all(struct wl_list *list);
576 weston_compositor_run_key_binding(struct weston_compositor *compositor,
577 struct weston_seat *seat, uint32_t time,
579 enum wl_keyboard_key_state state);
581 weston_compositor_run_button_binding(struct weston_compositor *compositor,
582 struct weston_seat *seat, uint32_t time,
584 enum wl_pointer_button_state value);
586 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
587 struct weston_seat *seat, uint32_t time,
588 uint32_t axis, int32_t value);
591 weston_environment_get_fd(const char *env);
594 weston_compositor_top(struct weston_compositor *compositor);
596 struct weston_surface *
597 weston_surface_create(struct weston_compositor *compositor);
600 weston_surface_configure(struct weston_surface *surface,
601 GLfloat x, GLfloat y, int width, int height);
604 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
607 weston_surface_set_position(struct weston_surface *surface,
608 GLfloat x, GLfloat y);
611 weston_surface_is_mapped(struct weston_surface *surface);
614 weston_surface_assign_output(struct weston_surface *surface);
617 weston_surface_damage(struct weston_surface *surface);
620 weston_surface_damage_below(struct weston_surface *surface);
623 weston_buffer_post_release(struct wl_buffer *buffer);
626 weston_compositor_get_time(void);
629 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display,
630 int argc, char *argv[], const char *config_file);
632 weston_compositor_shutdown(struct weston_compositor *ec);
634 weston_text_cursor_position_notify(struct weston_surface *surface,
635 wl_fixed_t x, wl_fixed_t y);
637 weston_output_update_zoom(struct weston_output *output,
638 wl_fixed_t x, wl_fixed_t y,
641 weston_output_update_matrix(struct weston_output *output);
643 weston_output_move(struct weston_output *output, int x, int y);
645 weston_output_init(struct weston_output *output, struct weston_compositor *c,
646 int x, int y, int width, int height, uint32_t flags);
648 weston_output_destroy(struct weston_output *output);
651 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
653 weston_seat_init_pointer(struct weston_seat *seat);
655 weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
657 weston_seat_init_touch(struct weston_seat *seat);
660 weston_seat_release(struct weston_seat *seat);
667 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
670 tty_create(struct weston_compositor *compositor,
671 tty_vt_func_t vt_func, int tty_nr);
674 tty_destroy(struct tty *tty);
677 tty_activate_vt(struct tty *tty, int vt);
680 screenshooter_create(struct weston_compositor *ec);
683 clipboard_create(struct weston_seat *seat);
686 text_cursor_position_notifier_create(struct weston_compositor *ec);
688 struct weston_process;
689 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
692 struct weston_process {
694 weston_process_cleanup_func_t cleanup;
699 weston_client_launch(struct weston_compositor *compositor,
700 struct weston_process *proc,
702 weston_process_cleanup_func_t cleanup);
705 weston_watch_process(struct weston_process *process);
708 weston_xserver_init(struct weston_compositor *compositor);
711 typedef void (*weston_zoom_done_func_t)(struct weston_zoom *zoom, void *data);
714 weston_zoom_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
715 weston_zoom_done_func_t done, void *data);
718 typedef void (*weston_fade_done_func_t)(struct weston_fade *fade, void *data);
721 weston_fade_run(struct weston_surface *surface,
722 weston_fade_done_func_t done, void *data);
726 weston_surface_set_color(struct weston_surface *surface,
727 GLfloat red, GLfloat green, GLfloat blue, GLfloat alpha);
730 weston_surface_destroy(struct weston_surface *surface);
732 struct weston_compositor *
733 backend_init(struct wl_display *display, int argc, char *argv[],
734 const char *config_file);
737 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);