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);
167 struct wl_pointer pointer;
168 struct wl_keyboard keyboard;
169 struct wl_touch touch;
170 struct weston_compositor *compositor;
171 struct weston_surface *sprite;
172 struct weston_surface *drag_surface;
173 struct wl_listener drag_surface_destroy_listener;
174 int32_t hotspot_x, hotspot_y;
176 enum weston_keyboard_modifier modifier_state;
178 struct wl_surface *saved_kbd_focus;
179 struct wl_listener saved_kbd_focus_listener;
182 struct wl_surface *touch_focus;
183 struct wl_listener touch_focus_listener;
184 struct wl_resource *touch_focus_resource;
185 struct wl_listener touch_focus_resource_listener;
187 struct wl_listener new_drag_icon_listener;
189 void (*led_update)(struct weston_seat *ws, enum weston_led leds);
192 struct xkb_state *state;
193 uint32_t mods_depressed;
194 uint32_t mods_latched;
195 uint32_t mods_locked;
197 enum weston_led leds;
201 struct weston_shader {
203 GLuint vertex_shader, fragment_shader;
207 GLint brightness_uniform;
208 GLint saturation_uniform;
210 GLint texwidth_uniform;
211 GLint opaque_uniform;
214 struct weston_animation {
215 void (*frame)(struct weston_animation *animation,
216 struct weston_output *output, uint32_t msecs);
220 struct weston_spring {
230 WESTON_COMPOSITOR_ACTIVE,
231 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
232 WESTON_COMPOSITOR_SLEEPING /* no rendering, no frame events */
235 struct weston_layer {
236 struct wl_list surface_list;
240 struct weston_compositor {
242 struct wl_signal destroy_signal;
248 struct weston_shader texture_shader;
249 struct weston_shader solid_shader;
250 struct weston_shader *current_shader;
251 struct wl_display *wl_display;
252 struct weston_shell_interface shell_interface;
254 struct wl_signal activate_signal;
255 struct wl_signal lock_signal;
256 struct wl_signal unlock_signal;
258 struct wl_event_loop *input_loop;
259 struct wl_event_source *input_loop_source;
261 /* There can be more than one, but not right now... */
262 struct weston_seat *seat;
264 struct weston_layer fade_layer;
265 struct weston_layer cursor_layer;
267 struct wl_list output_list;
268 struct wl_list seat_list;
269 struct wl_list layer_list;
270 struct wl_list surface_list;
271 struct wl_list key_binding_list;
272 struct wl_list button_binding_list;
273 struct wl_list axis_binding_list;
274 struct wl_list animation_list;
276 struct weston_spring spring;
277 struct weston_animation animation;
278 struct weston_surface *surface;
282 struct wl_event_source *idle_source;
283 uint32_t idle_inhibit;
284 int option_idle_time; /* default timeout, s */
285 int idle_time; /* effective timeout, s */
288 struct wl_array vertices, indices;
289 pixman_region32_t damage;
293 PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
294 image_target_renderbuffer_storage;
295 PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
296 PFNEGLCREATEIMAGEKHRPROC create_image;
297 PFNEGLDESTROYIMAGEKHRPROC destroy_image;
299 int has_unpack_subimage;
302 PFNEGLBINDWAYLANDDISPLAYWL bind_display;
303 PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
304 int has_bind_display;
306 void (*destroy)(struct weston_compositor *ec);
307 int (*authenticate)(struct weston_compositor *c, uint32_t id);
309 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
313 uint32_t output_id_pool;
316 struct xkb_rule_names names;
317 struct xkb_context *context;
318 struct xkb_keymap *keymap;
319 xkb_mod_index_t ctrl_mod;
320 xkb_mod_index_t alt_mod;
321 xkb_mod_index_t super_mod;
322 xkb_led_index_t num_led;
323 xkb_led_index_t caps_led;
324 xkb_led_index_t scroll_led;
328 enum weston_output_flags {
329 WL_OUTPUT_FLIPPED = 0x01
332 struct weston_region {
333 struct wl_resource resource;
334 pixman_region32_t region;
337 /* Using weston_surface transformations
339 * To add a transformation to a surface, create a struct weston_transform, and
340 * add it to the list surface->geometry.transformation_list. Whenever you
341 * change the list, anything under surface->geometry, or anything in the
342 * weston_transforms linked into the list, you must set
343 * surface->geometry.dirty = 1.
345 * The order in the list defines the order of transformations. Let the list
346 * contain the transformation matrices M1, ..., Mn as head to tail. The
347 * transformation is applied to surface-local coordinate vector p as
348 * P = Mn * ... * M2 * M1 * p
349 * to produce the global coordinate vector P. The total transform
351 * is cached in surface->transform.matrix, and the inverse of it in
352 * surface->transform.inverse.
354 * The list always contains surface->transform.position transformation, which
355 * is the translation by surface->geometry.x and y.
357 * If you want to apply a transformation in local coordinates, add your
358 * weston_transform to the head of the list. If you want to apply a
359 * transformation in global coordinates, add it to the tail of the list.
362 struct weston_surface {
363 struct wl_surface surface;
364 struct weston_compositor *compositor;
366 pixman_region32_t clip;
367 pixman_region32_t damage;
368 pixman_region32_t opaque;
369 pixman_region32_t input;
372 struct wl_list layer_link;
373 struct weston_shader *shader;
375 GLfloat opaque_rect[4];
381 /* Surface geometry state, mutable.
382 * If you change anything, set dirty = 1.
383 * That includes the transformations referenced from the list.
386 GLfloat x, y; /* surface translation on display */
387 int32_t width, height;
389 /* struct weston_transform */
390 struct wl_list transformation_list;
395 /* State derived from geometry state, read-only.
396 * This is updated by weston_surface_update_transform().
399 pixman_region32_t boundingbox;
400 pixman_region32_t opaque;
402 /* matrix and inverse are used only if enabled = 1.
403 * If enabled = 0, use x, y, width, height directly.
406 struct weston_matrix matrix;
407 struct weston_matrix inverse;
409 struct weston_transform position; /* matrix from x, y */
413 * Which output to vsync this surface to.
414 * Used to determine, whether to send or queue frame events.
415 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
417 struct weston_output *output;
420 * A more complete representation of all outputs this surface is
423 uint32_t output_mask;
425 struct wl_list frame_callback_list;
429 struct wl_buffer *buffer;
430 struct wl_listener buffer_destroy_listener;
433 * If non-NULL, this function will be called on surface::attach after
434 * a new buffer has been set up for this surface. The integer params
435 * are the sx and sy paramerters supplied to surface::attach .
437 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
442 weston_surface_update_transform(struct weston_surface *surface);
445 weston_surface_to_global(struct weston_surface *surface,
446 int32_t sx, int32_t sy, int32_t *x, int32_t *y);
448 weston_surface_to_global_fixed(struct weston_surface *surface,
449 wl_fixed_t sx, wl_fixed_t sy,
450 wl_fixed_t *x, wl_fixed_t *y);
452 weston_surface_to_global_float(struct weston_surface *surface,
453 GLfloat sx, GLfloat sy, GLfloat *x, GLfloat *y);
456 weston_surface_from_global(struct weston_surface *surface,
457 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
459 weston_surface_from_global_fixed(struct weston_surface *surface,
460 wl_fixed_t x, wl_fixed_t y,
461 wl_fixed_t *sx, wl_fixed_t *sy);
464 weston_spring_init(struct weston_spring *spring,
465 double k, double current, double target);
467 weston_spring_update(struct weston_spring *spring, uint32_t msec);
469 weston_spring_done(struct weston_spring *spring);
472 weston_surface_activate(struct weston_surface *surface,
473 struct weston_seat *seat);
475 weston_surface_draw(struct weston_surface *es,
476 struct weston_output *output, pixman_region32_t *damage);
479 notify_motion(struct wl_seat *seat, uint32_t time,
480 wl_fixed_t x, wl_fixed_t y);
482 notify_button(struct wl_seat *seat, uint32_t time, int32_t button,
483 enum wl_pointer_button_state state);
485 notify_axis(struct wl_seat *seat, uint32_t time, uint32_t axis,
488 notify_key(struct wl_seat *seat, uint32_t time, uint32_t key,
489 enum wl_keyboard_key_state state);
492 notify_pointer_focus(struct wl_seat *seat, struct weston_output *output,
493 wl_fixed_t x, wl_fixed_t y);
496 notify_keyboard_focus(struct wl_seat *seat, struct wl_array *keys);
499 notify_touch(struct wl_seat *seat, uint32_t time, int touch_id,
500 wl_fixed_t x, wl_fixed_t y, int touch_type);
503 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
506 weston_output_finish_frame(struct weston_output *output, int msecs);
508 weston_output_damage(struct weston_output *output);
510 weston_output_do_read_pixels(struct weston_output *output);
512 weston_compositor_repick(struct weston_compositor *compositor);
514 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
516 weston_compositor_fade(struct weston_compositor *compositor, float tint);
518 weston_compositor_damage_all(struct weston_compositor *compositor);
520 weston_compositor_unlock(struct weston_compositor *compositor);
522 weston_compositor_wake(struct weston_compositor *compositor);
524 weston_compositor_activity(struct weston_compositor *compositor);
526 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
529 struct weston_binding;
530 typedef void (*weston_key_binding_handler_t)(struct wl_seat *seat,
531 uint32_t time, uint32_t key,
533 struct weston_binding *
534 weston_compositor_add_key_binding(struct weston_compositor *compositor,
536 enum weston_keyboard_modifier modifier,
537 weston_key_binding_handler_t binding,
540 typedef void (*weston_button_binding_handler_t)(struct wl_seat *seat,
541 uint32_t time, uint32_t button,
543 struct weston_binding *
544 weston_compositor_add_button_binding(struct weston_compositor *compositor,
546 enum weston_keyboard_modifier modifier,
547 weston_button_binding_handler_t binding,
550 typedef void (*weston_axis_binding_handler_t)(struct wl_seat *seat,
551 uint32_t time, uint32_t axis,
552 wl_fixed_t value, void *data);
553 struct weston_binding *
554 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
556 enum weston_keyboard_modifier modifier,
557 weston_axis_binding_handler_t binding,
560 weston_binding_destroy(struct weston_binding *binding);
563 weston_binding_list_destroy_all(struct wl_list *list);
566 weston_compositor_run_key_binding(struct weston_compositor *compositor,
567 struct weston_seat *seat, uint32_t time,
569 enum wl_keyboard_key_state state);
571 weston_compositor_run_button_binding(struct weston_compositor *compositor,
572 struct weston_seat *seat, uint32_t time,
574 enum wl_pointer_button_state value);
576 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
577 struct weston_seat *seat, uint32_t time,
578 uint32_t axis, int32_t value);
581 weston_environment_get_fd(const char *env);
584 weston_compositor_top(struct weston_compositor *compositor);
586 struct weston_surface *
587 weston_surface_create(struct weston_compositor *compositor);
590 weston_surface_configure(struct weston_surface *surface,
591 GLfloat x, GLfloat y, int width, int height);
594 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
597 weston_surface_set_position(struct weston_surface *surface,
598 GLfloat x, GLfloat y);
601 weston_surface_is_mapped(struct weston_surface *surface);
604 weston_surface_assign_output(struct weston_surface *surface);
607 weston_surface_damage(struct weston_surface *surface);
610 weston_surface_damage_below(struct weston_surface *surface);
613 weston_buffer_post_release(struct wl_buffer *buffer);
616 weston_compositor_get_time(void);
619 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display);
621 weston_compositor_shutdown(struct weston_compositor *ec);
623 weston_output_update_zoom(struct weston_output *output,
624 int x, int y, uint32_t type);
626 weston_text_cursor_position_notify(struct weston_surface *surface, int x, int y);
628 weston_output_update_matrix(struct weston_output *output);
630 weston_output_move(struct weston_output *output, int x, int y);
632 weston_output_init(struct weston_output *output, struct weston_compositor *c,
633 int x, int y, int width, int height, uint32_t flags);
635 weston_output_destroy(struct weston_output *output);
638 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
641 weston_seat_release(struct weston_seat *seat);
648 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
651 tty_create(struct weston_compositor *compositor,
652 tty_vt_func_t vt_func, int tty_nr);
655 tty_destroy(struct tty *tty);
658 tty_activate_vt(struct tty *tty, int vt);
661 screenshooter_create(struct weston_compositor *ec);
664 text_cursor_position_notifier_create(struct weston_compositor *ec);
666 struct weston_process;
667 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
670 struct weston_process {
672 weston_process_cleanup_func_t cleanup;
677 weston_client_launch(struct weston_compositor *compositor,
678 struct weston_process *proc,
680 weston_process_cleanup_func_t cleanup);
683 weston_watch_process(struct weston_process *process);
686 weston_xserver_init(struct weston_compositor *compositor);
689 typedef void (*weston_zoom_done_func_t)(struct weston_zoom *zoom, void *data);
692 weston_zoom_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
693 weston_zoom_done_func_t done, void *data);
696 typedef void (*weston_fade_done_func_t)(struct weston_fade *fade, void *data);
699 weston_fade_run(struct weston_surface *surface,
700 weston_fade_done_func_t done, void *data);
704 weston_surface_set_color(struct weston_surface *surface,
705 GLfloat red, GLfloat green, GLfloat blue, GLfloat alpha);
708 weston_surface_destroy(struct weston_surface *surface);
710 struct weston_compositor *
711 backend_init(struct wl_display *display, int argc, char *argv[]);
714 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);