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;
53 int32_t width, height;
58 struct weston_shell_interface {
59 void *shell; /* either desktop or tablet */
61 void (*create_shell_surface)(void *shell,
62 struct weston_surface *surface,
63 struct shell_surface **ret);
64 void (*set_toplevel)(struct shell_surface *shsurf);
67 struct weston_border {
68 int32_t left, right, top, bottom;
71 struct weston_output_zoom {
76 float trans_x, trans_y;
79 /* bit compatible with drm definitions. */
87 struct weston_read_pixels {
89 int x, y, width, height;
90 void (*done)(struct weston_read_pixels *read_pixels,
91 struct weston_output *output);
95 struct weston_output {
99 struct wl_list resource_list;
100 struct wl_global *global;
101 struct weston_compositor *compositor;
102 struct weston_matrix matrix;
103 struct wl_list frame_callback_list;
104 int32_t x, y, mm_width, mm_height;
105 struct weston_border border;
106 pixman_region32_t region;
107 pixman_region32_t previous_damage;
110 int repaint_scheduled;
111 struct weston_output_zoom zoom;
113 struct wl_list read_pixels_list;
118 struct weston_mode *current;
119 struct weston_mode *origin;
120 struct wl_list mode_list;
122 void (*repaint)(struct weston_output *output,
123 pixman_region32_t *damage);
124 void (*destroy)(struct weston_output *output);
125 void (*assign_planes)(struct weston_output *output);
126 int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
128 /* backlight values are on 0-255 range, where higher is brighter */
129 uint32_t backlight_current;
130 void (*set_backlight)(struct weston_output *output, uint32_t value);
131 void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
136 struct wl_pointer pointer;
137 struct wl_keyboard keyboard;
138 struct wl_touch touch;
139 struct weston_compositor *compositor;
140 struct weston_surface *sprite;
141 struct weston_surface *drag_surface;
142 struct wl_listener drag_surface_destroy_listener;
143 int32_t hotspot_x, hotspot_y;
145 uint32_t modifier_state;
147 struct wl_surface *saved_kbd_focus;
148 struct wl_listener saved_kbd_focus_listener;
151 struct wl_surface *touch_focus;
152 struct wl_listener touch_focus_listener;
153 struct wl_resource *touch_focus_resource;
154 struct wl_listener touch_focus_resource_listener;
156 struct wl_listener new_drag_icon_listener;
159 struct weston_shader {
161 GLuint vertex_shader, fragment_shader;
165 GLint brightness_uniform;
166 GLint saturation_uniform;
168 GLint texwidth_uniform;
169 GLint opaque_uniform;
172 struct weston_animation {
173 void (*frame)(struct weston_animation *animation,
174 struct weston_output *output, uint32_t msecs);
178 struct weston_spring {
188 WESTON_COMPOSITOR_ACTIVE,
189 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
190 WESTON_COMPOSITOR_SLEEPING /* no rendering, no frame events */
193 struct weston_layer {
194 struct wl_list surface_list;
198 struct weston_compositor {
200 struct wl_signal destroy_signal;
206 struct weston_shader texture_shader;
207 struct weston_shader solid_shader;
208 struct weston_shader *current_shader;
209 struct wl_display *wl_display;
210 struct weston_shell_interface shell_interface;
212 struct wl_signal activate_signal;
213 struct wl_signal lock_signal;
214 struct wl_signal unlock_signal;
216 struct wl_event_loop *input_loop;
217 struct wl_event_source *input_loop_source;
219 /* There can be more than one, but not right now... */
220 struct weston_seat *seat;
222 struct weston_layer fade_layer;
223 struct weston_layer cursor_layer;
225 struct wl_list output_list;
226 struct wl_list seat_list;
227 struct wl_list layer_list;
228 struct wl_list surface_list;
229 struct wl_list binding_list;
230 struct wl_list animation_list;
232 struct weston_spring spring;
233 struct weston_animation animation;
234 struct weston_surface *surface;
238 struct wl_event_source *idle_source;
239 uint32_t idle_inhibit;
240 int option_idle_time; /* default timeout, s */
241 int idle_time; /* effective timeout, s */
244 struct wl_array vertices, indices;
245 pixman_region32_t damage;
249 PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
250 image_target_renderbuffer_storage;
251 PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
252 PFNEGLCREATEIMAGEKHRPROC create_image;
253 PFNEGLDESTROYIMAGEKHRPROC destroy_image;
255 int has_unpack_subimage;
258 PFNEGLBINDWAYLANDDISPLAYWL bind_display;
259 PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
260 int has_bind_display;
262 void (*destroy)(struct weston_compositor *ec);
263 int (*authenticate)(struct weston_compositor *c, uint32_t id);
265 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
269 uint32_t output_id_pool;
272 struct xkb_rule_names names;
273 struct xkb_context *context;
274 struct xkb_keymap *keymap;
275 struct xkb_state *state;
279 #define MODIFIER_CTRL (1 << 8)
280 #define MODIFIER_ALT (1 << 9)
281 #define MODIFIER_SUPER (1 << 10)
283 enum weston_output_flags {
284 WL_OUTPUT_FLIPPED = 0x01
287 struct weston_region {
288 struct wl_resource resource;
289 pixman_region32_t region;
292 /* Using weston_surface transformations
294 * To add a transformation to a surface, create a struct weston_transform, and
295 * add it to the list surface->geometry.transformation_list. Whenever you
296 * change the list, anything under surface->geometry, or anything in the
297 * weston_transforms linked into the list, you must set
298 * surface->geometry.dirty = 1.
300 * The order in the list defines the order of transformations. Let the list
301 * contain the transformation matrices M1, ..., Mn as head to tail. The
302 * transformation is applied to surface-local coordinate vector p as
303 * P = Mn * ... * M2 * M1 * p
304 * to produce the global coordinate vector P. The total transform
306 * is cached in surface->transform.matrix, and the inverse of it in
307 * surface->transform.inverse.
309 * The list always contains surface->transform.position transformation, which
310 * is the translation by surface->geometry.x and y.
312 * If you want to apply a transformation in local coordinates, add your
313 * weston_transform to the head of the list. If you want to apply a
314 * transformation in global coordinates, add it to the tail of the list.
317 struct weston_surface {
318 struct wl_surface surface;
319 struct weston_compositor *compositor;
321 pixman_region32_t clip;
322 pixman_region32_t damage;
323 pixman_region32_t opaque;
324 pixman_region32_t input;
327 struct wl_list layer_link;
328 struct weston_shader *shader;
330 GLfloat opaque_rect[4];
335 /* Surface geometry state, mutable.
336 * If you change anything, set dirty = 1.
337 * That includes the transformations referenced from the list.
340 GLfloat x, y; /* surface translation on display */
341 int32_t width, height;
343 /* struct weston_transform */
344 struct wl_list transformation_list;
349 /* State derived from geometry state, read-only.
350 * This is updated by weston_surface_update_transform().
353 pixman_region32_t boundingbox;
354 pixman_region32_t opaque;
356 /* matrix and inverse are used only if enabled = 1.
357 * If enabled = 0, use x, y, width, height directly.
360 struct weston_matrix matrix;
361 struct weston_matrix inverse;
363 struct weston_transform position; /* matrix from x, y */
367 * Which output to vsync this surface to.
368 * Used to determine, whether to send or queue frame events.
369 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
371 struct weston_output *output;
374 * A more complete representation of all outputs this surface is
377 uint32_t output_mask;
379 struct wl_list frame_callback_list;
383 struct wl_buffer *buffer;
384 struct wl_listener buffer_destroy_listener;
387 * If non-NULL, this function will be called on surface::attach after
388 * a new buffer has been set up for this surface. The integer params
389 * are the sx and sy paramerters supplied to surface::attach .
391 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
396 weston_surface_update_transform(struct weston_surface *surface);
399 weston_surface_to_global(struct weston_surface *surface,
400 int32_t sx, int32_t sy, int32_t *x, int32_t *y);
402 weston_surface_to_global_fixed(struct weston_surface *surface,
403 wl_fixed_t sx, wl_fixed_t sy,
404 wl_fixed_t *x, wl_fixed_t *y);
406 weston_surface_to_global_float(struct weston_surface *surface,
407 GLfloat sx, GLfloat sy, GLfloat *x, GLfloat *y);
410 weston_surface_from_global(struct weston_surface *surface,
411 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
413 weston_surface_from_global_fixed(struct weston_surface *surface,
414 wl_fixed_t x, wl_fixed_t y,
415 wl_fixed_t *sx, wl_fixed_t *sy);
418 weston_spring_init(struct weston_spring *spring,
419 double k, double current, double target);
421 weston_spring_update(struct weston_spring *spring, uint32_t msec);
423 weston_spring_done(struct weston_spring *spring);
426 weston_surface_activate(struct weston_surface *surface,
427 struct weston_seat *seat);
429 weston_surface_draw(struct weston_surface *es,
430 struct weston_output *output, pixman_region32_t *damage);
433 notify_motion(struct wl_seat *seat, uint32_t time,
434 wl_fixed_t x, wl_fixed_t y);
436 notify_button(struct wl_seat *seat, uint32_t time, int32_t button,
439 notify_axis(struct wl_seat *seat, uint32_t time, uint32_t axis,
442 notify_key(struct wl_seat *seat, uint32_t time, uint32_t key,
446 notify_pointer_focus(struct wl_seat *seat, struct weston_output *output,
447 wl_fixed_t x, wl_fixed_t y);
450 notify_keyboard_focus(struct wl_seat *seat, struct wl_array *keys);
453 notify_touch(struct wl_seat *seat, uint32_t time, int touch_id,
454 wl_fixed_t x, wl_fixed_t y, int touch_type);
457 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
460 weston_output_finish_frame(struct weston_output *output, int msecs);
462 weston_output_damage(struct weston_output *output);
464 weston_output_do_read_pixels(struct weston_output *output);
466 weston_compositor_repick(struct weston_compositor *compositor);
468 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
470 weston_compositor_fade(struct weston_compositor *compositor, float tint);
472 weston_compositor_damage_all(struct weston_compositor *compositor);
474 weston_compositor_unlock(struct weston_compositor *compositor);
476 weston_compositor_wake(struct weston_compositor *compositor);
478 weston_compositor_activity(struct weston_compositor *compositor);
480 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
483 struct weston_binding;
484 typedef void (*weston_binding_handler_t)(struct wl_seat *seat,
485 uint32_t time, uint32_t key,
488 int32_t value, void *data);
489 struct weston_binding *
490 weston_compositor_add_binding(struct weston_compositor *compositor,
491 uint32_t key, uint32_t button, uint32_t axis,
493 weston_binding_handler_t binding, void *data);
495 weston_binding_destroy(struct weston_binding *binding);
498 weston_binding_list_destroy_all(struct wl_list *list);
501 weston_compositor_run_binding(struct weston_compositor *compositor,
502 struct weston_seat *seat,
504 uint32_t key, uint32_t button, uint32_t axis,
507 weston_environment_get_fd(const char *env);
510 weston_compositor_top(struct weston_compositor *compositor);
512 struct weston_surface *
513 weston_surface_create(struct weston_compositor *compositor);
516 weston_surface_configure(struct weston_surface *surface,
517 GLfloat x, GLfloat y, int width, int height);
520 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
523 weston_surface_set_position(struct weston_surface *surface,
524 GLfloat x, GLfloat y);
527 weston_surface_is_mapped(struct weston_surface *surface);
530 weston_surface_assign_output(struct weston_surface *surface);
533 weston_surface_damage(struct weston_surface *surface);
536 weston_surface_damage_below(struct weston_surface *surface);
539 weston_buffer_post_release(struct wl_buffer *buffer);
542 weston_compositor_get_time(void);
545 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display);
547 weston_compositor_shutdown(struct weston_compositor *ec);
549 weston_output_update_zoom(struct weston_output *output, int x, int y);
551 weston_output_update_matrix(struct weston_output *output);
553 weston_output_move(struct weston_output *output, int x, int y);
555 weston_output_init(struct weston_output *output, struct weston_compositor *c,
556 int x, int y, int width, int height, uint32_t flags);
558 weston_output_destroy(struct weston_output *output);
561 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
564 weston_seat_release(struct weston_seat *seat);
571 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
574 tty_create(struct weston_compositor *compositor,
575 tty_vt_func_t vt_func, int tty_nr);
578 tty_destroy(struct tty *tty);
581 tty_activate_vt(struct tty *tty, int vt);
584 screenshooter_create(struct weston_compositor *ec);
586 struct weston_process;
587 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
590 struct weston_process {
592 weston_process_cleanup_func_t cleanup;
597 weston_client_launch(struct weston_compositor *compositor,
598 struct weston_process *proc,
600 weston_process_cleanup_func_t cleanup);
603 weston_watch_process(struct weston_process *process);
606 weston_xserver_init(struct weston_compositor *compositor);
609 typedef void (*weston_zoom_done_func_t)(struct weston_zoom *zoom, void *data);
612 weston_zoom_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
613 weston_zoom_done_func_t done, void *data);
616 typedef void (*weston_fade_done_func_t)(struct weston_fade *fade, void *data);
619 weston_fade_run(struct weston_surface *surface,
620 weston_fade_done_func_t done, void *data);
624 weston_surface_set_color(struct weston_surface *surface,
625 GLfloat red, GLfloat green, GLfloat blue, GLfloat alpha);
628 weston_surface_destroy(struct weston_surface *surface);
630 struct weston_compositor *
631 backend_init(struct wl_display *display, int argc, char *argv[]);
634 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);