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);
66 void (*set_transient)(struct shell_surface *shsurf,
67 struct shell_surface *pshsurf,
68 int x, int y, uint32_t flags);
69 int (*move)(struct shell_surface *shsurf, struct weston_seat *ws);
72 struct weston_border {
73 int32_t left, right, top, bottom;
76 struct weston_output_zoom {
81 float trans_x, trans_y;
84 /* bit compatible with drm definitions. */
92 struct weston_read_pixels {
94 int x, y, width, height;
95 void (*done)(struct weston_read_pixels *read_pixels,
96 struct weston_output *output);
100 struct weston_output {
104 struct wl_list resource_list;
105 struct wl_global *global;
106 struct weston_compositor *compositor;
107 struct weston_matrix matrix;
108 struct wl_list frame_callback_list;
109 int32_t x, y, mm_width, mm_height;
110 struct weston_border border;
111 pixman_region32_t region;
112 pixman_region32_t previous_damage;
115 int repaint_scheduled;
116 struct weston_output_zoom zoom;
118 struct wl_list read_pixels_list;
123 struct weston_mode *current;
124 struct weston_mode *origin;
125 struct wl_list mode_list;
127 void (*repaint)(struct weston_output *output,
128 pixman_region32_t *damage);
129 void (*destroy)(struct weston_output *output);
130 void (*assign_planes)(struct weston_output *output);
131 int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
133 /* backlight values are on 0-255 range, where higher is brighter */
134 uint32_t backlight_current;
135 void (*set_backlight)(struct weston_output *output, uint32_t value);
136 void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
141 struct wl_pointer pointer;
142 struct wl_keyboard keyboard;
143 struct wl_touch touch;
144 struct weston_compositor *compositor;
145 struct weston_surface *sprite;
146 struct weston_surface *drag_surface;
147 struct wl_listener drag_surface_destroy_listener;
148 int32_t hotspot_x, hotspot_y;
150 uint32_t modifier_state;
152 struct wl_surface *saved_kbd_focus;
153 struct wl_listener saved_kbd_focus_listener;
156 struct wl_surface *touch_focus;
157 struct wl_listener touch_focus_listener;
158 struct wl_resource *touch_focus_resource;
159 struct wl_listener touch_focus_resource_listener;
161 struct wl_listener new_drag_icon_listener;
164 struct weston_shader {
166 GLuint vertex_shader, fragment_shader;
170 GLint brightness_uniform;
171 GLint saturation_uniform;
173 GLint texwidth_uniform;
174 GLint opaque_uniform;
177 struct weston_animation {
178 void (*frame)(struct weston_animation *animation,
179 struct weston_output *output, uint32_t msecs);
183 struct weston_spring {
193 WESTON_COMPOSITOR_ACTIVE,
194 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
195 WESTON_COMPOSITOR_SLEEPING /* no rendering, no frame events */
198 struct weston_layer {
199 struct wl_list surface_list;
203 struct weston_compositor {
205 struct wl_signal destroy_signal;
211 struct weston_shader texture_shader;
212 struct weston_shader solid_shader;
213 struct weston_shader *current_shader;
214 struct wl_display *wl_display;
215 struct weston_shell_interface shell_interface;
217 struct wl_signal activate_signal;
218 struct wl_signal lock_signal;
219 struct wl_signal unlock_signal;
221 struct wl_event_loop *input_loop;
222 struct wl_event_source *input_loop_source;
224 /* There can be more than one, but not right now... */
225 struct weston_seat *seat;
227 struct weston_layer fade_layer;
228 struct weston_layer cursor_layer;
230 struct wl_list output_list;
231 struct wl_list seat_list;
232 struct wl_list layer_list;
233 struct wl_list surface_list;
234 struct wl_list binding_list;
235 struct wl_list animation_list;
237 struct weston_spring spring;
238 struct weston_animation animation;
239 struct weston_surface *surface;
243 struct wl_event_source *idle_source;
244 uint32_t idle_inhibit;
245 int option_idle_time; /* default timeout, s */
246 int idle_time; /* effective timeout, s */
249 struct wl_array vertices, indices;
250 pixman_region32_t damage;
254 PFNGLEGLIMAGETARGETRENDERBUFFERSTORAGEOESPROC
255 image_target_renderbuffer_storage;
256 PFNGLEGLIMAGETARGETTEXTURE2DOESPROC image_target_texture_2d;
257 PFNEGLCREATEIMAGEKHRPROC create_image;
258 PFNEGLDESTROYIMAGEKHRPROC destroy_image;
260 int has_unpack_subimage;
263 PFNEGLBINDWAYLANDDISPLAYWL bind_display;
264 PFNEGLUNBINDWAYLANDDISPLAYWL unbind_display;
265 int has_bind_display;
267 void (*destroy)(struct weston_compositor *ec);
268 int (*authenticate)(struct weston_compositor *c, uint32_t id);
270 void (*ping_handler)(struct weston_surface *surface, uint32_t serial);
274 uint32_t output_id_pool;
277 struct xkb_rule_names names;
278 struct xkb_context *context;
279 struct xkb_keymap *keymap;
280 struct xkb_state *state;
284 #define MODIFIER_CTRL (1 << 8)
285 #define MODIFIER_ALT (1 << 9)
286 #define MODIFIER_SUPER (1 << 10)
288 enum weston_output_flags {
289 WL_OUTPUT_FLIPPED = 0x01
292 struct weston_region {
293 struct wl_resource resource;
294 pixman_region32_t region;
297 /* Using weston_surface transformations
299 * To add a transformation to a surface, create a struct weston_transform, and
300 * add it to the list surface->geometry.transformation_list. Whenever you
301 * change the list, anything under surface->geometry, or anything in the
302 * weston_transforms linked into the list, you must set
303 * surface->geometry.dirty = 1.
305 * The order in the list defines the order of transformations. Let the list
306 * contain the transformation matrices M1, ..., Mn as head to tail. The
307 * transformation is applied to surface-local coordinate vector p as
308 * P = Mn * ... * M2 * M1 * p
309 * to produce the global coordinate vector P. The total transform
311 * is cached in surface->transform.matrix, and the inverse of it in
312 * surface->transform.inverse.
314 * The list always contains surface->transform.position transformation, which
315 * is the translation by surface->geometry.x and y.
317 * If you want to apply a transformation in local coordinates, add your
318 * weston_transform to the head of the list. If you want to apply a
319 * transformation in global coordinates, add it to the tail of the list.
322 struct weston_surface {
323 struct wl_surface surface;
324 struct weston_compositor *compositor;
326 pixman_region32_t clip;
327 pixman_region32_t damage;
328 pixman_region32_t opaque;
329 pixman_region32_t input;
332 struct wl_list layer_link;
333 struct weston_shader *shader;
335 GLfloat opaque_rect[4];
341 /* Surface geometry state, mutable.
342 * If you change anything, set dirty = 1.
343 * That includes the transformations referenced from the list.
346 GLfloat x, y; /* surface translation on display */
347 int32_t width, height;
349 /* struct weston_transform */
350 struct wl_list transformation_list;
355 /* State derived from geometry state, read-only.
356 * This is updated by weston_surface_update_transform().
359 pixman_region32_t boundingbox;
360 pixman_region32_t opaque;
362 /* matrix and inverse are used only if enabled = 1.
363 * If enabled = 0, use x, y, width, height directly.
366 struct weston_matrix matrix;
367 struct weston_matrix inverse;
369 struct weston_transform position; /* matrix from x, y */
373 * Which output to vsync this surface to.
374 * Used to determine, whether to send or queue frame events.
375 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
377 struct weston_output *output;
380 * A more complete representation of all outputs this surface is
383 uint32_t output_mask;
385 struct wl_list frame_callback_list;
389 struct wl_buffer *buffer;
390 struct wl_listener buffer_destroy_listener;
393 * If non-NULL, this function will be called on surface::attach after
394 * a new buffer has been set up for this surface. The integer params
395 * are the sx and sy paramerters supplied to surface::attach .
397 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
402 weston_surface_update_transform(struct weston_surface *surface);
405 weston_surface_to_global(struct weston_surface *surface,
406 int32_t sx, int32_t sy, int32_t *x, int32_t *y);
408 weston_surface_to_global_fixed(struct weston_surface *surface,
409 wl_fixed_t sx, wl_fixed_t sy,
410 wl_fixed_t *x, wl_fixed_t *y);
412 weston_surface_to_global_float(struct weston_surface *surface,
413 GLfloat sx, GLfloat sy, GLfloat *x, GLfloat *y);
416 weston_surface_from_global(struct weston_surface *surface,
417 int32_t x, int32_t y, int32_t *sx, int32_t *sy);
419 weston_surface_from_global_fixed(struct weston_surface *surface,
420 wl_fixed_t x, wl_fixed_t y,
421 wl_fixed_t *sx, wl_fixed_t *sy);
424 weston_spring_init(struct weston_spring *spring,
425 double k, double current, double target);
427 weston_spring_update(struct weston_spring *spring, uint32_t msec);
429 weston_spring_done(struct weston_spring *spring);
432 weston_surface_activate(struct weston_surface *surface,
433 struct weston_seat *seat);
435 weston_surface_draw(struct weston_surface *es,
436 struct weston_output *output, pixman_region32_t *damage);
439 notify_motion(struct wl_seat *seat, uint32_t time,
440 wl_fixed_t x, wl_fixed_t y);
442 notify_button(struct wl_seat *seat, uint32_t time, int32_t button,
445 notify_axis(struct wl_seat *seat, uint32_t time, uint32_t axis,
448 notify_key(struct wl_seat *seat, uint32_t time, uint32_t key,
452 notify_pointer_focus(struct wl_seat *seat, struct weston_output *output,
453 wl_fixed_t x, wl_fixed_t y);
456 notify_keyboard_focus(struct wl_seat *seat, struct wl_array *keys);
459 notify_touch(struct wl_seat *seat, uint32_t time, int touch_id,
460 wl_fixed_t x, wl_fixed_t y, int touch_type);
463 weston_layer_init(struct weston_layer *layer, struct wl_list *below);
466 weston_output_finish_frame(struct weston_output *output, int msecs);
468 weston_output_damage(struct weston_output *output);
470 weston_output_do_read_pixels(struct weston_output *output);
472 weston_compositor_repick(struct weston_compositor *compositor);
474 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
476 weston_compositor_fade(struct weston_compositor *compositor, float tint);
478 weston_compositor_damage_all(struct weston_compositor *compositor);
480 weston_compositor_unlock(struct weston_compositor *compositor);
482 weston_compositor_wake(struct weston_compositor *compositor);
484 weston_compositor_activity(struct weston_compositor *compositor);
486 weston_compositor_update_drag_surfaces(struct weston_compositor *compositor);
489 struct weston_binding;
490 typedef void (*weston_binding_handler_t)(struct wl_seat *seat,
491 uint32_t time, uint32_t key,
494 int32_t value, void *data);
495 struct weston_binding *
496 weston_compositor_add_binding(struct weston_compositor *compositor,
497 uint32_t key, uint32_t button, uint32_t axis,
499 weston_binding_handler_t binding, void *data);
501 weston_binding_destroy(struct weston_binding *binding);
504 weston_binding_list_destroy_all(struct wl_list *list);
507 weston_compositor_run_binding(struct weston_compositor *compositor,
508 struct weston_seat *seat,
510 uint32_t key, uint32_t button, uint32_t axis,
513 weston_environment_get_fd(const char *env);
516 weston_compositor_top(struct weston_compositor *compositor);
518 struct weston_surface *
519 weston_surface_create(struct weston_compositor *compositor);
522 weston_surface_configure(struct weston_surface *surface,
523 GLfloat x, GLfloat y, int width, int height);
526 weston_surface_restack(struct weston_surface *surface, struct wl_list *below);
529 weston_surface_set_position(struct weston_surface *surface,
530 GLfloat x, GLfloat y);
533 weston_surface_is_mapped(struct weston_surface *surface);
536 weston_surface_assign_output(struct weston_surface *surface);
539 weston_surface_damage(struct weston_surface *surface);
542 weston_surface_damage_below(struct weston_surface *surface);
545 weston_buffer_post_release(struct wl_buffer *buffer);
548 weston_compositor_get_time(void);
551 weston_compositor_init(struct weston_compositor *ec, struct wl_display *display);
553 weston_compositor_shutdown(struct weston_compositor *ec);
555 weston_output_update_zoom(struct weston_output *output, int x, int y);
557 weston_output_update_matrix(struct weston_output *output);
559 weston_output_move(struct weston_output *output, int x, int y);
561 weston_output_init(struct weston_output *output, struct weston_compositor *c,
562 int x, int y, int width, int height, uint32_t flags);
564 weston_output_destroy(struct weston_output *output);
567 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec);
570 weston_seat_release(struct weston_seat *seat);
577 typedef void (*tty_vt_func_t)(struct weston_compositor *compositor, int event);
580 tty_create(struct weston_compositor *compositor,
581 tty_vt_func_t vt_func, int tty_nr);
584 tty_destroy(struct tty *tty);
587 tty_activate_vt(struct tty *tty, int vt);
590 screenshooter_create(struct weston_compositor *ec);
592 struct weston_process;
593 typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
596 struct weston_process {
598 weston_process_cleanup_func_t cleanup;
603 weston_client_launch(struct weston_compositor *compositor,
604 struct weston_process *proc,
606 weston_process_cleanup_func_t cleanup);
609 weston_watch_process(struct weston_process *process);
612 weston_xserver_init(struct weston_compositor *compositor);
615 typedef void (*weston_zoom_done_func_t)(struct weston_zoom *zoom, void *data);
618 weston_zoom_run(struct weston_surface *surface, GLfloat start, GLfloat stop,
619 weston_zoom_done_func_t done, void *data);
622 typedef void (*weston_fade_done_func_t)(struct weston_fade *fade, void *data);
625 weston_fade_run(struct weston_surface *surface,
626 weston_fade_done_func_t done, void *data);
630 weston_surface_set_color(struct weston_surface *surface,
631 GLfloat red, GLfloat green, GLfloat blue, GLfloat alpha);
634 weston_surface_destroy(struct weston_surface *surface);
636 struct weston_compositor *
637 backend_init(struct wl_display *display, int argc, char *argv[]);
640 weston_output_switch_mode(struct weston_output *output, struct weston_mode *mode);