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),
59 int32_t width, height;
64 struct weston_shell_client {
65 void (*send_configure)(struct weston_surface *surface,
66 uint32_t edges, int32_t width, int32_t height);
69 struct weston_shell_interface {
70 void *shell; /* either desktop or tablet */
72 struct shell_surface *(*create_shell_surface)(void *shell,
73 struct weston_surface *surface,
74 const struct weston_shell_client *client);
76 void (*set_toplevel)(struct shell_surface *shsurf);
78 void (*set_transient)(struct shell_surface *shsurf,
79 struct shell_surface *pshsurf,
80 int x, int y, uint32_t flags);
81 int (*move)(struct shell_surface *shsurf, struct weston_seat *ws);
82 int (*resize)(struct shell_surface *shsurf,
83 struct weston_seat *ws, uint32_t edges);
87 struct weston_border {
88 int32_t left, right, top, bottom;
96 struct weston_output_zoom {
100 float trans_x, trans_y;
103 /* bit compatible with drm definitions. */
111 struct weston_read_pixels {
113 int x, y, width, height;
114 void (*done)(struct weston_read_pixels *read_pixels,
115 struct weston_output *output);
119 struct weston_output {
123 struct wl_list resource_list;
124 struct wl_global *global;
125 struct weston_compositor *compositor;
126 struct weston_matrix matrix;
127 struct wl_list frame_callback_list;
128 int32_t x, y, mm_width, mm_height;
129 struct weston_border border;
130 pixman_region32_t region;
131 pixman_region32_t previous_damage;
134 int repaint_scheduled;
135 struct weston_output_zoom zoom;
137 struct wl_list read_pixels_list;
138 struct wl_signal frame_signal;
143 struct weston_mode *current;
144 struct weston_mode *origin;
145 struct wl_list mode_list;
147 void (*repaint)(struct weston_output *output,
148 pixman_region32_t *damage);
149 void (*destroy)(struct weston_output *output);
150 void (*assign_planes)(struct weston_output *output);
151 int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
153 /* backlight values are on 0-255 range, where higher is brighter */
154 uint32_t backlight_current;
155 void (*set_backlight)(struct weston_output *output, uint32_t value);
156 void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
161 struct wl_pointer pointer;
162 struct wl_keyboard keyboard;
163 struct wl_touch touch;
164 struct weston_compositor *compositor;
165 struct weston_surface *sprite;
166 struct weston_surface *drag_surface;
167 struct wl_listener drag_surface_destroy_listener;
168 int32_t hotspot_x, hotspot_y;
170 enum weston_keyboard_modifier modifier_state;
172 struct wl_surface *saved_kbd_focus;
173 struct wl_listener saved_kbd_focus_listener;
176 struct wl_surface *touch_focus;
177 struct wl_listener touch_focus_listener;
178 struct wl_resource *touch_focus_resource;
179 struct wl_listener touch_focus_resource_listener;
181 struct wl_listener new_drag_icon_listener;
184 struct xkb_state *state;
185 uint32_t mods_depressed;
186 uint32_t mods_latched;
187 uint32_t mods_locked;
192 struct weston_shader {
194 GLuint vertex_shader, fragment_shader;
198 GLint brightness_uniform;
199 GLint saturation_uniform;
201 GLint texwidth_uniform;
202 GLint opaque_uniform;
205 struct weston_animation {
206 void (*frame)(struct weston_animation *animation,
207 struct weston_output *output, uint32_t msecs);
211 struct weston_spring {
221 WESTON_COMPOSITOR_ACTIVE,
222 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
223 WESTON_COMPOSITOR_SLEEPING /* no rendering, no frame events */
226 struct weston_layer {
227 struct wl_list surface_list;
231 struct weston_compositor {
233 struct wl_signal destroy_signal;
239 struct weston_shader texture_shader;
240 struct weston_shader solid_shader;
241 struct weston_shader *current_shader;
242 struct wl_display *wl_display;
243 struct weston_shell_interface shell_interface;
245 struct wl_signal activate_signal;
246 struct wl_signal lock_signal;
247 struct wl_signal unlock_signal;
249 struct wl_event_loop *input_loop;
250 struct wl_event_source *input_loop_source;
252 /* There can be more than one, but not right now... */
253 struct weston_seat *seat;
255 struct weston_layer fade_layer;
256 struct weston_layer cursor_layer;
258 struct wl_list output_list;
259 struct wl_list seat_list;
260 struct wl_list layer_list;
261 struct wl_list surface_list;
262 struct wl_list binding_list;
263 struct wl_list animation_list;
265 struct weston_spring spring;
266 struct weston_animation animation;
267 struct weston_surface *surface;
271 struct wl_event_source *idle_source;
272 uint32_t idle_inhibit;
273 int option_idle_time; /* default timeout, s */
274 int idle_time; /* effective timeout, s */
277 struct wl_array vertices, indices;
278 pixman_region32_t damage;
282 PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
283 image_target_renderbuffer_storage;
284 PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
285 PFNEGLCREATEIMAGEKHRPROC create_image;
286 PFNEGLDESTROYIMAGEKHRPROC destroy_image;
288 int has_unpack_subimage;
291 PFNEGLBINDWAYLANDDISPLAYWL bind_display;
292 PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
293 int has_bind_display;
295 void (*destroy)(struct weston_compositor *ec);
296 int (*authenticate)(struct weston_compositor *c, uint32_t id);
298 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
302 uint32_t output_id_pool;
305 struct xkb_rule_names names;
306 struct xkb_context *context;
307 struct xkb_keymap *keymap;
311 enum weston_output_flags {
312 WL_OUTPUT_FLIPPED = 0x01
315 struct weston_region {
316 struct wl_resource resource;
317 pixman_region32_t region;
320 /* Using weston_surface transformations
322 * To add a transformation to a surface, create a struct weston_transform, and
323 * add it to the list surface->geometry.transformation_list. Whenever you
324 * change the list, anything under surface->geometry, or anything in the
325 * weston_transforms linked into the list, you must set
326 * surface->geometry.dirty = 1.
328 * The order in the list defines the order of transformations. Let the list
329 * contain the transformation matrices M1, ..., Mn as head to tail. The
330 * transformation is applied to surface-local coordinate vector p as
331 * P = Mn * ... * M2 * M1 * p
332 * to produce the global coordinate vector P. The total transform
334 * is cached in surface->transform.matrix, and the inverse of it in
335 * surface->transform.inverse.
337 * The list always contains surface->transform.position transformation, which
338 * is the translation by surface->geometry.x and y.
340 * If you want to apply a transformation in local coordinates, add your
341 * weston_transform to the head of the list. If you want to apply a
342 * transformation in global coordinates, add it to the tail of the list.
345 struct weston_surface {
346 struct wl_surface surface;
347 struct weston_compositor *compositor;
349 pixman_region32_t clip;
350 pixman_region32_t damage;
351 pixman_region32_t opaque;
352 pixman_region32_t input;
355 struct wl_list layer_link;
356 struct weston_shader *shader;
358 GLfloat opaque_rect[4];
364 /* Surface geometry state, mutable.
365 * If you change anything, set dirty = 1.
366 * That includes the transformations referenced from the list.
369 GLfloat x, y; /* surface translation on display */
370 int32_t width, height;
372 /* struct weston_transform */
373 struct wl_list transformation_list;
378 /* State derived from geometry state, read-only.
379 * This is updated by weston_surface_update_transform().
382 pixman_region32_t boundingbox;
383 pixman_region32_t opaque;
385 /* matrix and inverse are used only if enabled = 1.
386 * If enabled = 0, use x, y, width, height directly.
389 struct weston_matrix matrix;
390 struct weston_matrix inverse;
392 struct weston_transform position; /* matrix from x, y */
396 * Which output to vsync this surface to.
397 * Used to determine, whether to send or queue frame events.
398 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
400 struct weston_output *output;
403 * A more complete representation of all outputs this surface is
406 uint32_t output_mask;
408 struct wl_list frame_callback_list;
412 struct wl_buffer *buffer;
413 struct wl_listener buffer_destroy_listener;
416 * If non-NULL, this function will be called on surface::attach after
417 * a new buffer has been set up for this surface. The integer params
418 * are the sx and sy paramerters supplied to surface::attach .
420 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
425 weston_surface_update_transform(struct weston_surface *surface);
428 weston_surface_to_global(struct weston_surface *surface,
429 int32_t sx, int32_t sy, int32_t *x, int32_t *y);
431 weston_surface_to_global_fixed(struct weston_surface *surface,
432 wl_fixed_t sx, wl_fixed_t sy,
433 wl_fixed_t *x, wl_fixed_t *y);
435 weston_surface_to_global_float(struct weston_surface *surface,
436 GLfloat sx, GLfloat sy, GLfloat *x, GLfloat *y);
439 weston_surface_from_global(struct weston_surface *surface,
440 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
442 weston_surface_from_global_fixed(struct weston_surface *surface,
443 wl_fixed_t x, wl_fixed_t y,
444 wl_fixed_t *sx, wl_fixed_t *sy);
447 weston_spring_init(struct weston_spring *spring,
448 double k, double current, double target);
450 weston_spring_update(struct weston_spring *spring, uint32_t msec);
452 weston_spring_done(struct weston_spring *spring);
455 weston_surface_activate(struct weston_surface *surface,
456 struct weston_seat *seat);
458 weston_surface_draw(struct weston_surface *es,
459 struct weston_output *output, pixman_region32_t *damage);
462 notify_motion(struct wl_seat *seat, uint32_t time,
463 wl_fixed_t x, wl_fixed_t y);
465 notify_button(struct wl_seat *seat, uint32_t time, int32_t button,
468 notify_axis(struct wl_seat *seat, uint32_t time, uint32_t axis,
471 notify_key(struct wl_seat *seat, uint32_t time, uint32_t key,
475 notify_pointer_focus(struct wl_seat *seat, struct weston_output *output,
476 wl_fixed_t x, wl_fixed_t y);
479 notify_keyboard_focus(struct wl_seat *seat, struct wl_array *keys);
482 notify_touch(struct wl_seat *seat, uint32_t time, int touch_id,
483 wl_fixed_t x, wl_fixed_t y, int touch_type);
486 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
489 weston_output_finish_frame(struct weston_output *output, int msecs);
491 weston_output_damage(struct weston_output *output);
493 weston_output_do_read_pixels(struct weston_output *output);
495 weston_compositor_repick(struct weston_compositor *compositor);
497 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
499 weston_compositor_fade(struct weston_compositor *compositor, float tint);
501 weston_compositor_damage_all(struct weston_compositor *compositor);
503 weston_compositor_unlock(struct weston_compositor *compositor);
505 weston_compositor_wake(struct weston_compositor *compositor);
507 weston_compositor_activity(struct weston_compositor *compositor);
509 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
512 struct weston_binding;
513 typedef void (*weston_binding_handler_t)(struct wl_seat *seat,
514 uint32_t time, uint32_t key,
517 int32_t value, void *data);
518 struct weston_binding *
519 weston_compositor_add_binding(struct weston_compositor *compositor,
520 uint32_t key, uint32_t button, uint32_t axis,
521 enum weston_keyboard_modifier modifier,
522 weston_binding_handler_t binding, void *data);
524 weston_binding_destroy(struct weston_binding *binding);
527 weston_binding_list_destroy_all(struct wl_list *list);
530 weston_compositor_run_binding(struct weston_compositor *compositor,
531 struct weston_seat *seat,
533 uint32_t key, uint32_t button, uint32_t axis,
536 weston_environment_get_fd(const char *env);
539 weston_compositor_top(struct weston_compositor *compositor);
541 struct weston_surface *
542 weston_surface_create(struct weston_compositor *compositor);
545 weston_surface_configure(struct weston_surface *surface,
546 GLfloat x, GLfloat y, int width, int height);
549 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
552 weston_surface_set_position(struct weston_surface *surface,
553 GLfloat x, GLfloat y);
556 weston_surface_is_mapped(struct weston_surface *surface);
559 weston_surface_assign_output(struct weston_surface *surface);
562 weston_surface_damage(struct weston_surface *surface);
565 weston_surface_damage_below(struct weston_surface *surface);
568 weston_buffer_post_release(struct wl_buffer *buffer);
571 weston_compositor_get_time(void);
574 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display);
576 weston_compositor_shutdown(struct weston_compositor *ec);
578 weston_output_update_zoom(struct weston_output *output,
579 int x, int y, uint32_t type);
581 weston_text_cursor_position_notify(struct weston_surface *surface, int x, int y);
583 weston_output_update_matrix(struct weston_output *output);
585 weston_output_move(struct weston_output *output, int x, int y);
587 weston_output_init(struct weston_output *output, struct weston_compositor *c,
588 int x, int y, int width, int height, uint32_t flags);
590 weston_output_destroy(struct weston_output *output);
593 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
596 weston_seat_release(struct weston_seat *seat);
603 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
606 tty_create(struct weston_compositor *compositor,
607 tty_vt_func_t vt_func, int tty_nr);
610 tty_destroy(struct tty *tty);
613 tty_activate_vt(struct tty *tty, int vt);
616 screenshooter_create(struct weston_compositor *ec);
619 text_cursor_position_notifier_create(struct weston_compositor *ec);
621 struct weston_process;
622 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
625 struct weston_process {
627 weston_process_cleanup_func_t cleanup;
632 weston_client_launch(struct weston_compositor *compositor,
633 struct weston_process *proc,
635 weston_process_cleanup_func_t cleanup);
638 weston_watch_process(struct weston_process *process);
641 weston_xserver_init(struct weston_compositor *compositor);
644 typedef void (*weston_zoom_done_func_t)(struct weston_zoom *zoom, void *data);
647 weston_zoom_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
648 weston_zoom_done_func_t done, void *data);
651 typedef void (*weston_fade_done_func_t)(struct weston_fade *fade, void *data);
654 weston_fade_run(struct weston_surface *surface,
655 weston_fade_done_func_t done, void *data);
659 weston_surface_set_color(struct weston_surface *surface,
660 GLfloat red, GLfloat green, GLfloat blue, GLfloat alpha);
663 weston_surface_destroy(struct weston_surface *surface);
665 struct weston_compositor *
666 backend_init(struct wl_display *display, int argc, char *argv[]);
669 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);