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;
167 xkb_mod_index_t ctrl_mod;
168 xkb_mod_index_t alt_mod;
169 xkb_mod_index_t super_mod;
170 xkb_led_index_t num_led;
171 xkb_led_index_t caps_led;
172 xkb_led_index_t scroll_led;
177 struct wl_pointer pointer;
179 struct wl_keyboard keyboard;
181 struct wl_touch touch;
184 struct weston_compositor *compositor;
185 struct weston_surface *sprite;
186 struct weston_surface *drag_surface;
187 struct wl_listener drag_surface_destroy_listener;
188 int32_t hotspot_x, hotspot_y;
190 enum weston_keyboard_modifier modifier_state;
192 struct wl_surface *saved_kbd_focus;
193 struct wl_listener saved_kbd_focus_listener;
196 struct wl_surface *touch_focus;
197 struct wl_listener touch_focus_listener;
198 struct wl_resource *touch_focus_resource;
199 struct wl_listener touch_focus_resource_listener;
201 struct wl_listener new_drag_icon_listener;
203 void (*led_update)(struct weston_seat *ws, enum weston_led leds);
205 struct weston_xkb_info xkb_info;
207 struct xkb_state *state;
208 uint32_t mods_depressed;
209 uint32_t mods_latched;
210 uint32_t mods_locked;
212 enum weston_led leds;
216 struct weston_shader {
218 GLuint vertex_shader, fragment_shader;
222 GLint brightness_uniform;
223 GLint saturation_uniform;
225 GLint texwidth_uniform;
226 GLint opaque_uniform;
229 struct weston_animation {
230 void (*frame)(struct weston_animation *animation,
231 struct weston_output *output, uint32_t msecs);
235 struct weston_spring {
245 WESTON_COMPOSITOR_ACTIVE,
246 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
247 WESTON_COMPOSITOR_SLEEPING /* no rendering, no frame events */
250 struct weston_layer {
251 struct wl_list surface_list;
255 struct weston_compositor {
257 struct wl_signal destroy_signal;
263 struct weston_shader texture_shader;
264 struct weston_shader solid_shader;
265 struct weston_shader *current_shader;
266 struct wl_display *wl_display;
267 struct weston_shell_interface shell_interface;
269 struct wl_signal activate_signal;
270 struct wl_signal lock_signal;
271 struct wl_signal unlock_signal;
273 struct wl_event_loop *input_loop;
274 struct wl_event_source *input_loop_source;
276 /* There can be more than one, but not right now... */
277 struct weston_seat *seat;
279 struct weston_layer fade_layer;
280 struct weston_layer cursor_layer;
282 struct wl_list output_list;
283 struct wl_list seat_list;
284 struct wl_list layer_list;
285 struct wl_list surface_list;
286 struct wl_list key_binding_list;
287 struct wl_list button_binding_list;
288 struct wl_list axis_binding_list;
289 struct wl_list animation_list;
291 struct weston_spring spring;
292 struct weston_animation animation;
293 struct weston_surface *surface;
297 struct wl_event_source *idle_source;
298 uint32_t idle_inhibit;
299 int option_idle_time; /* default timeout, s */
300 int idle_time; /* effective timeout, s */
303 struct wl_array vertices, indices;
304 pixman_region32_t damage;
308 PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
309 image_target_renderbuffer_storage;
310 PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
311 PFNEGLCREATEIMAGEKHRPROC create_image;
312 PFNEGLDESTROYIMAGEKHRPROC destroy_image;
314 int has_unpack_subimage;
317 PFNEGLBINDWAYLANDDISPLAYWL bind_display;
318 PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
319 int has_bind_display;
321 void (*destroy)(struct weston_compositor *ec);
322 int (*authenticate)(struct weston_compositor *c, uint32_t id);
324 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
328 uint32_t output_id_pool;
330 struct xkb_rule_names xkb_names;
331 struct xkb_context *xkb_context;
332 struct weston_xkb_info xkb_info;
335 enum weston_output_flags {
336 WL_OUTPUT_FLIPPED = 0x01
339 struct weston_region {
340 struct wl_resource resource;
341 pixman_region32_t region;
344 /* Using weston_surface transformations
346 * To add a transformation to a surface, create a struct weston_transform, and
347 * add it to the list surface->geometry.transformation_list. Whenever you
348 * change the list, anything under surface->geometry, or anything in the
349 * weston_transforms linked into the list, you must set
350 * surface->geometry.dirty = 1.
352 * The order in the list defines the order of transformations. Let the list
353 * contain the transformation matrices M1, ..., Mn as head to tail. The
354 * transformation is applied to surface-local coordinate vector p as
355 * P = Mn * ... * M2 * M1 * p
356 * to produce the global coordinate vector P. The total transform
358 * is cached in surface->transform.matrix, and the inverse of it in
359 * surface->transform.inverse.
361 * The list always contains surface->transform.position transformation, which
362 * is the translation by surface->geometry.x and y.
364 * If you want to apply a transformation in local coordinates, add your
365 * weston_transform to the head of the list. If you want to apply a
366 * transformation in global coordinates, add it to the tail of the list.
369 struct weston_surface {
370 struct wl_surface surface;
371 struct weston_compositor *compositor;
373 pixman_region32_t clip;
374 pixman_region32_t damage;
375 pixman_region32_t opaque;
376 pixman_region32_t input;
379 struct wl_list layer_link;
380 struct weston_shader *shader;
382 GLfloat opaque_rect[4];
388 /* Surface geometry state, mutable.
389 * If you change anything, set dirty = 1.
390 * That includes the transformations referenced from the list.
393 GLfloat x, y; /* surface translation on display */
394 int32_t width, height;
396 /* struct weston_transform */
397 struct wl_list transformation_list;
402 /* State derived from geometry state, read-only.
403 * This is updated by weston_surface_update_transform().
406 pixman_region32_t boundingbox;
407 pixman_region32_t opaque;
409 /* matrix and inverse are used only if enabled = 1.
410 * If enabled = 0, use x, y, width, height directly.
413 struct weston_matrix matrix;
414 struct weston_matrix inverse;
416 struct weston_transform position; /* matrix from x, y */
420 * Which output to vsync this surface to.
421 * Used to determine, whether to send or queue frame events.
422 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
424 struct weston_output *output;
427 * A more complete representation of all outputs this surface is
430 uint32_t output_mask;
432 struct wl_list frame_callback_list;
436 struct wl_buffer *buffer;
437 struct wl_listener buffer_destroy_listener;
440 * If non-NULL, this function will be called on surface::attach after
441 * a new buffer has been set up for this surface. The integer params
442 * are the sx and sy paramerters supplied to surface::attach .
444 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
449 weston_surface_update_transform(struct weston_surface *surface);
452 weston_surface_to_global(struct weston_surface *surface,
453 int32_t sx, int32_t sy, int32_t *x, int32_t *y);
455 weston_surface_to_global_fixed(struct weston_surface *surface,
456 wl_fixed_t sx, wl_fixed_t sy,
457 wl_fixed_t *x, wl_fixed_t *y);
459 weston_surface_to_global_float(struct weston_surface *surface,
460 GLfloat sx, GLfloat sy, GLfloat *x, GLfloat *y);
463 weston_surface_from_global(struct weston_surface *surface,
464 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
466 weston_surface_from_global_fixed(struct weston_surface *surface,
467 wl_fixed_t x, wl_fixed_t y,
468 wl_fixed_t *sx, wl_fixed_t *sy);
471 weston_spring_init(struct weston_spring *spring,
472 double k, double current, double target);
474 weston_spring_update(struct weston_spring *spring, uint32_t msec);
476 weston_spring_done(struct weston_spring *spring);
479 weston_surface_activate(struct weston_surface *surface,
480 struct weston_seat *seat);
482 weston_surface_draw(struct weston_surface *es,
483 struct weston_output *output, pixman_region32_t *damage);
486 notify_motion(struct wl_seat *seat, uint32_t time,
487 wl_fixed_t x, wl_fixed_t y);
489 notify_button(struct wl_seat *seat, uint32_t time, int32_t button,
490 enum wl_pointer_button_state state);
492 notify_axis(struct wl_seat *seat, uint32_t time, uint32_t axis,
495 notify_key(struct wl_seat *seat, uint32_t time, uint32_t key,
496 enum wl_keyboard_key_state state);
499 notify_pointer_focus(struct wl_seat *seat, struct weston_output *output,
500 wl_fixed_t x, wl_fixed_t y);
503 notify_keyboard_focus(struct wl_seat *seat, struct wl_array *keys);
506 notify_touch(struct wl_seat *seat, uint32_t time, int touch_id,
507 wl_fixed_t x, wl_fixed_t y, int touch_type);
510 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
513 weston_output_finish_frame(struct weston_output *output, int msecs);
515 weston_output_damage(struct weston_output *output);
517 weston_output_do_read_pixels(struct weston_output *output);
519 weston_compositor_repick(struct weston_compositor *compositor);
521 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
523 weston_compositor_fade(struct weston_compositor *compositor, float tint);
525 weston_compositor_damage_all(struct weston_compositor *compositor);
527 weston_compositor_unlock(struct weston_compositor *compositor);
529 weston_compositor_wake(struct weston_compositor *compositor);
531 weston_compositor_activity(struct weston_compositor *compositor);
533 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
536 struct weston_binding;
537 typedef void (*weston_key_binding_handler_t)(struct wl_seat *seat,
538 uint32_t time, uint32_t key,
540 struct weston_binding *
541 weston_compositor_add_key_binding(struct weston_compositor *compositor,
543 enum weston_keyboard_modifier modifier,
544 weston_key_binding_handler_t binding,
547 typedef void (*weston_button_binding_handler_t)(struct wl_seat *seat,
548 uint32_t time, uint32_t button,
550 struct weston_binding *
551 weston_compositor_add_button_binding(struct weston_compositor *compositor,
553 enum weston_keyboard_modifier modifier,
554 weston_button_binding_handler_t binding,
557 typedef void (*weston_axis_binding_handler_t)(struct wl_seat *seat,
558 uint32_t time, uint32_t axis,
559 wl_fixed_t value, void *data);
560 struct weston_binding *
561 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
563 enum weston_keyboard_modifier modifier,
564 weston_axis_binding_handler_t binding,
567 weston_binding_destroy(struct weston_binding *binding);
570 weston_binding_list_destroy_all(struct wl_list *list);
573 weston_compositor_run_key_binding(struct weston_compositor *compositor,
574 struct weston_seat *seat, uint32_t time,
576 enum wl_keyboard_key_state state);
578 weston_compositor_run_button_binding(struct weston_compositor *compositor,
579 struct weston_seat *seat, uint32_t time,
581 enum wl_pointer_button_state value);
583 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
584 struct weston_seat *seat, uint32_t time,
585 uint32_t axis, int32_t value);
588 weston_environment_get_fd(const char *env);
591 weston_compositor_top(struct weston_compositor *compositor);
593 struct weston_surface *
594 weston_surface_create(struct weston_compositor *compositor);
597 weston_surface_configure(struct weston_surface *surface,
598 GLfloat x, GLfloat y, int width, int height);
601 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
604 weston_surface_set_position(struct weston_surface *surface,
605 GLfloat x, GLfloat y);
608 weston_surface_is_mapped(struct weston_surface *surface);
611 weston_surface_assign_output(struct weston_surface *surface);
614 weston_surface_damage(struct weston_surface *surface);
617 weston_surface_damage_below(struct weston_surface *surface);
620 weston_buffer_post_release(struct wl_buffer *buffer);
623 weston_compositor_get_time(void);
626 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display,
627 int argc, char *argv[]);
629 weston_compositor_shutdown(struct weston_compositor *ec);
631 weston_output_update_zoom(struct weston_output *output,
632 int x, int y, uint32_t type);
634 weston_text_cursor_position_notify(struct weston_surface *surface, int x, int y);
636 weston_output_update_matrix(struct weston_output *output);
638 weston_output_move(struct weston_output *output, int x, int y);
640 weston_output_init(struct weston_output *output, struct weston_compositor *c,
641 int x, int y, int width, int height, uint32_t flags);
643 weston_output_destroy(struct weston_output *output);
646 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
648 weston_seat_init_pointer(struct weston_seat *seat);
650 weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
652 weston_seat_init_touch(struct weston_seat *seat);
655 weston_seat_release(struct weston_seat *seat);
662 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
665 tty_create(struct weston_compositor *compositor,
666 tty_vt_func_t vt_func, int tty_nr);
669 tty_destroy(struct tty *tty);
672 tty_activate_vt(struct tty *tty, int vt);
675 screenshooter_create(struct weston_compositor *ec);
678 text_cursor_position_notifier_create(struct weston_compositor *ec);
680 struct weston_process;
681 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
684 struct weston_process {
686 weston_process_cleanup_func_t cleanup;
691 weston_client_launch(struct weston_compositor *compositor,
692 struct weston_process *proc,
694 weston_process_cleanup_func_t cleanup);
697 weston_watch_process(struct weston_process *process);
700 weston_xserver_init(struct weston_compositor *compositor);
703 typedef void (*weston_zoom_done_func_t)(struct weston_zoom *zoom, void *data);
706 weston_zoom_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
707 weston_zoom_done_func_t done, void *data);
710 typedef void (*weston_fade_done_func_t)(struct weston_fade *fade, void *data);
713 weston_fade_run(struct weston_surface *surface,
714 weston_fade_done_func_t done, void *data);
718 weston_surface_set_color(struct weston_surface *surface,
719 GLfloat red, GLfloat green, GLfloat blue, GLfloat alpha);
722 weston_surface_destroy(struct weston_surface *surface);
724 struct weston_compositor *
725 backend_init(struct wl_display *display, int argc, char *argv[]);
728 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);