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_fixed_point {
122 struct weston_output_zoom {
128 float trans_x, trans_y;
129 struct weston_animation animation_z;
130 struct weston_spring spring_z;
131 struct weston_animation animation_xy;
132 struct weston_spring spring_xy;
133 struct weston_fixed_point from;
134 struct weston_fixed_point to;
135 struct weston_fixed_point current;
136 struct weston_fixed_point text_cursor;
139 /* bit compatible with drm definitions. */
147 struct weston_read_pixels {
149 int x, y, width, height;
150 void (*done)(struct weston_read_pixels *read_pixels,
151 struct weston_output *output);
155 struct weston_output {
159 struct wl_list resource_list;
160 struct wl_global *global;
161 struct weston_compositor *compositor;
162 struct weston_matrix matrix;
163 struct wl_list animation_list;
164 int32_t x, y, mm_width, mm_height;
165 struct weston_border border;
166 pixman_region32_t region;
167 pixman_region32_t previous_damage;
170 int repaint_scheduled;
171 struct weston_output_zoom zoom;
173 struct wl_list read_pixels_list;
174 struct wl_signal frame_signal;
179 struct weston_mode *current;
180 struct weston_mode *origin;
181 struct wl_list mode_list;
183 void (*repaint)(struct weston_output *output,
184 pixman_region32_t *damage);
185 void (*destroy)(struct weston_output *output);
186 void (*assign_planes)(struct weston_output *output);
187 int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
189 /* backlight values are on 0-255 range, where higher is brighter */
190 uint32_t backlight_current;
191 void (*set_backlight)(struct weston_output *output, uint32_t value);
192 void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
195 struct weston_xkb_info {
196 struct xkb_keymap *keymap;
200 xkb_mod_index_t ctrl_mod;
201 xkb_mod_index_t alt_mod;
202 xkb_mod_index_t super_mod;
203 xkb_led_index_t num_led;
204 xkb_led_index_t caps_led;
205 xkb_led_index_t scroll_led;
210 struct wl_pointer pointer;
212 struct wl_keyboard keyboard;
214 struct wl_touch touch;
217 struct weston_compositor *compositor;
218 struct weston_surface *sprite;
219 struct wl_listener sprite_destroy_listener;
220 struct weston_surface *drag_surface;
221 struct wl_listener drag_surface_destroy_listener;
222 int32_t hotspot_x, hotspot_y;
224 enum weston_keyboard_modifier modifier_state;
226 struct wl_surface *saved_kbd_focus;
227 struct wl_listener saved_kbd_focus_listener;
230 struct wl_surface *touch_focus;
231 struct wl_listener touch_focus_listener;
232 struct wl_resource *touch_focus_resource;
233 struct wl_listener touch_focus_resource_listener;
235 struct wl_listener new_drag_icon_listener;
237 void (*led_update)(struct weston_seat *ws, enum weston_led leds);
239 struct weston_xkb_info xkb_info;
241 struct xkb_state *state;
242 uint32_t mods_depressed;
243 uint32_t mods_latched;
244 uint32_t mods_locked;
246 enum weston_led leds;
250 struct weston_shader {
252 GLuint vertex_shader, fragment_shader;
257 GLint texwidth_uniform;
258 GLint opaque_uniform;
262 WESTON_COMPOSITOR_ACTIVE,
263 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
264 WESTON_COMPOSITOR_SLEEPING /* no rendering, no frame events */
267 struct weston_layer {
268 struct wl_list surface_list;
272 struct weston_compositor {
274 struct wl_signal destroy_signal;
280 struct weston_shader texture_shader;
281 struct weston_shader solid_shader;
282 struct weston_shader *current_shader;
283 struct wl_display *wl_display;
284 struct weston_shell_interface shell_interface;
286 struct wl_signal activate_signal;
287 struct wl_signal lock_signal;
288 struct wl_signal unlock_signal;
290 struct wl_event_loop *input_loop;
291 struct wl_event_source *input_loop_source;
293 /* There can be more than one, but not right now... */
294 struct weston_seat *seat;
296 struct weston_layer fade_layer;
297 struct weston_layer cursor_layer;
299 struct wl_list output_list;
300 struct wl_list seat_list;
301 struct wl_list layer_list;
302 struct wl_list surface_list;
303 struct wl_list key_binding_list;
304 struct wl_list button_binding_list;
305 struct wl_list axis_binding_list;
307 struct weston_spring spring;
308 struct weston_animation animation;
309 struct weston_surface *surface;
313 struct wl_event_source *idle_source;
314 uint32_t idle_inhibit;
315 int option_idle_time; /* default timeout, s */
316 int idle_time; /* effective timeout, s */
319 struct wl_array vertices, indices;
320 pixman_region32_t damage;
324 PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
325 image_target_renderbuffer_storage;
326 PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
327 PFNEGLCREATEIMAGEKHRPROC create_image;
328 PFNEGLDESTROYIMAGEKHRPROC destroy_image;
330 int has_unpack_subimage;
333 PFNEGLBINDWAYLANDDISPLAYWL bind_display;
334 PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
335 int has_bind_display;
337 void (*destroy)(struct weston_compositor *ec);
338 int (*authenticate)(struct weston_compositor *c, uint32_t id);
340 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
344 uint32_t output_id_pool;
346 struct xkb_rule_names xkb_names;
347 struct xkb_context *xkb_context;
348 struct weston_xkb_info xkb_info;
351 enum weston_output_flags {
352 WL_OUTPUT_FLIPPED = 0x01
355 struct weston_region {
356 struct wl_resource resource;
357 pixman_region32_t region;
360 /* Using weston_surface transformations
362 * To add a transformation to a surface, create a struct weston_transform, and
363 * add it to the list surface->geometry.transformation_list. Whenever you
364 * change the list, anything under surface->geometry, or anything in the
365 * weston_transforms linked into the list, you must set
366 * surface->geometry.dirty = 1.
368 * The order in the list defines the order of transformations. Let the list
369 * contain the transformation matrices M1, ..., Mn as head to tail. The
370 * transformation is applied to surface-local coordinate vector p as
371 * P = Mn * ... * M2 * M1 * p
372 * to produce the global coordinate vector P. The total transform
374 * is cached in surface->transform.matrix, and the inverse of it in
375 * surface->transform.inverse.
377 * The list always contains surface->transform.position transformation, which
378 * is the translation by surface->geometry.x and y.
380 * If you want to apply a transformation in local coordinates, add your
381 * weston_transform to the head of the list. If you want to apply a
382 * transformation in global coordinates, add it to the tail of the list.
385 struct weston_surface {
386 struct wl_surface surface;
387 struct weston_compositor *compositor;
389 pixman_region32_t clip;
390 pixman_region32_t damage;
391 pixman_region32_t opaque;
392 pixman_region32_t input;
395 struct wl_list layer_link;
396 struct weston_shader *shader;
398 GLfloat opaque_rect[4];
402 /* Surface geometry state, mutable.
403 * If you change anything, set dirty = 1.
404 * That includes the transformations referenced from the list.
407 GLfloat x, y; /* surface translation on display */
408 int32_t width, height;
410 /* struct weston_transform */
411 struct wl_list transformation_list;
416 /* State derived from geometry state, read-only.
417 * This is updated by weston_surface_update_transform().
420 pixman_region32_t boundingbox;
421 pixman_region32_t opaque;
423 /* matrix and inverse are used only if enabled = 1.
424 * If enabled = 0, use x, y, width, height directly.
427 struct weston_matrix matrix;
428 struct weston_matrix inverse;
430 struct weston_transform position; /* matrix from x, y */
434 * Which output to vsync this surface to.
435 * Used to determine, whether to send or queue frame events.
436 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
438 struct weston_output *output;
441 * A more complete representation of all outputs this surface is
444 uint32_t output_mask;
446 struct wl_list frame_callback_list;
450 struct wl_buffer *buffer;
451 struct wl_listener buffer_destroy_listener;
454 * If non-NULL, this function will be called on surface::attach after
455 * a new buffer has been set up for this surface. The integer params
456 * are the sx and sy paramerters supplied to surface::attach .
458 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
463 weston_surface_update_transform(struct weston_surface *surface);
466 weston_surface_to_global_fixed(struct weston_surface *surface,
467 wl_fixed_t sx, wl_fixed_t sy,
468 wl_fixed_t *x, wl_fixed_t *y);
470 weston_surface_to_global_float(struct weston_surface *surface,
471 GLfloat sx, GLfloat sy, GLfloat *x, GLfloat *y);
474 weston_surface_from_global(struct weston_surface *surface,
475 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
477 weston_surface_from_global_fixed(struct weston_surface *surface,
478 wl_fixed_t x, wl_fixed_t y,
479 wl_fixed_t *sx, wl_fixed_t *sy);
482 weston_spring_init(struct weston_spring *spring,
483 double k, double current, double target);
485 weston_spring_update(struct weston_spring *spring, uint32_t msec);
487 weston_spring_done(struct weston_spring *spring);
490 weston_surface_activate(struct weston_surface *surface,
491 struct weston_seat *seat);
493 weston_surface_draw(struct weston_surface *es,
494 struct weston_output *output, pixman_region32_t *damage);
497 notify_motion(struct wl_seat *seat, uint32_t time,
498 wl_fixed_t x, wl_fixed_t y);
500 notify_button(struct wl_seat *seat, uint32_t time, int32_t button,
501 enum wl_pointer_button_state state);
503 notify_axis(struct wl_seat *seat, uint32_t time, uint32_t axis,
506 notify_key(struct wl_seat *seat, uint32_t time, uint32_t key,
507 enum wl_keyboard_key_state state);
510 notify_pointer_focus(struct wl_seat *seat, struct weston_output *output,
511 wl_fixed_t x, wl_fixed_t y);
514 notify_keyboard_focus(struct wl_seat *seat, struct wl_array *keys);
517 notify_touch(struct wl_seat *seat, uint32_t time, int touch_id,
518 wl_fixed_t x, wl_fixed_t y, int touch_type);
521 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
524 weston_output_finish_frame(struct weston_output *output, int msecs);
526 weston_output_damage(struct weston_output *output);
528 weston_output_do_read_pixels(struct weston_output *output);
530 weston_compositor_repick(struct weston_compositor *compositor);
532 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
534 weston_compositor_fade(struct weston_compositor *compositor, float tint);
536 weston_compositor_damage_all(struct weston_compositor *compositor);
538 weston_compositor_unlock(struct weston_compositor *compositor);
540 weston_compositor_wake(struct weston_compositor *compositor);
542 weston_compositor_activity(struct weston_compositor *compositor);
544 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
547 struct weston_binding;
548 typedef void (*weston_key_binding_handler_t)(struct wl_seat *seat,
549 uint32_t time, uint32_t key,
551 struct weston_binding *
552 weston_compositor_add_key_binding(struct weston_compositor *compositor,
554 enum weston_keyboard_modifier modifier,
555 weston_key_binding_handler_t binding,
558 typedef void (*weston_button_binding_handler_t)(struct wl_seat *seat,
559 uint32_t time, uint32_t button,
561 struct weston_binding *
562 weston_compositor_add_button_binding(struct weston_compositor *compositor,
564 enum weston_keyboard_modifier modifier,
565 weston_button_binding_handler_t binding,
568 typedef void (*weston_axis_binding_handler_t)(struct wl_seat *seat,
569 uint32_t time, uint32_t axis,
570 wl_fixed_t value, void *data);
571 struct weston_binding *
572 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
574 enum weston_keyboard_modifier modifier,
575 weston_axis_binding_handler_t binding,
578 weston_binding_destroy(struct weston_binding *binding);
581 weston_binding_list_destroy_all(struct wl_list *list);
584 weston_compositor_run_key_binding(struct weston_compositor *compositor,
585 struct weston_seat *seat, uint32_t time,
587 enum wl_keyboard_key_state state);
589 weston_compositor_run_button_binding(struct weston_compositor *compositor,
590 struct weston_seat *seat, uint32_t time,
592 enum wl_pointer_button_state value);
594 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
595 struct weston_seat *seat, uint32_t time,
596 uint32_t axis, int32_t value);
599 weston_environment_get_fd(const char *env);
602 weston_compositor_top(struct weston_compositor *compositor);
604 struct weston_surface *
605 weston_surface_create(struct weston_compositor *compositor);
608 weston_surface_configure(struct weston_surface *surface,
609 GLfloat x, GLfloat y, int width, int height);
612 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
615 weston_surface_set_position(struct weston_surface *surface,
616 GLfloat x, GLfloat y);
619 weston_surface_is_mapped(struct weston_surface *surface);
622 weston_surface_assign_output(struct weston_surface *surface);
625 weston_surface_damage(struct weston_surface *surface);
628 weston_surface_damage_below(struct weston_surface *surface);
631 weston_buffer_post_release(struct wl_buffer *buffer);
634 weston_compositor_get_time(void);
637 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display,
638 int argc, char *argv[], const char *config_file);
640 weston_compositor_shutdown(struct weston_compositor *ec);
642 weston_text_cursor_position_notify(struct weston_surface *surface,
643 wl_fixed_t x, wl_fixed_t y);
645 weston_output_update_zoom(struct weston_output *output, uint32_t type);
647 weston_output_update_matrix(struct weston_output *output);
649 weston_output_move(struct weston_output *output, int x, int y);
651 weston_output_init(struct weston_output *output, struct weston_compositor *c,
652 int x, int y, int width, int height, uint32_t flags);
654 weston_output_destroy(struct weston_output *output);
657 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
659 weston_seat_init_pointer(struct weston_seat *seat);
661 weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
663 weston_seat_init_touch(struct weston_seat *seat);
666 weston_seat_release(struct weston_seat *seat);
673 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
676 tty_create(struct weston_compositor *compositor,
677 tty_vt_func_t vt_func, int tty_nr);
680 tty_destroy(struct tty *tty);
683 tty_activate_vt(struct tty *tty, int vt);
686 screenshooter_create(struct weston_compositor *ec);
689 clipboard_create(struct weston_seat *seat);
692 text_cursor_position_notifier_create(struct weston_compositor *ec);
694 struct weston_process;
695 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
698 struct weston_process {
700 weston_process_cleanup_func_t cleanup;
705 weston_client_launch(struct weston_compositor *compositor,
706 struct weston_process *proc,
708 weston_process_cleanup_func_t cleanup);
711 weston_watch_process(struct weston_process *process);
714 weston_xserver_init(struct weston_compositor *compositor);
717 typedef void (*weston_zoom_done_func_t)(struct weston_zoom *zoom, void *data);
720 weston_zoom_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
721 weston_zoom_done_func_t done, void *data);
724 typedef void (*weston_fade_done_func_t)(struct weston_fade *fade, void *data);
727 weston_fade_run(struct weston_surface *surface,
728 weston_fade_done_func_t done, void *data);
732 weston_surface_set_color(struct weston_surface *surface,
733 GLfloat red, GLfloat green, GLfloat blue, GLfloat alpha);
736 weston_surface_destroy(struct weston_surface *surface);
738 struct weston_compositor *
739 backend_init(struct wl_display *display, int argc, char *argv[],
740 const char *config_file);
743 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);