blob: 3a2663569ea5e0d9e3a423c779e12cae941d1334 [file] [log] [blame]
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001/*
2 * Copyright © 2008-2011 Kristian Høgsberg
Pekka Paalanend581a8f2012-01-27 16:25:16 +02003 * Copyright © 2012 Collabora, Ltd.
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05004 *
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.
14 *
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.
22 */
23
24#ifndef _WAYLAND_SYSTEM_COMPOSITOR_H_
25#define _WAYLAND_SYSTEM_COMPOSITOR_H_
26
Giulio Camuffo7fe01b12013-03-28 18:02:42 +010027#ifdef __cplusplus
28extern "C" {
29#endif
30
Derek Foreman280e7dd2014-10-03 13:13:42 -050031#include <stdbool.h>
Pekka Paalanenb5eedad2014-09-23 22:08:45 -040032#include <time.h>
Kristian Høgsberg8334bc12012-01-03 10:29:47 -050033#include <pixman.h>
Daniel Stone855028f2012-05-01 20:37:10 +010034#include <xkbcommon/xkbcommon.h>
Kristian Høgsberg3c179332013-08-06 19:27:04 -070035
36#define WL_HIDE_DEPRECATED
Kristian Høgsberg8334bc12012-01-03 10:29:47 -050037#include <wayland-server.h>
38
Kristian Høgsbergaf4f2aa2013-02-15 20:53:20 -050039#include "version.h"
40#include "matrix.h"
41#include "config-parser.h"
Peter Huttererb1bc4a62013-08-08 11:57:04 +100042#include "zalloc.h"
Pekka Paalanenb5026542014-11-12 15:09:24 +020043#include "timeline-object.h"
Pekka Paalanen2eaa11e2012-03-30 15:45:40 +030044
Jason Ekstrandf568fd52013-06-26 22:20:30 -050045#ifndef MIN
46#define MIN(x,y) (((x) < (y)) ? (x) : (y))
47#endif
48
Kristian Høgsberg5717b6d2012-10-19 17:12:38 -040049#define ARRAY_LENGTH(a) (sizeof (a) / sizeof (a)[0])
Kristian Høgsberg8334bc12012-01-03 10:29:47 -050050
Kristian Høgsberg8c31a4c2012-10-19 23:05:37 -040051#define container_of(ptr, type, member) ({ \
52 const __typeof__( ((type *)0)->member ) *__mptr = (ptr); \
53 (type *)( (char *)__mptr - offsetof(type,member) );})
54
Kristian Høgsberg8334bc12012-01-03 10:29:47 -050055struct weston_transform {
56 struct weston_matrix matrix;
Pekka Paalanenc61eca62012-01-06 14:10:06 +020057 struct wl_list link;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -050058};
59
60struct weston_surface;
Jason Ekstrand6bd62942013-06-20 20:38:23 -050061struct weston_buffer;
Tiago Vignattibc052c92012-04-19 16:18:18 +030062struct shell_surface;
Daniel Stone37816df2012-05-16 18:45:18 +010063struct weston_seat;
Scott Moreau062be7e2012-04-20 13:37:33 -060064struct weston_output;
Jan Arne Petersene829adc2012-08-10 16:47:22 +020065struct input_method;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -050066
Daniel Stone496ca172012-05-30 16:31:42 +010067enum weston_keyboard_modifier {
68 MODIFIER_CTRL = (1 << 0),
69 MODIFIER_ALT = (1 << 1),
70 MODIFIER_SUPER = (1 << 2),
Kristian Høgsberg73694c82012-06-28 14:13:10 -040071 MODIFIER_SHIFT = (1 << 3),
Daniel Stone496ca172012-05-30 16:31:42 +010072};
73
Giulio Camuffo6ef444d2014-08-28 19:44:09 +030074enum weston_keyboard_locks {
75 WESTON_NUM_LOCK = (1 << 0),
76 WESTON_CAPS_LOCK = (1 << 1),
77};
78
Daniel Stone8c8164f2012-05-30 16:31:45 +010079enum weston_led {
80 LED_NUM_LOCK = (1 << 0),
81 LED_CAPS_LOCK = (1 << 1),
82 LED_SCROLL_LOCK = (1 << 2),
83};
84
Kristian Høgsberg8334bc12012-01-03 10:29:47 -050085struct weston_mode {
86 uint32_t flags;
87 int32_t width, height;
88 uint32_t refresh;
89 struct wl_list link;
90};
91
Kristian Høgsberga61ca062012-05-22 16:05:52 -040092struct weston_shell_client {
Jasper St. Pierreac985be2014-04-28 11:19:28 -040093 void (*send_configure)(struct weston_surface *surface, int32_t width, int32_t height);
Kristian Høgsberga61ca062012-05-22 16:05:52 -040094};
95
Tiago Vignattibc052c92012-04-19 16:18:18 +030096struct weston_shell_interface {
97 void *shell; /* either desktop or tablet */
98
Kristian Høgsberg45ba8692012-05-21 14:27:33 -040099 struct shell_surface *(*create_shell_surface)(void *shell,
Kristian Høgsberga61ca062012-05-22 16:05:52 -0400100 struct weston_surface *surface,
101 const struct weston_shell_client *client);
Jason Ekstranda7af7042013-10-12 22:38:11 -0500102 struct weston_view *(*get_primary_view)(void *shell,
103 struct shell_surface *shsurf);
Kristian Høgsberg45ba8692012-05-21 14:27:33 -0400104
Tiago Vignattibc052c92012-04-19 16:18:18 +0300105 void (*set_toplevel)(struct shell_surface *shsurf);
Kristian Høgsberg938b8fa2012-05-18 13:46:27 -0400106
Tiago Vignatti491bac12012-05-18 16:37:43 -0400107 void (*set_transient)(struct shell_surface *shsurf,
Kristian Høgsberg8150b192012-06-27 10:22:58 -0400108 struct weston_surface *parent,
Tiago Vignatti491bac12012-05-18 16:37:43 -0400109 int x, int y, uint32_t flags);
Kristian Høgsbergb810eb52013-02-12 20:07:05 -0500110 void (*set_fullscreen)(struct shell_surface *shsurf,
111 uint32_t method,
112 uint32_t framerate,
113 struct weston_output *output);
Tiago Vignattifb2adba2013-06-12 15:43:21 -0300114 void (*set_xwayland)(struct shell_surface *shsurf,
115 int x, int y, uint32_t flags);
Kristian Høgsberg938b8fa2012-05-18 13:46:27 -0400116 int (*move)(struct shell_surface *shsurf, struct weston_seat *ws);
Kristian Høgsbergc1693f22012-05-22 16:56:23 -0400117 int (*resize)(struct shell_surface *shsurf,
118 struct weston_seat *ws, uint32_t edges);
Giulio Camuffo62942ad2013-09-11 18:20:47 +0200119 void (*set_title)(struct shell_surface *shsurf,
120 const char *title);
Jasper St. Pierreccf48fb2014-05-02 10:21:38 -0400121 void (*set_window_geometry)(struct shell_surface *shsurf,
122 int32_t x, int32_t y,
123 int32_t width, int32_t height);
Tiago Vignattibc052c92012-04-19 16:18:18 +0300124};
125
Scott Moreaue6603982012-06-11 13:07:51 -0600126struct weston_animation {
127 void (*frame)(struct weston_animation *animation,
128 struct weston_output *output, uint32_t msecs);
129 int frame_counter;
130 struct wl_list link;
131};
132
Kristian Høgsberg7eec9b32013-06-17 09:15:22 -0400133enum {
134 WESTON_SPRING_OVERSHOOT,
135 WESTON_SPRING_CLAMP,
136 WESTON_SPRING_BOUNCE
137};
138
Scott Moreaue6603982012-06-11 13:07:51 -0600139struct weston_spring {
140 double k;
141 double friction;
142 double current;
143 double target;
144 double previous;
Kristian Høgsberg091b0962013-06-17 09:23:14 -0400145 double min, max;
Scott Moreaue6603982012-06-11 13:07:51 -0600146 uint32_t timestamp;
Kristian Høgsberg7eec9b32013-06-17 09:15:22 -0400147 uint32_t clip;
Scott Moreaue6603982012-06-11 13:07:51 -0600148};
149
Scott Moreau8dacaab2012-06-17 18:10:58 -0600150struct weston_fixed_point {
151 wl_fixed_t x, y;
152};
153
Scott Moreauccbf29d2012-02-22 14:21:41 -0700154struct weston_output_zoom {
155 int active;
156 float increment;
157 float level;
Scott Moreaue6603982012-06-11 13:07:51 -0600158 float max_level;
Scott Moreauccbf29d2012-02-22 14:21:41 -0700159 float trans_x, trans_y;
Scott Moreaue6603982012-06-11 13:07:51 -0600160 struct weston_animation animation_z;
161 struct weston_spring spring_z;
Scott Moreau8dacaab2012-06-17 18:10:58 -0600162 struct weston_animation animation_xy;
163 struct weston_spring spring_xy;
164 struct weston_fixed_point from;
165 struct weston_fixed_point to;
166 struct weston_fixed_point current;
Giulio Camuffo412b0242013-11-14 23:42:51 +0100167 struct wl_listener motion_listener;
Scott Moreauccbf29d2012-02-22 14:21:41 -0700168};
169
Tiago Vignatti8e53c7f2012-02-29 19:53:50 +0200170/* bit compatible with drm definitions. */
171enum dpms_enum {
172 WESTON_DPMS_ON,
173 WESTON_DPMS_STANDBY,
174 WESTON_DPMS_SUSPEND,
175 WESTON_DPMS_OFF
176};
177
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500178struct weston_output {
Casey Dahlin58ba1372012-04-19 22:50:08 -0400179 uint32_t id;
Richard Hughesafe690c2013-05-02 10:10:04 +0100180 char *name;
Casey Dahlin58ba1372012-04-19 22:50:08 -0400181
John Kåre Alsaker94659272012-11-13 19:10:18 +0100182 void *renderer_state;
183
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500184 struct wl_list link;
Casey Dahlin9074db52012-04-19 22:50:09 -0400185 struct wl_list resource_list;
Benjamin Franzkeb6879402012-04-10 18:28:54 +0200186 struct wl_global *global;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500187 struct weston_compositor *compositor;
188 struct weston_matrix matrix;
Scott Moreau9d1b1122012-06-08 19:40:53 -0600189 struct wl_list animation_list;
Scott Moreau1bad5db2012-08-18 01:04:05 -0600190 int32_t x, y, width, height;
191 int32_t mm_width, mm_height;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500192 pixman_region32_t region;
Ander Conselvan de Oliveirab8fcca92012-11-16 17:23:52 +0200193 pixman_region32_t previous_damage;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500194 int repaint_needed;
195 int repaint_scheduled;
Scott Moreauccbf29d2012-02-22 14:21:41 -0700196 struct weston_output_zoom zoom;
197 int dirty;
Kristian Høgsberg5fb70bf2012-05-24 12:29:46 -0400198 struct wl_signal frame_signal;
Richard Hughes64ddde12013-05-01 21:52:10 +0100199 struct wl_signal destroy_signal;
Zhang, Xiong Yf3012412013-12-13 22:10:53 +0200200 int move_x, move_y;
Pekka Paalanenb5eedad2014-09-23 22:08:45 -0400201 uint32_t frame_time; /* presentation timestamp in milliseconds */
Pekka Paalanen641307c2014-09-23 22:08:47 -0400202 uint64_t msc; /* media stream counter */
Kristian Høgsberg79af73e2012-08-03 15:45:23 -0400203 int disable_planes;
Ander Conselvan de Oliveirae1e23522013-12-13 22:10:55 +0200204 int destroying;
Pekka Paalanen133e4392014-09-23 22:08:46 -0400205 struct wl_list feedback_list;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500206
Richard Hughes2b2092a2013-04-24 14:58:02 +0100207 char *make, *model, *serial_number;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500208 uint32_t subpixel;
Kristian Høgsberg05890dc2012-08-10 10:09:20 -0400209 uint32_t transform;
Hardening57388e42013-09-18 23:56:36 +0200210 int32_t native_scale;
Hardeningff39efa2013-09-18 23:56:35 +0200211 int32_t current_scale;
Hardening57388e42013-09-18 23:56:36 +0200212 int32_t original_scale;
Alexander Larsson4ea95522013-05-22 14:41:37 +0200213
Hardening57388e42013-09-18 23:56:36 +0200214 struct weston_mode *native_mode;
Hardeningff39efa2013-09-18 23:56:35 +0200215 struct weston_mode *current_mode;
216 struct weston_mode *original_mode;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500217 struct wl_list mode_list;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500218
Jonas Ådahle5a12252013-04-05 23:07:11 +0200219 void (*start_repaint_loop)(struct weston_output *output);
David Herrmann1edf44c2013-10-22 17:11:26 +0200220 int (*repaint)(struct weston_output *output,
Kristian Høgsbergd7c17262012-09-05 21:54:15 -0400221 pixman_region32_t *damage);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500222 void (*destroy)(struct weston_output *output);
Jesse Barnes5308a5e2012-02-09 13:12:57 -0800223 void (*assign_planes)(struct weston_output *output);
Alex Wu2dda6042012-04-17 17:20:47 +0800224 int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
Tiago Vignatti8e53c7f2012-02-29 19:53:50 +0200225
Tiago Vignatti5ab91ad2012-03-12 19:40:09 -0300226 /* backlight values are on 0-255 range, where higher is brighter */
Kristian Høgsberg7c609122013-05-23 20:30:26 -0400227 int32_t backlight_current;
Tiago Vignatti8e53c7f2012-02-29 19:53:50 +0200228 void (*set_backlight)(struct weston_output *output, uint32_t value);
229 void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
Richard Hughese7299962013-05-01 21:52:12 +0100230
Richard Hughesb24e48e2013-05-09 20:31:09 +0100231 int connection_internal;
Richard Hughese7299962013-05-01 21:52:12 +0100232 uint16_t gamma_size;
233 void (*set_gamma)(struct weston_output *output,
234 uint16_t size,
235 uint16_t *r,
236 uint16_t *g,
237 uint16_t *b);
Pekka Paalanenb5026542014-11-12 15:09:24 +0200238
239 struct weston_timeline_object timeline;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500240};
241
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400242struct weston_pointer_grab;
243struct weston_pointer_grab_interface {
Kristian Høgsberg6848c252013-05-08 22:02:59 -0400244 void (*focus)(struct weston_pointer_grab *grab);
Giulio Camuffo1959ab82013-11-14 23:42:52 +0100245 void (*motion)(struct weston_pointer_grab *grab, uint32_t time,
246 wl_fixed_t x, wl_fixed_t y);
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400247 void (*button)(struct weston_pointer_grab *grab,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400248 uint32_t time, uint32_t button, uint32_t state);
Jonas Ådahl1ea343e2013-10-25 23:18:05 +0200249 void (*cancel)(struct weston_pointer_grab *grab);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400250};
251
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400252struct weston_pointer_grab {
253 const struct weston_pointer_grab_interface *interface;
254 struct weston_pointer *pointer;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400255};
256
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400257struct weston_keyboard_grab;
258struct weston_keyboard_grab_interface {
259 void (*key)(struct weston_keyboard_grab *grab, uint32_t time,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400260 uint32_t key, uint32_t state);
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400261 void (*modifiers)(struct weston_keyboard_grab *grab, uint32_t serial,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400262 uint32_t mods_depressed, uint32_t mods_latched,
263 uint32_t mods_locked, uint32_t group);
Jonas Ådahl1ea343e2013-10-25 23:18:05 +0200264 void (*cancel)(struct weston_keyboard_grab *grab);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400265};
266
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400267struct weston_keyboard_grab {
268 const struct weston_keyboard_grab_interface *interface;
269 struct weston_keyboard *keyboard;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400270};
271
Kristian Høgsberge329f362013-05-06 22:19:57 -0400272struct weston_touch_grab;
273struct weston_touch_grab_interface {
274 void (*down)(struct weston_touch_grab *grab,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400275 uint32_t time,
276 int touch_id,
277 wl_fixed_t sx,
278 wl_fixed_t sy);
Kristian Høgsberge329f362013-05-06 22:19:57 -0400279 void (*up)(struct weston_touch_grab *grab,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400280 uint32_t time,
281 int touch_id);
Kristian Høgsberge329f362013-05-06 22:19:57 -0400282 void (*motion)(struct weston_touch_grab *grab,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400283 uint32_t time,
284 int touch_id,
285 wl_fixed_t sx,
286 wl_fixed_t sy);
Jonas Ådahl1679f232014-04-12 09:39:51 +0200287 void (*frame)(struct weston_touch_grab *grab);
Jonas Ådahl1ea343e2013-10-25 23:18:05 +0200288 void (*cancel)(struct weston_touch_grab *grab);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400289};
290
Kristian Høgsberge329f362013-05-06 22:19:57 -0400291struct weston_touch_grab {
292 const struct weston_touch_grab_interface *interface;
293 struct weston_touch *touch;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400294};
295
Kristian Høgsberg5e76a492013-07-25 16:09:37 -0700296struct weston_data_offer {
Jason Ekstrand8a4a9eb2013-06-14 10:07:55 -0500297 struct wl_resource *resource;
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700298 struct weston_data_source *source;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400299 struct wl_listener source_destroy_listener;
300};
301
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700302struct weston_data_source {
Jason Ekstrand8a4a9eb2013-06-14 10:07:55 -0500303 struct wl_resource *resource;
304 struct wl_signal destroy_signal;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400305 struct wl_array mime_types;
306
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700307 void (*accept)(struct weston_data_source *source,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400308 uint32_t serial, const char *mime_type);
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700309 void (*send)(struct weston_data_source *source,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400310 const char *mime_type, int32_t fd);
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700311 void (*cancel)(struct weston_data_source *source);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400312};
313
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400314struct weston_pointer {
Kristian Høgsberge3148752013-05-06 23:19:49 -0400315 struct weston_seat *seat;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400316
317 struct wl_list resource_list;
Neil Roberts96d790e2013-09-19 17:32:00 +0100318 struct wl_list focus_resource_list;
Jason Ekstranda7af7042013-10-12 22:38:11 -0500319 struct weston_view *focus;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400320 uint32_t focus_serial;
Giulio Camuffo576fe2a2013-11-20 18:00:24 +0100321 struct wl_listener focus_view_listener;
322 struct wl_listener focus_resource_listener;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400323 struct wl_signal focus_signal;
Giulio Camuffo6fcb3782013-11-14 23:42:50 +0100324 struct wl_signal motion_signal;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400325
Jason Ekstranda7af7042013-10-12 22:38:11 -0500326 struct weston_view *sprite;
Kristian Høgsberg195b8692013-05-08 15:02:05 -0400327 struct wl_listener sprite_destroy_listener;
328 int32_t hotspot_x, hotspot_y;
329
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400330 struct weston_pointer_grab *grab;
331 struct weston_pointer_grab default_grab;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400332 wl_fixed_t grab_x, grab_y;
333 uint32_t grab_button;
334 uint32_t grab_serial;
335 uint32_t grab_time;
336
337 wl_fixed_t x, y;
Kristian Høgsbergdb1fccb2014-02-05 17:14:42 -0800338 wl_fixed_t sx, sy;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400339 uint32_t button_count;
Ander Conselvan de Oliveiraf84327a2014-01-29 18:47:51 +0200340
341 struct wl_listener output_destroy_listener;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400342};
343
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400344
Kristian Høgsberge329f362013-05-06 22:19:57 -0400345struct weston_touch {
Kristian Høgsberge3148752013-05-06 23:19:49 -0400346 struct weston_seat *seat;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400347
348 struct wl_list resource_list;
Neil Roberts96d790e2013-09-19 17:32:00 +0100349 struct wl_list focus_resource_list;
Jason Ekstranda7af7042013-10-12 22:38:11 -0500350 struct weston_view *focus;
Giulio Camuffo576fe2a2013-11-20 18:00:24 +0100351 struct wl_listener focus_view_listener;
352 struct wl_listener focus_resource_listener;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400353 uint32_t focus_serial;
354 struct wl_signal focus_signal;
355
Jonas Ådahl9484b692013-12-02 22:05:03 +0100356 uint32_t num_tp;
357
Kristian Høgsberge329f362013-05-06 22:19:57 -0400358 struct weston_touch_grab *grab;
359 struct weston_touch_grab default_grab;
Neil Roberts306fe082013-10-03 16:43:06 +0100360 int grab_touch_id;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400361 wl_fixed_t grab_x, grab_y;
362 uint32_t grab_serial;
363 uint32_t grab_time;
364};
365
Kristian Høgsberga4036bb2013-05-07 23:52:07 -0400366struct weston_pointer *
Giulio Camuffocdb4d292013-11-14 23:42:53 +0100367weston_pointer_create(struct weston_seat *seat);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400368void
Kristian Høgsberga4036bb2013-05-07 23:52:07 -0400369weston_pointer_destroy(struct weston_pointer *pointer);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400370void
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400371weston_pointer_set_focus(struct weston_pointer *pointer,
Jason Ekstranda7af7042013-10-12 22:38:11 -0500372 struct weston_view *view,
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400373 wl_fixed_t sx, wl_fixed_t sy);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400374void
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400375weston_pointer_start_grab(struct weston_pointer *pointer,
376 struct weston_pointer_grab *grab);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400377void
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400378weston_pointer_end_grab(struct weston_pointer *pointer);
Rob Bradford806d8c02013-06-25 18:56:41 +0100379void
380weston_pointer_clamp(struct weston_pointer *pointer,
381 wl_fixed_t *fx, wl_fixed_t *fy);
Giulio Camuffo1959ab82013-11-14 23:42:52 +0100382void
383weston_pointer_move(struct weston_pointer *pointer,
384 wl_fixed_t x, wl_fixed_t y);
Giulio Camuffocdb4d292013-11-14 23:42:53 +0100385void
386weston_pointer_set_default_grab(struct weston_pointer *pointer,
387 const struct weston_pointer_grab_interface *interface);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400388
Kristian Høgsberga4036bb2013-05-07 23:52:07 -0400389struct weston_keyboard *
390weston_keyboard_create(void);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400391void
Kristian Høgsberga4036bb2013-05-07 23:52:07 -0400392weston_keyboard_destroy(struct weston_keyboard *keyboard);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400393void
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400394weston_keyboard_set_focus(struct weston_keyboard *keyboard,
Kristian Høgsbergfe7aa902013-05-08 09:54:37 -0400395 struct weston_surface *surface);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400396void
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400397weston_keyboard_start_grab(struct weston_keyboard *device,
398 struct weston_keyboard_grab *grab);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400399void
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400400weston_keyboard_end_grab(struct weston_keyboard *keyboard);
Giulio Camuffo6ef444d2014-08-28 19:44:09 +0300401int
402/*
403 * 'mask' and 'value' should be a bitwise mask of one or more
404 * valued of the weston_keyboard_locks enum.
405 */
406weston_keyboard_set_locks(struct weston_keyboard *keyboard,
407 uint32_t mask, uint32_t value);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400408
Kristian Høgsberga4036bb2013-05-07 23:52:07 -0400409struct weston_touch *
410weston_touch_create(void);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400411void
Kristian Høgsberga4036bb2013-05-07 23:52:07 -0400412weston_touch_destroy(struct weston_touch *touch);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400413void
Michael Fua2bb7912013-07-23 15:51:06 +0800414weston_touch_set_focus(struct weston_seat *seat,
Jason Ekstranda7af7042013-10-12 22:38:11 -0500415 struct weston_view *view);
Michael Fua2bb7912013-07-23 15:51:06 +0800416void
Kristian Høgsberge329f362013-05-06 22:19:57 -0400417weston_touch_start_grab(struct weston_touch *device,
418 struct weston_touch_grab *grab);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400419void
Kristian Høgsberge329f362013-05-06 22:19:57 -0400420weston_touch_end_grab(struct weston_touch *touch);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400421
422void
Kristian Høgsberge3148752013-05-06 23:19:49 -0400423wl_data_device_set_keyboard_focus(struct weston_seat *seat);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400424
425int
426wl_data_device_manager_init(struct wl_display *display);
427
428
429void
Kristian Høgsberge3148752013-05-06 23:19:49 -0400430weston_seat_set_selection(struct weston_seat *seat,
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700431 struct weston_data_source *source, uint32_t serial);
Kristian Høgsberg85de9c22013-09-04 20:44:26 -0700432int
Xiong Zhangfd51e7b2013-11-25 18:42:49 +0800433weston_pointer_start_drag(struct weston_pointer *pointer,
Kristian Høgsberg85de9c22013-09-04 20:44:26 -0700434 struct weston_data_source *source,
435 struct weston_surface *icon,
436 struct wl_client *client);
Xiong Zhangfd51e7b2013-11-25 18:42:49 +0800437int
438weston_touch_start_drag(struct weston_touch *touch,
439 struct weston_data_source *source,
440 struct weston_surface *icon,
441 struct wl_client *client);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400442
Daniel Stoned65b9092012-05-30 16:32:05 +0100443struct weston_xkb_info {
444 struct xkb_keymap *keymap;
Daniel Stoneb7452fe2012-06-01 12:14:06 +0100445 int keymap_fd;
446 size_t keymap_size;
447 char *keymap_area;
Andrew Wedgbury9a6f02a2013-09-05 13:31:40 +0000448 int32_t ref_count;
Daniel Stoneabb9dcd2012-06-22 13:21:33 +0100449 xkb_mod_index_t shift_mod;
450 xkb_mod_index_t caps_mod;
Daniel Stoned65b9092012-05-30 16:32:05 +0100451 xkb_mod_index_t ctrl_mod;
452 xkb_mod_index_t alt_mod;
Daniel Stoneabb9dcd2012-06-22 13:21:33 +0100453 xkb_mod_index_t mod2_mod;
454 xkb_mod_index_t mod3_mod;
Daniel Stoned65b9092012-05-30 16:32:05 +0100455 xkb_mod_index_t super_mod;
Daniel Stoneabb9dcd2012-06-22 13:21:33 +0100456 xkb_mod_index_t mod5_mod;
Daniel Stoned65b9092012-05-30 16:32:05 +0100457 xkb_led_index_t num_led;
458 xkb_led_index_t caps_led;
459 xkb_led_index_t scroll_led;
460};
461
Jan Arne Petersena75a7892013-01-16 21:26:50 +0100462struct weston_keyboard {
Kristian Høgsberge3148752013-05-06 23:19:49 -0400463 struct weston_seat *seat;
Jan Arne Petersena75a7892013-01-16 21:26:50 +0100464
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400465 struct wl_list resource_list;
Neil Roberts96d790e2013-09-19 17:32:00 +0100466 struct wl_list focus_resource_list;
Kristian Høgsbergfe7aa902013-05-08 09:54:37 -0400467 struct weston_surface *focus;
Giulio Camuffo576fe2a2013-11-20 18:00:24 +0100468 struct wl_listener focus_resource_listener;
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400469 uint32_t focus_serial;
470 struct wl_signal focus_signal;
471
472 struct weston_keyboard_grab *grab;
473 struct weston_keyboard_grab default_grab;
474 uint32_t grab_key;
475 uint32_t grab_serial;
476 uint32_t grab_time;
477
478 struct wl_array keys;
479
480 struct {
481 uint32_t mods_depressed;
482 uint32_t mods_latched;
483 uint32_t mods_locked;
484 uint32_t group;
485 } modifiers;
486
487 struct weston_keyboard_grab input_method_grab;
Jan Arne Petersena75a7892013-01-16 21:26:50 +0100488 struct wl_resource *input_method_resource;
Jonas Ådahl7395ea02013-12-03 09:14:26 +0100489
490 struct weston_xkb_info *xkb_info;
491 struct {
492 struct xkb_state *state;
493 enum weston_led leds;
494 } xkb_state;
495 struct xkb_keymap *pending_keymap;
Jan Arne Petersena75a7892013-01-16 21:26:50 +0100496};
497
Daniel Stone37816df2012-05-16 18:45:18 +0100498struct weston_seat {
Kristian Høgsberge3148752013-05-06 23:19:49 -0400499 struct wl_list base_resource_list;
500
Kristian Høgsbergaaadc772013-07-08 16:20:31 -0400501 struct wl_global *global;
Kristian Høgsberge3148752013-05-06 23:19:49 -0400502 struct weston_pointer *pointer;
503 struct weston_keyboard *keyboard;
504 struct weston_touch *touch;
Jonas Ådahld6e1c342013-10-17 23:04:05 +0200505 int pointer_device_count;
506 int keyboard_device_count;
507 int touch_device_count;
Kristian Høgsberge3148752013-05-06 23:19:49 -0400508
Rob Bradford66bd9f52013-06-25 18:56:42 +0100509 struct weston_output *output; /* constraint */
510
Giulio Camuffo5085a752013-03-25 21:42:45 +0100511 struct wl_signal destroy_signal;
Jason Ekstranda4ab5422014-04-02 19:53:45 -0500512 struct wl_signal updated_caps_signal;
Daniel Stone74419a22012-05-30 16:32:02 +0100513
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500514 struct weston_compositor *compositor;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500515 struct wl_list link;
Daniel Stone496ca172012-05-30 16:31:42 +0100516 enum weston_keyboard_modifier modifier_state;
Kristian Høgsbergfe7aa902013-05-08 09:54:37 -0400517 struct weston_surface *saved_kbd_focus;
Ander Conselvan de Oliveira71b1d0c2012-03-16 17:25:11 +0200518 struct wl_listener saved_kbd_focus_listener;
Kristian Høgsberg054c50a2013-05-08 15:27:47 -0400519 struct wl_list drag_resource_list;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500520
Kristian Høgsberge3148752013-05-06 23:19:49 -0400521 uint32_t selection_serial;
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700522 struct weston_data_source *selection_data_source;
Kristian Høgsberge3148752013-05-06 23:19:49 -0400523 struct wl_listener selection_data_source_listener;
524 struct wl_signal selection_signal;
525
Daniel Stone8c8164f2012-05-30 16:31:45 +0100526 void (*led_update)(struct weston_seat *ws, enum weston_led leds);
527
Kristian Høgsberg2fce4802014-01-08 16:21:24 -0800528 uint32_t slot_map;
Jan Arne Petersene829adc2012-08-10 16:47:22 +0200529 struct input_method *input_method;
Rob Bradford9af5f9e2013-05-31 18:09:50 +0100530 char *seat_name;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500531};
532
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500533enum {
534 WESTON_COMPOSITOR_ACTIVE,
535 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
Philipp Brüschweiler57edf7f2013-03-29 13:01:56 +0100536 WESTON_COMPOSITOR_OFFSCREEN, /* no rendering, no frame events */
537 WESTON_COMPOSITOR_SLEEPING /* same as offscreen, but also set dmps
538 * to off */
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500539};
540
Giulio Camuffo412e6a52014-07-09 22:12:56 +0300541struct weston_layer_entry {
542 struct wl_list link;
543 struct weston_layer *layer;
544};
545
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -0500546struct weston_layer {
Giulio Camuffo412e6a52014-07-09 22:12:56 +0300547 struct weston_layer_entry view_list;
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -0500548 struct wl_list link;
Giulio Camuffo95ec0f92014-07-09 22:12:57 +0300549 pixman_box32_t mask;
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -0500550};
551
Kristian Høgsberg65a11e12012-08-03 11:30:18 -0400552struct weston_plane {
Xiong Zhang97116532013-10-23 13:58:31 +0800553 struct weston_compositor *compositor;
Kristian Høgsberg65a11e12012-08-03 11:30:18 -0400554 pixman_region32_t damage;
Ander Conselvan de Oliveirae1bd5a02013-03-05 17:30:29 +0200555 pixman_region32_t clip;
Kristian Høgsberg65a11e12012-08-03 11:30:18 -0400556 int32_t x, y;
Ander Conselvan de Oliveira8ad19822013-03-05 17:30:27 +0200557 struct wl_list link;
Kristian Høgsberg65a11e12012-08-03 11:30:18 -0400558};
559
Kristian Høgsbergfa1be022012-09-05 22:49:55 -0400560struct weston_renderer {
John Kåre Alsakera95b2d62012-11-13 19:10:21 +0100561 int (*read_pixels)(struct weston_output *output,
562 pixman_format_code_t format, void *pixels,
563 uint32_t x, uint32_t y,
564 uint32_t width, uint32_t height);
Kristian Høgsbergfa1be022012-09-05 22:49:55 -0400565 void (*repaint_output)(struct weston_output *output,
566 pixman_region32_t *output_damage);
567 void (*flush_damage)(struct weston_surface *surface);
Jason Ekstrand6bd62942013-06-20 20:38:23 -0500568 void (*attach)(struct weston_surface *es, struct weston_buffer *buffer);
John Kåre Alsaker878f4492012-11-13 19:10:23 +0100569 void (*surface_set_color)(struct weston_surface *surface,
570 float red, float green,
571 float blue, float alpha);
Vasily Khoruzhick52cfd612013-01-08 19:09:01 +0300572 void (*destroy)(struct weston_compositor *ec);
Kristian Høgsbergfa1be022012-09-05 22:49:55 -0400573};
574
Pekka Paalanen7bb65102013-05-22 18:03:04 +0300575enum weston_capability {
576 /* backend/renderer supports arbitrary rotation */
577 WESTON_CAP_ROTATION_ANY = 0x0001,
Pekka Paalanen4fc5dd02013-05-22 18:03:05 +0300578
579 /* screencaptures need to be y-flipped */
580 WESTON_CAP_CAPTURE_YFLIP = 0x0002,
Jason Ekstrand9fc71512014-04-02 19:53:46 -0500581
582 /* backend/renderer has a seperate cursor plane */
583 WESTON_CAP_CURSOR_PLANE = 0x0004,
584
585 /* backend supports setting arbitrary resolutions */
586 WESTON_CAP_ARBITRARY_MODES = 0x0008,
Pekka Paalanen7bb65102013-05-22 18:03:04 +0300587};
588
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500589struct weston_compositor {
Kristian Høgsberg02e79dc2012-04-12 09:55:26 -0400590 struct wl_signal destroy_signal;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500591
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500592 struct wl_display *wl_display;
Tiago Vignattibc052c92012-04-19 16:18:18 +0300593 struct weston_shell_interface shell_interface;
Kristian Høgsberg73274712013-04-01 12:41:23 -0400594 struct weston_config *config;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500595
Tiago Vignattifb2adba2013-06-12 15:43:21 -0300596 /* surface signals */
Kristian Høgsbergf03a04a2014-04-06 22:04:50 -0700597 struct wl_signal create_surface_signal;
Kristian Høgsberg02e79dc2012-04-12 09:55:26 -0400598 struct wl_signal activate_signal;
Tiago Vignattifb2adba2013-06-12 15:43:21 -0300599 struct wl_signal transform_signal;
600
Tiago Vignatti1d01b012012-09-27 17:48:36 +0300601 struct wl_signal kill_signal;
Ander Conselvan de Oliveiraa4575632013-02-21 18:35:23 +0200602 struct wl_signal idle_signal;
603 struct wl_signal wake_signal;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500604
Jan Arne Petersen42feced2012-06-21 21:52:17 +0200605 struct wl_signal show_input_panel_signal;
606 struct wl_signal hide_input_panel_signal;
Jan Arne Petersen14da96b2013-04-18 16:47:28 +0200607 struct wl_signal update_input_panel_signal;
Jan Arne Petersen42feced2012-06-21 21:52:17 +0200608
Jan Arne Petersen674fd1d2012-11-18 19:06:42 +0100609 struct wl_signal seat_created_signal;
Richard Hughes59d5da72013-05-01 21:52:11 +0100610 struct wl_signal output_created_signal;
Ander Conselvan de Oliveiraf84327a2014-01-29 18:47:51 +0200611 struct wl_signal output_destroyed_signal;
Ander Conselvan de Oliveiraa8a9baf2014-01-29 18:47:52 +0200612 struct wl_signal output_moved_signal;
Jan Arne Petersen674fd1d2012-11-18 19:06:42 +0100613
Kristian Høgsberg7ea10862012-03-05 17:49:30 -0500614 struct wl_event_loop *input_loop;
615 struct wl_event_source *input_loop_source;
616
Kristian Høgsberg61741a22013-09-17 16:02:57 -0700617 struct wl_signal session_signal;
618 int session_active;
619
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -0500620 struct weston_layer fade_layer;
621 struct weston_layer cursor_layer;
622
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500623 struct wl_list output_list;
Daniel Stone37816df2012-05-16 18:45:18 +0100624 struct wl_list seat_list;
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -0500625 struct wl_list layer_list;
Jason Ekstranda7af7042013-10-12 22:38:11 -0500626 struct wl_list view_list;
Ander Conselvan de Oliveira8ad19822013-03-05 17:30:27 +0200627 struct wl_list plane_list;
Daniel Stone325fc2d2012-05-30 16:31:58 +0100628 struct wl_list key_binding_list;
Daniel Stone96d47c02013-11-19 11:37:12 +0100629 struct wl_list modifier_binding_list;
Daniel Stone325fc2d2012-05-30 16:31:58 +0100630 struct wl_list button_binding_list;
Neil Robertsa28c6932013-10-03 16:43:04 +0100631 struct wl_list touch_binding_list;
Daniel Stone325fc2d2012-05-30 16:31:58 +0100632 struct wl_list axis_binding_list;
Ander Conselvan de Oliveirac509d2b2012-11-08 17:20:45 +0200633 struct wl_list debug_binding_list;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500634
635 uint32_t state;
636 struct wl_event_source *idle_source;
637 uint32_t idle_inhibit;
Philipp Brüschweiler4b409c32013-03-10 14:37:04 +0100638 int idle_time; /* timeout, s */
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500639
Giulio Camuffocdb4d292013-11-14 23:42:53 +0100640 const struct weston_pointer_grab_interface *default_pointer_grab;
641
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500642 /* Repaint state. */
Kristian Høgsberg65a11e12012-08-03 11:30:18 -0400643 struct weston_plane primary_plane;
Pekka Paalanen7bb65102013-05-22 18:03:04 +0300644 uint32_t capabilities; /* combination of enum weston_capability */
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500645
Kristian Høgsbergfa1be022012-09-05 22:49:55 -0400646 struct weston_renderer *renderer;
647
John Kåre Alsakerf9e710b2012-11-13 19:10:22 +0100648 pixman_format_code_t read_format;
Pekka Paalanen52bfbaa2012-04-11 16:19:37 +0300649
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500650 void (*destroy)(struct weston_compositor *ec);
Kristian Høgsberg7b884bc2012-07-31 14:32:01 -0400651 void (*restore)(struct weston_compositor *ec);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500652 int (*authenticate)(struct weston_compositor *c, uint32_t id);
Kristian Høgsberg3466bc82012-01-03 11:29:15 -0500653
Kristian Høgsberg05ad1e42013-09-17 14:41:03 -0700654 struct weston_launcher *launcher;
Casey Dahlin58ba1372012-04-19 22:50:08 -0400655
656 uint32_t output_id_pool;
Daniel Stone855028f2012-05-01 20:37:10 +0100657
Daniel Stonee379da92012-05-30 16:32:04 +0100658 struct xkb_rule_names xkb_names;
659 struct xkb_context *xkb_context;
Andrew Wedgbury9a6f02a2013-09-05 13:31:40 +0000660 struct weston_xkb_info *xkb_info;
Matt Roper01a92732013-06-24 16:52:44 +0100661
662 /* Raw keyboard processing (no libxkbcommon initialization or handling) */
663 int use_xkbcommon;
Jonny Lamb66a41a02014-08-12 14:58:25 +0200664
665 int32_t kb_repeat_rate;
666 int32_t kb_repeat_delay;
Pekka Paalanenb5eedad2014-09-23 22:08:45 -0400667
668 clockid_t presentation_clock;
Frederic Plourdec336f062014-10-29 14:44:33 -0400669
670 int exit_code;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500671};
672
Jason Ekstrand6bd62942013-06-20 20:38:23 -0500673struct weston_buffer {
674 struct wl_resource *resource;
675 struct wl_signal destroy_signal;
676 struct wl_listener destroy_listener;
677
678 union {
679 struct wl_shm_buffer *shm_buffer;
Jason Ekstranda85118c2013-06-27 20:17:02 -0500680 void *legacy_buffer;
Jason Ekstrand6bd62942013-06-20 20:38:23 -0500681 };
682 int32_t width, height;
683 uint32_t busy_count;
Stanislav Vorobiovbfbb8e52013-08-29 11:36:44 +0400684 int y_inverted;
Jason Ekstrand6bd62942013-06-20 20:38:23 -0500685};
686
Pekka Paalanende685b82012-12-04 15:58:12 +0200687struct weston_buffer_reference {
Jason Ekstrand6bd62942013-06-20 20:38:23 -0500688 struct weston_buffer *buffer;
Pekka Paalanende685b82012-12-04 15:58:12 +0200689 struct wl_listener destroy_listener;
690};
691
Pekka Paalanen1fd9c0f2013-11-26 18:19:41 +0100692struct weston_buffer_viewport {
Pekka Paalanen952b6c82014-03-14 14:38:15 +0200693 struct {
694 /* wl_surface.set_buffer_transform */
695 uint32_t transform;
Pekka Paalanen1fd9c0f2013-11-26 18:19:41 +0100696
Pekka Paalanen952b6c82014-03-14 14:38:15 +0200697 /* wl_surface.set_scaling_factor */
698 int32_t scale;
Jonny Lamb74130762013-11-26 18:19:46 +0100699
Pekka Paalanenf0cad482014-03-14 14:38:16 +0200700 /*
701 * If src_width != wl_fixed_from_int(-1),
702 * then and only then src_* are used.
703 */
Pekka Paalanen952b6c82014-03-14 14:38:15 +0200704 wl_fixed_t src_x, src_y;
705 wl_fixed_t src_width, src_height;
706 } buffer;
707
708 struct {
Pekka Paalanenf0cad482014-03-14 14:38:16 +0200709 /*
710 * If width == -1, the size is inferred from the buffer.
711 */
Pekka Paalanen952b6c82014-03-14 14:38:15 +0200712 int32_t width, height;
713 } surface;
George Kiagiadakis8f9e87f2014-06-13 18:14:20 +0200714
715 int changed;
Pekka Paalanen1fd9c0f2013-11-26 18:19:41 +0100716};
717
Kristian Høgsberg5e7e6f22012-02-23 16:11:59 -0500718struct weston_region {
Jason Ekstrand8895efc2013-06-14 10:07:56 -0500719 struct wl_resource *resource;
Kristian Høgsberg5e7e6f22012-02-23 16:11:59 -0500720 pixman_region32_t region;
721};
722
Jason Ekstranda7af7042013-10-12 22:38:11 -0500723/* Using weston_view transformations
Pekka Paalanen44ab69c2012-02-07 13:18:00 +0200724 *
Jason Ekstranda7af7042013-10-12 22:38:11 -0500725 * To add a transformation to a view, create a struct weston_transform, and
726 * add it to the list view->geometry.transformation_list. Whenever you
727 * change the list, anything under view->geometry, or anything in the
Pekka Paalanenc3ce7382013-03-08 14:56:49 +0200728 * weston_transforms linked into the list, you must call
Jason Ekstranda7af7042013-10-12 22:38:11 -0500729 * weston_view_geometry_dirty().
Pekka Paalanen44ab69c2012-02-07 13:18:00 +0200730 *
731 * The order in the list defines the order of transformations. Let the list
732 * contain the transformation matrices M1, ..., Mn as head to tail. The
Jason Ekstranda7af7042013-10-12 22:38:11 -0500733 * transformation is applied to view-local coordinate vector p as
Pekka Paalanen44ab69c2012-02-07 13:18:00 +0200734 * P = Mn * ... * M2 * M1 * p
735 * to produce the global coordinate vector P. The total transform
736 * Mn * ... * M2 * M1
Jason Ekstranda7af7042013-10-12 22:38:11 -0500737 * is cached in view->transform.matrix, and the inverse of it in
738 * view->transform.inverse.
Pekka Paalanen44ab69c2012-02-07 13:18:00 +0200739 *
Jason Ekstranda7af7042013-10-12 22:38:11 -0500740 * The list always contains view->transform.position transformation, which
741 * is the translation by view->geometry.x and y.
Pekka Paalanen44ab69c2012-02-07 13:18:00 +0200742 *
743 * If you want to apply a transformation in local coordinates, add your
744 * weston_transform to the head of the list. If you want to apply a
745 * transformation in global coordinates, add it to the tail of the list.
Pekka Paalanen483243f2013-03-08 14:56:50 +0200746 *
Jason Ekstranda7af7042013-10-12 22:38:11 -0500747 * If view->geometry.parent is set, the total transformation of this
748 * view will be the parent's total transformation and this transformation
Pekka Paalanen483243f2013-03-08 14:56:50 +0200749 * combined:
750 * Mparent * Mn * ... * M2 * M1
Pekka Paalanen44ab69c2012-02-07 13:18:00 +0200751 */
752
Jason Ekstranda7af7042013-10-12 22:38:11 -0500753struct weston_view {
754 struct weston_surface *surface;
755 struct wl_list surface_link;
Jason Ekstrand26ed73c2013-06-06 22:34:41 -0500756 struct wl_signal destroy_signal;
Jason Ekstranda7af7042013-10-12 22:38:11 -0500757
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500758 struct wl_list link;
Giulio Camuffo412e6a52014-07-09 22:12:56 +0300759 struct weston_layer_entry layer_link;
Kristian Høgsberg65a11e12012-08-03 11:30:18 -0400760 struct weston_plane *plane;
Giulio Camuffo95ec0f92014-07-09 22:12:57 +0300761 struct weston_view *parent_view;
Jason Ekstranda7af7042013-10-12 22:38:11 -0500762
763 pixman_region32_t clip;
764 float alpha; /* part of geometry, see below */
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500765
John Kåre Alsaker878f4492012-11-13 19:10:23 +0100766 void *renderer_state;
767
Pekka Paalanenbc0b7e72012-01-24 09:53:37 +0200768 /* Surface geometry state, mutable.
Pekka Paalanenc3ce7382013-03-08 14:56:49 +0200769 * If you change anything, call weston_surface_geometry_dirty().
Pekka Paalanenbc0b7e72012-01-24 09:53:37 +0200770 * That includes the transformations referenced from the list.
771 */
Pekka Paalanenc61eca62012-01-06 14:10:06 +0200772 struct {
John Kåre Alsaker490d02a2012-09-30 02:57:21 +0200773 float x, y; /* surface translation on display */
Pekka Paalanenba3cf952012-01-25 16:22:05 +0200774
Pekka Paalanenbc0b7e72012-01-24 09:53:37 +0200775 /* struct weston_transform */
776 struct wl_list transformation_list;
Pekka Paalanen483243f2013-03-08 14:56:50 +0200777
778 /* managed by weston_surface_set_transform_parent() */
Jason Ekstranda7af7042013-10-12 22:38:11 -0500779 struct weston_view *parent;
Pekka Paalanen483243f2013-03-08 14:56:50 +0200780 struct wl_listener parent_destroy_listener;
781 struct wl_list child_list; /* geometry.parent_link */
782 struct wl_list parent_link;
Pekka Paalanenbc0b7e72012-01-24 09:53:37 +0200783 } geometry;
784
785 /* State derived from geometry state, read-only.
Jason Ekstranda7af7042013-10-12 22:38:11 -0500786 * This is updated by weston_view_update_transform().
Pekka Paalanenbc0b7e72012-01-24 09:53:37 +0200787 */
788 struct {
Pekka Paalanenc3ce7382013-03-08 14:56:49 +0200789 int dirty;
790
Pekka Paalanen6720d8f2012-01-25 15:17:40 +0200791 pixman_region32_t boundingbox;
Pekka Paalanen730d87e2012-02-09 16:39:38 +0200792 pixman_region32_t opaque;
Giulio Camuffo95ec0f92014-07-09 22:12:57 +0300793 pixman_region32_t masked_boundingbox;
794 pixman_region32_t masked_opaque;
Pekka Paalanen6720d8f2012-01-25 15:17:40 +0200795
Pekka Paalanenbc0b7e72012-01-24 09:53:37 +0200796 /* matrix and inverse are used only if enabled = 1.
797 * If enabled = 0, use x, y, width, height directly.
798 */
799 int enabled;
Pekka Paalanen061b7472012-01-12 15:00:57 +0200800 struct weston_matrix matrix;
Pekka Paalanend1f0ab62012-01-20 10:47:57 +0200801 struct weston_matrix inverse;
Pekka Paalanencd403622012-01-25 13:37:39 +0200802
803 struct weston_transform position; /* matrix from x, y */
Pekka Paalanenc61eca62012-01-06 14:10:06 +0200804 } transform;
805
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500806 /*
807 * Which output to vsync this surface to.
808 * Used to determine, whether to send or queue frame events.
809 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
810 */
811 struct weston_output *output;
812
Casey Dahlin9074db52012-04-19 22:50:09 -0400813 /*
814 * A more complete representation of all outputs this surface is
815 * displayed on.
816 */
817 uint32_t output_mask;
Jason Ekstranda7af7042013-10-12 22:38:11 -0500818};
819
Jason Ekstrand7b982072014-05-20 14:33:03 -0500820struct weston_surface_state {
821 /* wl_surface.attach */
822 int newly_attached;
823 struct weston_buffer *buffer;
824 struct wl_listener buffer_destroy_listener;
825 int32_t sx;
826 int32_t sy;
827
828 /* wl_surface.damage */
829 pixman_region32_t damage;
830
831 /* wl_surface.set_opaque_region */
832 pixman_region32_t opaque;
833
834 /* wl_surface.set_input_region */
835 pixman_region32_t input;
836
837 /* wl_surface.frame */
838 struct wl_list frame_callback_list;
839
Pekka Paalanen133e4392014-09-23 22:08:46 -0400840 /* presentation.feedback */
841 struct wl_list feedback_list;
842
Jason Ekstrand7b982072014-05-20 14:33:03 -0500843 /* wl_surface.set_buffer_transform */
844 /* wl_surface.set_scaling_factor */
845 /* wl_viewport.set */
846 struct weston_buffer_viewport buffer_viewport;
847};
848
Jason Ekstranda7af7042013-10-12 22:38:11 -0500849struct weston_surface {
850 struct wl_resource *resource;
851 struct wl_signal destroy_signal;
852 struct weston_compositor *compositor;
853 pixman_region32_t damage;
854 pixman_region32_t opaque; /* part of geometry, see below */
855 pixman_region32_t input;
856 int32_t width, height;
857 int32_t ref_count;
858
859 /* Not for long-term storage. This exists for book-keeping while
860 * iterating over surfaces and views
861 */
862 int32_t touched;
863
864 void *renderer_state;
865
866 struct wl_list views;
867
868 /*
869 * Which output to vsync this surface to.
870 * Used to determine, whether to send or queue frame events.
871 * Must be NULL, if 'link' is not in weston_compositor::surface_list.
872 */
873 struct weston_output *output;
874
875 /*
876 * A more complete representation of all outputs this surface is
877 * displayed on.
878 */
879 uint32_t output_mask;
Casey Dahlin9074db52012-04-19 22:50:09 -0400880
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500881 struct wl_list frame_callback_list;
Pekka Paalanen133e4392014-09-23 22:08:46 -0400882 struct wl_list feedback_list;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500883
Pekka Paalanende685b82012-12-04 15:58:12 +0200884 struct weston_buffer_reference buffer_ref;
Pekka Paalanen1fd9c0f2013-11-26 18:19:41 +0100885 struct weston_buffer_viewport buffer_viewport;
Pekka Paalanen0b4c5352014-03-14 14:38:17 +0200886 int32_t width_from_buffer; /* before applying viewport */
887 int32_t height_from_buffer;
Derek Foreman0fd6d4e2014-10-10 09:36:45 -0500888 bool keep_buffer; /* for backends to prevent early release */
Alex Wu8811bf92012-02-28 18:07:54 +0800889
Pekka Paalanenb0420ae2014-01-08 15:39:17 +0200890 /* wl_viewport resource for this surface */
891 struct wl_resource *viewport_resource;
Jonny Lamb74130762013-11-26 18:19:46 +0100892
Pekka Paalanen5df44de2012-10-10 12:49:23 +0300893 /* All the pending state, that wl_surface.commit will apply. */
Jason Ekstrand7b982072014-05-20 14:33:03 -0500894 struct weston_surface_state pending;
Pekka Paalanen5df44de2012-10-10 12:49:23 +0300895
Ander Conselvan de Oliveira093bfa32012-03-27 17:36:41 +0300896 /*
Jasper St. Pierred67b52a2014-04-28 11:19:27 -0400897 * If non-NULL, this function will be called on
898 * wl_surface::commit after a new buffer has been set up for
899 * this surface. The integer params are the sx and sy
900 * parameters supplied to wl_surface::attach.
Ander Conselvan de Oliveira093bfa32012-03-27 17:36:41 +0300901 */
Jason Ekstrand918f2dd2013-12-02 21:01:53 -0600902 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
Giulio Camuffo7fe01b12013-03-28 18:02:42 +0100903 void *configure_private;
Pekka Paalanen8274d902014-08-06 19:36:51 +0300904 int (*get_label)(struct weston_surface *surface, char *buf, size_t len);
Pekka Paalanene67858b2013-04-25 13:57:42 +0300905
906 /* Parent's list of its sub-surfaces, weston_subsurface:parent_link.
907 * Contains also the parent itself as a dummy weston_subsurface,
908 * if the list is not empty.
909 */
910 struct wl_list subsurface_list; /* weston_subsurface::parent_link */
911 struct wl_list subsurface_list_pending; /* ...::parent_link_pending */
Pekka Paalanen50b67472014-10-01 15:02:41 +0300912
913 /*
914 * For tracking protocol role assignments. Different roles may
915 * have the same configure hook, e.g. in shell.c. Configure hook
916 * may get reset, this will not.
917 * XXX: map configure functions 1:1 to roles, and never reset it,
918 * and replace role_name with configure.
919 */
920 const char *role_name;
Pekka Paalanenb5026542014-11-12 15:09:24 +0200921
922 struct weston_timeline_object timeline;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500923};
924
Jason Ekstrande9d40e32014-05-20 11:23:53 -0500925struct weston_subsurface {
926 struct wl_resource *resource;
927
928 /* guaranteed to be valid and non-NULL */
929 struct weston_surface *surface;
930 struct wl_listener surface_destroy_listener;
931
932 /* can be NULL */
933 struct weston_surface *parent;
934 struct wl_listener parent_destroy_listener;
935 struct wl_list parent_link;
936 struct wl_list parent_link_pending;
937
938 struct {
939 int32_t x;
940 int32_t y;
941 int set;
942 } position;
943
Jason Ekstrand7b982072014-05-20 14:33:03 -0500944 int has_cached_data;
945 struct weston_surface_state cached;
946 struct weston_buffer_reference cached_buffer_ref;
Jason Ekstrande9d40e32014-05-20 11:23:53 -0500947
948 int synchronized;
949
950 /* Used for constructing the view tree */
951 struct wl_list unused_views;
952};
953
Daniel Stoned6da09e2012-06-22 13:21:29 +0100954enum weston_key_state_update {
955 STATE_UPDATE_AUTOMATIC,
956 STATE_UPDATE_NONE,
957};
958
Kristian Høgsberg9ddb8262012-01-04 21:30:29 -0500959void
Kristian Høgsbergaf4f2aa2013-02-15 20:53:20 -0500960weston_version(int *major, int *minor, int *micro);
961
962void
Jason Ekstranda7af7042013-10-12 22:38:11 -0500963weston_view_update_transform(struct weston_view *view);
Pekka Paalanen460099f2012-01-20 16:48:25 +0200964
965void
Jason Ekstranda7af7042013-10-12 22:38:11 -0500966weston_view_geometry_dirty(struct weston_view *view);
Pekka Paalanenc3ce7382013-03-08 14:56:49 +0200967
968void
Jason Ekstranda7af7042013-10-12 22:38:11 -0500969weston_view_to_global_fixed(struct weston_view *view,
970 wl_fixed_t sx, wl_fixed_t sy,
971 wl_fixed_t *x, wl_fixed_t *y);
Daniel Stonebd3489b2012-05-08 17:17:53 +0100972void
Jason Ekstranda7af7042013-10-12 22:38:11 -0500973weston_view_to_global_float(struct weston_view *view,
974 float sx, float sy, float *x, float *y);
Pekka Paalanene0f3cb22012-01-24 09:59:29 +0200975
976void
Jason Ekstranda7af7042013-10-12 22:38:11 -0500977weston_view_from_global_float(struct weston_view *view,
978 float x, float y, float *vx, float *vy);
Kristian Høgsbergecf6ede2012-09-05 21:59:35 -0400979void
Jason Ekstranda7af7042013-10-12 22:38:11 -0500980weston_view_from_global(struct weston_view *view,
981 int32_t x, int32_t y, int32_t *vx, int32_t *vy);
Daniel Stonebd3489b2012-05-08 17:17:53 +0100982void
Jason Ekstranda7af7042013-10-12 22:38:11 -0500983weston_view_from_global_fixed(struct weston_view *view,
984 wl_fixed_t x, wl_fixed_t y,
985 wl_fixed_t *vx, wl_fixed_t *vy);
Pekka Paalanene0f3cb22012-01-24 09:59:29 +0200986
Derek Foremand1be3122014-09-18 16:46:49 -0500987void
Ander Conselvan de Oliveira0396ba22012-11-28 17:10:26 +0200988weston_surface_to_buffer_float(struct weston_surface *surface,
989 float x, float y, float *bx, float *by);
Derek Foremand1be3122014-09-18 16:46:49 -0500990void
Alexander Larsson4ea95522013-05-22 14:41:37 +0200991weston_surface_to_buffer(struct weston_surface *surface,
Jason Ekstranda7af7042013-10-12 22:38:11 -0500992 int sx, int sy, int *bx, int *by);
Ander Conselvan de Oliveira0396ba22012-11-28 17:10:26 +0200993pixman_box32_t
994weston_surface_to_buffer_rect(struct weston_surface *surface,
995 pixman_box32_t rect);
996
Pekka Paalanene0f3cb22012-01-24 09:59:29 +0200997void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500998weston_spring_init(struct weston_spring *spring,
999 double k, double current, double target);
1000void
1001weston_spring_update(struct weston_spring *spring, uint32_t msec);
1002int
1003weston_spring_done(struct weston_spring *spring);
1004
1005void
1006weston_surface_activate(struct weston_surface *surface,
Daniel Stone37816df2012-05-16 18:45:18 +01001007 struct weston_seat *seat);
Kristian Høgsberg68c479a2012-01-25 23:32:28 -05001008void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001009notify_motion(struct weston_seat *seat, uint32_t time,
Rob Bradfordc088e2c2013-03-27 15:59:43 +00001010 wl_fixed_t dx, wl_fixed_t dy);
1011void
1012notify_motion_absolute(struct weston_seat *seat, uint32_t time,
1013 wl_fixed_t x, wl_fixed_t y);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001014void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001015notify_button(struct weston_seat *seat, uint32_t time, int32_t button,
Daniel Stone4dbadb12012-05-30 16:31:51 +01001016 enum wl_pointer_button_state state);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001017void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001018notify_axis(struct weston_seat *seat, uint32_t time, uint32_t axis,
Daniel Stone878f0b72012-05-30 16:31:57 +01001019 wl_fixed_t value);
Scott Moreau210d0792012-03-22 10:47:01 -06001020void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001021notify_key(struct weston_seat *seat, uint32_t time, uint32_t key,
Daniel Stone1b4e11f2012-06-22 13:21:37 +01001022 enum wl_keyboard_key_state state,
1023 enum weston_key_state_update update_state);
Daniel Stone05d58682012-06-22 13:21:38 +01001024void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001025notify_modifiers(struct weston_seat *seat, uint32_t serial);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001026
1027void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001028notify_pointer_focus(struct weston_seat *seat, struct weston_output *output,
Kristian Høgsberge11bbe42012-05-09 12:19:04 -04001029 wl_fixed_t x, wl_fixed_t y);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001030
1031void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001032notify_keyboard_focus_in(struct weston_seat *seat, struct wl_array *keys,
Daniel Stoned6da09e2012-06-22 13:21:29 +01001033 enum weston_key_state_update update_state);
1034void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001035notify_keyboard_focus_out(struct weston_seat *seat);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001036
1037void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001038notify_touch(struct weston_seat *seat, uint32_t time, int touch_id,
Kristian Høgsberge11bbe42012-05-09 12:19:04 -04001039 wl_fixed_t x, wl_fixed_t y, int touch_type);
Jonas Ådahl1679f232014-04-12 09:39:51 +02001040void
1041notify_touch_frame(struct weston_seat *seat);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001042
1043void
Giulio Camuffo412e6a52014-07-09 22:12:56 +03001044weston_layer_entry_insert(struct weston_layer_entry *list,
1045 struct weston_layer_entry *entry);
1046void
1047weston_layer_entry_remove(struct weston_layer_entry *entry);
1048void
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -05001049weston_layer_init(struct weston_layer *layer, struct wl_list *below);
1050
1051void
Giulio Camuffo95ec0f92014-07-09 22:12:57 +03001052weston_layer_set_mask(struct weston_layer *layer, int x, int y, int width, int height);
1053
1054void
1055weston_layer_set_mask_infinite(struct weston_layer *layer);
1056
1057void
Xiong Zhang97116532013-10-23 13:58:31 +08001058weston_plane_init(struct weston_plane *plane,
1059 struct weston_compositor *ec,
1060 int32_t x, int32_t y);
Kristian Høgsberg65a11e12012-08-03 11:30:18 -04001061void
1062weston_plane_release(struct weston_plane *plane);
1063
1064void
Ander Conselvan de Oliveira8ad19822013-03-05 17:30:27 +02001065weston_compositor_stack_plane(struct weston_compositor *ec,
1066 struct weston_plane *plane,
1067 struct weston_plane *above);
1068
Pekka Paalanen363aa7b2014-12-17 16:20:40 +02001069/* An invalid flag in presented_flags to catch logic errors. */
1070#define PRESENTATION_FEEDBACK_INVALID (1U << 31)
1071
Ander Conselvan de Oliveira8ad19822013-03-05 17:30:27 +02001072void
Pekka Paalanenb5eedad2014-09-23 22:08:45 -04001073weston_output_finish_frame(struct weston_output *output,
Pekka Paalanen363aa7b2014-12-17 16:20:40 +02001074 const struct timespec *stamp,
1075 uint32_t presented_flags);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001076void
Kristian Høgsberg49952d12012-06-20 00:35:59 -04001077weston_output_schedule_repaint(struct weston_output *output);
1078void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001079weston_output_damage(struct weston_output *output);
1080void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001081weston_compositor_schedule_repaint(struct weston_compositor *compositor);
1082void
1083weston_compositor_fade(struct weston_compositor *compositor, float tint);
1084void
1085weston_compositor_damage_all(struct weston_compositor *compositor);
1086void
1087weston_compositor_unlock(struct weston_compositor *compositor);
1088void
1089weston_compositor_wake(struct weston_compositor *compositor);
1090void
Philipp Brüschweiler57edf7f2013-03-29 13:01:56 +01001091weston_compositor_offscreen(struct weston_compositor *compositor);
1092void
Ander Conselvan de Oliveira87524b62013-02-21 18:35:22 +02001093weston_compositor_sleep(struct weston_compositor *compositor);
Jason Ekstranda7af7042013-10-12 22:38:11 -05001094struct weston_view *
1095weston_compositor_pick_view(struct weston_compositor *compositor,
1096 wl_fixed_t x, wl_fixed_t y,
1097 wl_fixed_t *sx, wl_fixed_t *sy);
Ander Conselvan de Oliveira30eebc72012-02-15 17:02:57 +02001098
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001099
1100struct weston_binding;
Kristian Høgsberge3148752013-05-06 23:19:49 -04001101typedef void (*weston_key_binding_handler_t)(struct weston_seat *seat,
Daniel Stone325fc2d2012-05-30 16:31:58 +01001102 uint32_t time, uint32_t key,
1103 void *data);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001104struct weston_binding *
Daniel Stone325fc2d2012-05-30 16:31:58 +01001105weston_compositor_add_key_binding(struct weston_compositor *compositor,
1106 uint32_t key,
1107 enum weston_keyboard_modifier modifier,
1108 weston_key_binding_handler_t binding,
1109 void *data);
1110
Daniel Stone96d47c02013-11-19 11:37:12 +01001111typedef void (*weston_modifier_binding_handler_t)(struct weston_seat *seat,
1112 enum weston_keyboard_modifier modifier,
1113 void *data);
1114struct weston_binding *
1115weston_compositor_add_modifier_binding(struct weston_compositor *compositor,
1116 enum weston_keyboard_modifier modifier,
1117 weston_modifier_binding_handler_t binding,
1118 void *data);
1119
Kristian Høgsberge3148752013-05-06 23:19:49 -04001120typedef void (*weston_button_binding_handler_t)(struct weston_seat *seat,
Daniel Stone325fc2d2012-05-30 16:31:58 +01001121 uint32_t time, uint32_t button,
1122 void *data);
1123struct weston_binding *
1124weston_compositor_add_button_binding(struct weston_compositor *compositor,
1125 uint32_t button,
1126 enum weston_keyboard_modifier modifier,
1127 weston_button_binding_handler_t binding,
1128 void *data);
1129
Neil Robertsa28c6932013-10-03 16:43:04 +01001130typedef void (*weston_touch_binding_handler_t)(struct weston_seat *seat,
1131 uint32_t time,
1132 void *data);
1133struct weston_binding *
1134weston_compositor_add_touch_binding(struct weston_compositor *compositor,
1135 enum weston_keyboard_modifier modifier,
1136 weston_touch_binding_handler_t binding,
1137 void *data);
1138
Kristian Høgsberge3148752013-05-06 23:19:49 -04001139typedef void (*weston_axis_binding_handler_t)(struct weston_seat *seat,
Daniel Stone325fc2d2012-05-30 16:31:58 +01001140 uint32_t time, uint32_t axis,
Daniel Stone0c1e46e2012-05-30 16:31:59 +01001141 wl_fixed_t value, void *data);
Daniel Stone325fc2d2012-05-30 16:31:58 +01001142struct weston_binding *
1143weston_compositor_add_axis_binding(struct weston_compositor *compositor,
1144 uint32_t axis,
1145 enum weston_keyboard_modifier modifier,
1146 weston_axis_binding_handler_t binding,
1147 void *data);
Ander Conselvan de Oliveirac509d2b2012-11-08 17:20:45 +02001148struct weston_binding *
1149weston_compositor_add_debug_binding(struct weston_compositor *compositor,
1150 uint32_t key,
1151 weston_key_binding_handler_t binding,
1152 void *data);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001153void
1154weston_binding_destroy(struct weston_binding *binding);
1155
1156void
Kristian Høgsberg3466bc82012-01-03 11:29:15 -05001157weston_binding_list_destroy_all(struct wl_list *list);
1158
Pekka Paalanen86b53962014-11-19 13:43:32 +02001159void
Daniel Stone325fc2d2012-05-30 16:31:58 +01001160weston_compositor_run_key_binding(struct weston_compositor *compositor,
1161 struct weston_seat *seat, uint32_t time,
1162 uint32_t key,
1163 enum wl_keyboard_key_state state);
Daniel Stone96d47c02013-11-19 11:37:12 +01001164
1165void
1166weston_compositor_run_modifier_binding(struct weston_compositor *compositor,
1167 struct weston_seat *seat,
1168 enum weston_keyboard_modifier modifier,
1169 enum wl_keyboard_key_state state);
Daniel Stone325fc2d2012-05-30 16:31:58 +01001170void
1171weston_compositor_run_button_binding(struct weston_compositor *compositor,
1172 struct weston_seat *seat, uint32_t time,
1173 uint32_t button,
1174 enum wl_pointer_button_state value);
Neil Robertsa28c6932013-10-03 16:43:04 +01001175void
1176weston_compositor_run_touch_binding(struct weston_compositor *compositor,
1177 struct weston_seat *seat, uint32_t time,
1178 int touch_type);
Rune K. Svendsen14b2fe72013-03-07 21:50:00 +01001179int
Daniel Stone325fc2d2012-05-30 16:31:58 +01001180weston_compositor_run_axis_binding(struct weston_compositor *compositor,
1181 struct weston_seat *seat, uint32_t time,
1182 uint32_t axis, int32_t value);
Ander Conselvan de Oliveirac509d2b2012-11-08 17:20:45 +02001183int
1184weston_compositor_run_debug_binding(struct weston_compositor *compositor,
1185 struct weston_seat *seat, uint32_t time,
1186 uint32_t key,
1187 enum wl_keyboard_key_state state);
Daniel Stone325fc2d2012-05-30 16:31:58 +01001188
Giulio Camuffocdb4d292013-11-14 23:42:53 +01001189void
1190weston_compositor_set_default_pointer_grab(struct weston_compositor *compositor,
1191 const struct weston_pointer_grab_interface *interface);
1192
Benjamin Franzkebfeda132012-01-30 14:04:04 +01001193int
1194weston_environment_get_fd(const char *env);
1195
Kristian Høgsberga82c4862012-01-26 01:03:58 -05001196struct wl_list *
1197weston_compositor_top(struct weston_compositor *compositor);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001198
1199struct weston_surface *
Kristian Høgsberg18c93002012-01-27 11:58:31 -05001200weston_surface_create(struct weston_compositor *compositor);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001201
Jason Ekstranda7af7042013-10-12 22:38:11 -05001202struct weston_view *
1203weston_view_create(struct weston_surface *surface);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001204
1205void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001206weston_view_destroy(struct weston_view *view);
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -05001207
1208void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001209weston_view_set_position(struct weston_view *view,
1210 float x, float y);
1211
1212void
1213weston_view_set_transform_parent(struct weston_view *view,
1214 struct weston_view *parent);
1215
Derek Foreman280e7dd2014-10-03 13:13:42 -05001216bool
Jason Ekstranda7af7042013-10-12 22:38:11 -05001217weston_view_is_mapped(struct weston_view *view);
1218
1219void
1220weston_view_schedule_repaint(struct weston_view *view);
Pekka Paalanen483243f2013-03-08 14:56:50 +02001221
Derek Foreman280e7dd2014-10-03 13:13:42 -05001222bool
Ander Conselvan de Oliveirab8ab14f2012-03-27 17:36:36 +03001223weston_surface_is_mapped(struct weston_surface *surface);
1224
Derek Foremand1be3122014-09-18 16:46:49 -05001225void
Jason Ekstrand5c11a332013-12-04 20:32:03 -06001226weston_surface_set_size(struct weston_surface *surface,
1227 int32_t width, int32_t height);
1228
Pekka Paalanen8fb8d3b2012-02-13 13:03:59 +02001229void
Kristian Høgsberg98238702012-08-03 16:29:12 -04001230weston_surface_schedule_repaint(struct weston_surface *surface);
1231
1232void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001233weston_surface_damage(struct weston_surface *surface);
1234
1235void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001236weston_view_damage_below(struct weston_view *view);
Kristian Høgsbergd8bf90c2012-02-23 23:03:14 -05001237
1238void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001239weston_view_move_to_plane(struct weston_view *view,
1240 struct weston_plane *plane);
1241void
1242weston_view_unmap(struct weston_view *view);
1243
Kristian Høgsberg65a11e12012-08-03 11:30:18 -04001244void
Kristian Høgsbergaf7b1ff2012-06-26 21:19:23 -04001245weston_surface_unmap(struct weston_surface *surface);
1246
Pekka Paalanen01388e22013-04-25 13:57:44 +03001247struct weston_surface *
1248weston_surface_get_main_surface(struct weston_surface *surface);
1249
Pekka Paalanen50b67472014-10-01 15:02:41 +03001250int
1251weston_surface_set_role(struct weston_surface *surface,
1252 const char *role_name,
1253 struct wl_resource *error_resource,
1254 uint32_t error_code);
1255
Pekka Paalanen8274d902014-08-06 19:36:51 +03001256void
1257weston_surface_set_label_func(struct weston_surface *surface,
1258 int (*desc)(struct weston_surface *,
1259 char *, size_t));
1260
Jason Ekstrand6bd62942013-06-20 20:38:23 -05001261struct weston_buffer *
1262weston_buffer_from_resource(struct wl_resource *resource);
1263
Kristian Høgsbergaf7b1ff2012-06-26 21:19:23 -04001264void
Pekka Paalanende685b82012-12-04 15:58:12 +02001265weston_buffer_reference(struct weston_buffer_reference *ref,
Jason Ekstrand6bd62942013-06-20 20:38:23 -05001266 struct weston_buffer *buffer);
Pekka Paalanende685b82012-12-04 15:58:12 +02001267
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001268uint32_t
1269weston_compositor_get_time(void);
1270
1271int
Daniel Stonebaf43592012-06-01 11:11:10 -04001272weston_compositor_init(struct weston_compositor *ec, struct wl_display *display,
Kristian Høgsberg14e438c2013-05-26 21:48:14 -04001273 int *argc, char *argv[], struct weston_config *config);
Pekka Paalanenb5eedad2014-09-23 22:08:45 -04001274int
1275weston_compositor_set_presentation_clock(struct weston_compositor *compositor,
1276 clockid_t clk_id);
1277int
1278weston_compositor_set_presentation_clock_software(
1279 struct weston_compositor *compositor);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001280void
1281weston_compositor_shutdown(struct weston_compositor *ec);
1282void
Frederic Plourdec336f062014-10-29 14:44:33 -04001283weston_compositor_exit_with_code(struct weston_compositor *compositor,
1284 int exit_code);
1285void
Scott Moreau429490d2012-06-17 18:10:59 -06001286weston_output_init_zoom(struct weston_output *output);
1287void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001288weston_output_update_zoom(struct weston_output *output);
Scott Moreauccbf29d2012-02-22 14:21:41 -07001289void
Giulio Camuffo412b0242013-11-14 23:42:51 +01001290weston_output_activate_zoom(struct weston_output *output);
1291void
Scott Moreauccbf29d2012-02-22 14:21:41 -07001292weston_output_update_matrix(struct weston_output *output);
1293void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001294weston_output_move(struct weston_output *output, int x, int y);
1295void
1296weston_output_init(struct weston_output *output, struct weston_compositor *c,
Alexander Larssonedddbd12013-05-24 13:09:43 +02001297 int x, int y, int width, int height, uint32_t transform, int32_t scale);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001298void
1299weston_output_destroy(struct weston_output *output);
Kristian Høgsberg98c774f2013-07-22 14:33:42 -07001300void
Jason Ekstrandb6a3cc72013-10-27 22:25:00 -05001301weston_output_transform_coordinate(struct weston_output *output,
1302 wl_fixed_t device_x, wl_fixed_t device_y,
Kristian Høgsberg98c774f2013-07-22 14:33:42 -07001303 wl_fixed_t *x, wl_fixed_t *y);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001304
1305void
Rob Bradford9af5f9e2013-05-31 18:09:50 +01001306weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec,
1307 const char *seat_name);
Daniel Stone74419a22012-05-30 16:32:02 +01001308void
1309weston_seat_init_pointer(struct weston_seat *seat);
Jonas Ådahld6e1c342013-10-17 23:04:05 +02001310void
1311weston_seat_release_pointer(struct weston_seat *seat);
Kristian Høgsberg2f07ef62013-02-16 14:29:24 -05001312int
Daniel Stonebb1df6a2012-05-30 16:32:06 +01001313weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
Daniel Stone74419a22012-05-30 16:32:02 +01001314void
Jonas Ådahld6e1c342013-10-17 23:04:05 +02001315weston_seat_release_keyboard(struct weston_seat *seat);
1316void
Daniel Stone74419a22012-05-30 16:32:02 +01001317weston_seat_init_touch(struct weston_seat *seat);
Kristian Høgsbergb5e26102013-04-18 15:40:10 -04001318void
Jonas Ådahld6e1c342013-10-17 23:04:05 +02001319weston_seat_release_touch(struct weston_seat *seat);
1320void
Kristian Høgsberga71e8b22013-05-06 21:51:21 -04001321weston_seat_repick(struct weston_seat *seat);
Rui Matos65196bc2013-10-10 19:44:19 +02001322void
1323weston_seat_update_keymap(struct weston_seat *seat, struct xkb_keymap *keymap);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001324
1325void
Daniel Stone37816df2012-05-16 18:45:18 +01001326weston_seat_release(struct weston_seat *seat);
Kristian Høgsbergb5e26102013-04-18 15:40:10 -04001327int
1328weston_compositor_xkb_init(struct weston_compositor *ec,
1329 struct xkb_rule_names *names);
1330void
1331weston_compositor_xkb_destroy(struct weston_compositor *ec);
Kristian Høgsberg3466bc82012-01-03 11:29:15 -05001332
Kristian Høgsberg64eca892012-08-01 00:00:57 -04001333/* String literal of spaces, the same width as the timestamp. */
1334#define STAMP_SPACE " "
1335
1336void
1337weston_log_file_open(const char *filename);
1338void
1339weston_log_file_close(void);
1340int
Kristian Høgsberg082d58c2013-06-18 01:00:27 -04001341weston_vlog(const char *fmt, va_list ap);
1342int
1343weston_vlog_continue(const char *fmt, va_list ap);
1344int
Pekka Paalanend525b562012-08-06 14:57:04 +03001345weston_log(const char *fmt, ...)
1346 __attribute__ ((format (printf, 1, 2)));
Kristian Høgsberg64eca892012-08-01 00:00:57 -04001347int
Pekka Paalanend525b562012-08-06 14:57:04 +03001348weston_log_continue(const char *fmt, ...)
1349 __attribute__ ((format (printf, 1, 2)));
Kristian Høgsberg64eca892012-08-01 00:00:57 -04001350
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001351enum {
1352 TTY_ENTER_VT,
1353 TTY_LEAVE_VT
1354};
1355
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001356struct tty *
Kristian Høgsberg61741a22013-09-17 16:02:57 -07001357tty_create(struct weston_compositor *compositor, int tty_nr);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001358
1359void
1360tty_destroy(struct tty *tty);
1361
Kristian Høgsberg7b884bc2012-07-31 14:32:01 -04001362void
1363tty_reset(struct tty *tty);
1364
Kristian Høgsberg5d1c0c52012-04-10 00:11:50 -04001365int
1366tty_activate_vt(struct tty *tty, int vt);
1367
Kristian Høgsberg3466bc82012-01-03 11:29:15 -05001368void
Kristian Høgsberg02e79dc2012-04-12 09:55:26 -04001369screenshooter_create(struct weston_compositor *ec);
Kristian Høgsberg3466bc82012-01-03 11:29:15 -05001370
Giulio Camuffoe9022e72013-12-11 23:45:11 +01001371enum weston_screenshooter_outcome {
1372 WESTON_SCREENSHOOTER_SUCCESS,
1373 WESTON_SCREENSHOOTER_NO_MEMORY,
1374 WESTON_SCREENSHOOTER_BAD_BUFFER
1375};
1376
1377typedef void (*weston_screenshooter_done_func_t)(void *data,
1378 enum weston_screenshooter_outcome outcome);
1379int
1380weston_screenshooter_shoot(struct weston_output *output, struct weston_buffer *buffer,
1381 weston_screenshooter_done_func_t done, void *data);
1382
Kristian Høgsberga7ceaff2012-06-03 10:20:13 -04001383struct clipboard *
1384clipboard_create(struct weston_seat *seat);
1385
Jan Arne Petersen674fd1d2012-11-18 19:06:42 +01001386int
1387text_backend_init(struct weston_compositor *ec);
Jan Arne Petersen1f17be42012-06-21 21:52:18 +02001388
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001389struct weston_process;
1390typedef void (*weston_process_cleanup_func_t)(struct weston_process *process,
1391 int status);
1392
1393struct weston_process {
1394 pid_t pid;
1395 weston_process_cleanup_func_t cleanup;
1396 struct wl_list link;
1397};
1398
1399struct wl_client *
1400weston_client_launch(struct weston_compositor *compositor,
1401 struct weston_process *proc,
1402 const char *path,
1403 weston_process_cleanup_func_t cleanup);
1404
Pekka Paalanen9c1ac7b2014-08-27 12:03:38 +03001405struct wl_client *
1406weston_client_start(struct weston_compositor *compositor, const char *path);
1407
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001408void
1409weston_watch_process(struct weston_process *process);
1410
Jason Ekstranda7af7042013-10-12 22:38:11 -05001411struct weston_view_animation;
1412typedef void (*weston_view_animation_done_func_t)(struct weston_view_animation *animation, void *data);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001413
Louis-Francis Ratté-Boulianneb482dbd2013-11-19 11:37:11 +01001414void
1415weston_view_animation_destroy(struct weston_view_animation *animation);
1416
Jason Ekstranda7af7042013-10-12 22:38:11 -05001417struct weston_view_animation *
1418weston_zoom_run(struct weston_view *view, float start, float stop,
1419 weston_view_animation_done_func_t done, void *data);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001420
Jason Ekstranda7af7042013-10-12 22:38:11 -05001421struct weston_view_animation *
1422weston_fade_run(struct weston_view *view,
Ander Conselvan de Oliveiraee416052013-02-21 18:35:17 +02001423 float start, float end, float k,
Jason Ekstranda7af7042013-10-12 22:38:11 -05001424 weston_view_animation_done_func_t done, void *data);
Daniel Stonea67e6b92013-11-19 11:37:13 +01001425
1426struct weston_view_animation *
1427weston_move_scale_run(struct weston_view *view, int dx, int dy,
1428 float start, float end, int reverse,
1429 weston_view_animation_done_func_t done, void *data);
1430
Ander Conselvan de Oliveiraee416052013-02-21 18:35:17 +02001431void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001432weston_fade_update(struct weston_view_animation *fade, float target);
Ander Conselvan de Oliveiraee416052013-02-21 18:35:17 +02001433
Jason Ekstranda7af7042013-10-12 22:38:11 -05001434struct weston_view_animation *
Louis-Francis Ratté-Boulianneb482dbd2013-11-19 11:37:11 +01001435weston_stable_fade_run(struct weston_view *front_view, float start,
1436 struct weston_view *back_view, float end,
1437 weston_view_animation_done_func_t done, void *data);
1438
1439struct weston_view_animation *
Jason Ekstranda7af7042013-10-12 22:38:11 -05001440weston_slide_run(struct weston_view *view, float start, float stop,
1441 weston_view_animation_done_func_t done, void *data);
Juan Zhaoe10d2792012-04-25 19:09:52 +08001442
Alex Wu8811bf92012-02-28 18:07:54 +08001443void
1444weston_surface_set_color(struct weston_surface *surface,
John Kåre Alsaker490d02a2012-09-30 02:57:21 +02001445 float red, float green, float blue, float alpha);
Alex Wu8811bf92012-02-28 18:07:54 +08001446
1447void
1448weston_surface_destroy(struct weston_surface *surface);
1449
Alex Wu2dda6042012-04-17 17:20:47 +08001450int
Derek Foreman6ae7bc92014-11-04 10:47:33 -06001451weston_output_mode_set_native(struct weston_output *output,
1452 struct weston_mode *mode,
1453 int32_t scale);
1454int
1455weston_output_mode_switch_to_temporary(struct weston_output *output,
1456 struct weston_mode *mode,
1457 int32_t scale);
1458int
1459weston_output_mode_switch_to_native(struct weston_output *output);
Alex Wu2dda6042012-04-17 17:20:47 +08001460
Ander Conselvan de Oliveira11f8d402012-10-29 18:19:24 +02001461int
1462noop_renderer_init(struct weston_compositor *ec);
Ander Conselvan de Oliveira11f8d402012-10-29 18:19:24 +02001463
Kristian Høgsbergb00a9d32012-09-11 14:06:27 -04001464struct weston_compositor *
Kristian Høgsberg4172f662013-02-20 15:27:49 -05001465backend_init(struct wl_display *display, int *argc, char *argv[],
Kristian Høgsberg14e438c2013-05-26 21:48:14 -04001466 struct weston_config *config);
Kristian Høgsbergb00a9d32012-09-11 14:06:27 -04001467
1468int
Kristian Høgsbergcb4685b2013-02-20 15:37:49 -05001469module_init(struct weston_compositor *compositor,
Ossama Othmana50e6e42013-05-14 09:48:26 -07001470 int *argc, char *argv[]);
Kristian Høgsbergb00a9d32012-09-11 14:06:27 -04001471
Ander Conselvan de Oliveira409eebf2012-12-05 15:14:04 +02001472void
1473weston_transformed_coord(int width, int height,
1474 enum wl_output_transform transform,
Alexander Larssonedddbd12013-05-24 13:09:43 +02001475 int32_t scale,
Ander Conselvan de Oliveira409eebf2012-12-05 15:14:04 +02001476 float sx, float sy, float *bx, float *by);
1477pixman_box32_t
1478weston_transformed_rect(int width, int height,
1479 enum wl_output_transform transform,
Alexander Larssonedddbd12013-05-24 13:09:43 +02001480 int32_t scale,
Ander Conselvan de Oliveira409eebf2012-12-05 15:14:04 +02001481 pixman_box32_t rect);
Jason Ekstrand33ff6362013-10-27 22:25:01 -05001482void
1483weston_transformed_region(int width, int height,
1484 enum wl_output_transform transform,
1485 int32_t scale,
1486 pixman_region32_t *src, pixman_region32_t *dest);
Ander Conselvan de Oliveira409eebf2012-12-05 15:14:04 +02001487
Ander Conselvan de Oliveira97f29522013-10-14 15:57:11 +03001488void *
1489weston_load_module(const char *name, const char *entrypoint);
1490
Derek Foreman64a3df02014-10-23 12:24:18 -05001491int
1492weston_parse_transform(const char *transform, uint32_t *out);
1493
1494const char *
1495weston_transform_to_string(uint32_t output_transform);
1496
Giulio Camuffo7fe01b12013-03-28 18:02:42 +01001497#ifdef __cplusplus
1498}
1499#endif
1500
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001501#endif