blob: 41777568ba490d66e25ec410f1d7586b8fdab3e0 [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 *
Bryce Harringtona0bbfea2015-06-11 15:35:43 -07005 * Permission is hereby granted, free of charge, to any person obtaining
6 * a copy of this software and associated documentation files (the
7 * "Software"), to deal in the Software without restriction, including
8 * without limitation the rights to use, copy, modify, merge, publish,
9 * distribute, sublicense, and/or sell copies of the Software, and to
10 * permit persons to whom the Software is furnished to do so, subject to
11 * the following conditions:
Kristian Høgsberg8334bc12012-01-03 10:29:47 -050012 *
Bryce Harringtona0bbfea2015-06-11 15:35:43 -070013 * The above copyright notice and this permission notice (including the
14 * next paragraph) shall be included in all copies or substantial
15 * portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
21 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
22 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
Kristian Høgsberg8334bc12012-01-03 10:29:47 -050025 */
26
27#ifndef _WAYLAND_SYSTEM_COMPOSITOR_H_
28#define _WAYLAND_SYSTEM_COMPOSITOR_H_
29
Giulio Camuffo7fe01b12013-03-28 18:02:42 +010030#ifdef __cplusplus
31extern "C" {
32#endif
33
Derek Foreman280e7dd2014-10-03 13:13:42 -050034#include <stdbool.h>
Pekka Paalanenb5eedad2014-09-23 22:08:45 -040035#include <time.h>
Kristian Høgsberg8334bc12012-01-03 10:29:47 -050036#include <pixman.h>
Daniel Stone855028f2012-05-01 20:37:10 +010037#include <xkbcommon/xkbcommon.h>
Kristian Høgsberg3c179332013-08-06 19:27:04 -070038
39#define WL_HIDE_DEPRECATED
Kristian Høgsberg8334bc12012-01-03 10:29:47 -050040#include <wayland-server.h>
41
Kristian Høgsbergaf4f2aa2013-02-15 20:53:20 -050042#include "version.h"
43#include "matrix.h"
44#include "config-parser.h"
Peter Huttererb1bc4a62013-08-08 11:57:04 +100045#include "zalloc.h"
Pekka Paalanenb5026542014-11-12 15:09:24 +020046#include "timeline-object.h"
Pekka Paalanen2eaa11e2012-03-30 15:45:40 +030047
Kristian Høgsberg8334bc12012-01-03 10:29:47 -050048struct weston_transform {
49 struct weston_matrix matrix;
Pekka Paalanenc61eca62012-01-06 14:10:06 +020050 struct wl_list link;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -050051};
52
53struct weston_surface;
Jason Ekstrand6bd62942013-06-20 20:38:23 -050054struct weston_buffer;
Tiago Vignattibc052c92012-04-19 16:18:18 +030055struct shell_surface;
Daniel Stone37816df2012-05-16 18:45:18 +010056struct weston_seat;
Scott Moreau062be7e2012-04-20 13:37:33 -060057struct weston_output;
Jan Arne Petersene829adc2012-08-10 16:47:22 +020058struct input_method;
Derek Foremane4d6c832015-08-05 14:48:11 -050059struct weston_pointer;
Pekka Paalanen230f3b12014-09-29 14:18:40 -040060struct linux_dmabuf_buffer;
Giulio Camuffo26f62d42016-06-02 21:48:09 +030061struct weston_recorder;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -050062
Daniel Stone496ca172012-05-30 16:31:42 +010063enum weston_keyboard_modifier {
64 MODIFIER_CTRL = (1 << 0),
65 MODIFIER_ALT = (1 << 1),
66 MODIFIER_SUPER = (1 << 2),
Kristian Høgsberg73694c82012-06-28 14:13:10 -040067 MODIFIER_SHIFT = (1 << 3),
Daniel Stone496ca172012-05-30 16:31:42 +010068};
69
Giulio Camuffo6ef444d2014-08-28 19:44:09 +030070enum weston_keyboard_locks {
71 WESTON_NUM_LOCK = (1 << 0),
72 WESTON_CAPS_LOCK = (1 << 1),
73};
74
Daniel Stone8c8164f2012-05-30 16:31:45 +010075enum weston_led {
76 LED_NUM_LOCK = (1 << 0),
77 LED_CAPS_LOCK = (1 << 1),
78 LED_SCROLL_LOCK = (1 << 2),
79};
80
Kristian Høgsberg8334bc12012-01-03 10:29:47 -050081struct weston_mode {
82 uint32_t flags;
83 int32_t width, height;
84 uint32_t refresh;
85 struct wl_list link;
86};
87
Kristian Høgsberga61ca062012-05-22 16:05:52 -040088struct weston_shell_client {
Jasper St. Pierreac985be2014-04-28 11:19:28 -040089 void (*send_configure)(struct weston_surface *surface, int32_t width, int32_t height);
Giulio Camuffof05d18f2015-12-11 20:57:05 +020090 void (*send_position)(struct weston_surface *surface, int32_t x, int32_t y);
Kristian Høgsberga61ca062012-05-22 16:05:52 -040091};
92
Tiago Vignattibc052c92012-04-19 16:18:18 +030093struct weston_shell_interface {
94 void *shell; /* either desktop or tablet */
95
Kristian Høgsberg45ba8692012-05-21 14:27:33 -040096 struct shell_surface *(*create_shell_surface)(void *shell,
Kristian Høgsberga61ca062012-05-22 16:05:52 -040097 struct weston_surface *surface,
98 const struct weston_shell_client *client);
Tiago Vignattibc052c92012-04-19 16:18:18 +030099 void (*set_toplevel)(struct shell_surface *shsurf);
Kristian Høgsberg938b8fa2012-05-18 13:46:27 -0400100
Tiago Vignatti491bac12012-05-18 16:37:43 -0400101 void (*set_transient)(struct shell_surface *shsurf,
Kristian Høgsberg8150b192012-06-27 10:22:58 -0400102 struct weston_surface *parent,
Tiago Vignatti491bac12012-05-18 16:37:43 -0400103 int x, int y, uint32_t flags);
Kristian Høgsbergb810eb52013-02-12 20:07:05 -0500104 void (*set_fullscreen)(struct shell_surface *shsurf,
105 uint32_t method,
106 uint32_t framerate,
107 struct weston_output *output);
Tiago Vignattifb2adba2013-06-12 15:43:21 -0300108 void (*set_xwayland)(struct shell_surface *shsurf,
109 int x, int y, uint32_t flags);
Derek Foremane4d6c832015-08-05 14:48:11 -0500110 int (*move)(struct shell_surface *shsurf, struct weston_pointer *pointer);
Kristian Høgsbergc1693f22012-05-22 16:56:23 -0400111 int (*resize)(struct shell_surface *shsurf,
Derek Foremane4d6c832015-08-05 14:48:11 -0500112 struct weston_pointer *pointer, uint32_t edges);
Giulio Camuffo62942ad2013-09-11 18:20:47 +0200113 void (*set_title)(struct shell_surface *shsurf,
114 const char *title);
Jasper St. Pierreccf48fb2014-05-02 10:21:38 -0400115 void (*set_window_geometry)(struct shell_surface *shsurf,
116 int32_t x, int32_t y,
117 int32_t width, int32_t height);
Giulio Camuffo6b4b2412015-01-29 19:06:49 +0200118 void (*set_maximized)(struct shell_surface *shsurf);
Giulio Camuffoa8e9b412015-01-27 19:10:37 +0200119 void (*set_pid)(struct shell_surface *shsurf, pid_t pid);
Quentin Glidic5c201952016-03-23 13:50:49 +0100120 void (*get_output_work_area)(void *shell, struct weston_output *output, pixman_rectangle32_t *area);
Tiago Vignattibc052c92012-04-19 16:18:18 +0300121};
122
Scott Moreaue6603982012-06-11 13:07:51 -0600123struct weston_animation {
124 void (*frame)(struct weston_animation *animation,
125 struct weston_output *output, uint32_t msecs);
126 int frame_counter;
127 struct wl_list link;
128};
129
Kristian Høgsberg7eec9b32013-06-17 09:15:22 -0400130enum {
131 WESTON_SPRING_OVERSHOOT,
132 WESTON_SPRING_CLAMP,
133 WESTON_SPRING_BOUNCE
134};
135
Scott Moreaue6603982012-06-11 13:07:51 -0600136struct weston_spring {
137 double k;
138 double friction;
139 double current;
140 double target;
141 double previous;
Kristian Høgsberg091b0962013-06-17 09:23:14 -0400142 double min, max;
Scott Moreaue6603982012-06-11 13:07:51 -0600143 uint32_t timestamp;
Kristian Høgsberg7eec9b32013-06-17 09:15:22 -0400144 uint32_t clip;
Scott Moreaue6603982012-06-11 13:07:51 -0600145};
146
Scott Moreauccbf29d2012-02-22 14:21:41 -0700147struct weston_output_zoom {
Derek Foremana36eb502015-07-23 14:55:12 -0500148 bool active;
Scott Moreauccbf29d2012-02-22 14:21:41 -0700149 float increment;
150 float level;
Scott Moreaue6603982012-06-11 13:07:51 -0600151 float max_level;
Scott Moreauccbf29d2012-02-22 14:21:41 -0700152 float trans_x, trans_y;
Giulio Camuffo6850e7b2015-10-07 20:14:18 +0300153 struct {
154 double x, y;
155 } current;
Derek Foreman22276a52015-07-23 14:55:15 -0500156 struct weston_seat *seat;
Scott Moreaue6603982012-06-11 13:07:51 -0600157 struct weston_animation animation_z;
158 struct weston_spring spring_z;
Giulio Camuffo412b0242013-11-14 23:42:51 +0100159 struct wl_listener motion_listener;
Scott Moreauccbf29d2012-02-22 14:21:41 -0700160};
161
Tiago Vignatti8e53c7f2012-02-29 19:53:50 +0200162/* bit compatible with drm definitions. */
163enum dpms_enum {
164 WESTON_DPMS_ON,
165 WESTON_DPMS_STANDBY,
166 WESTON_DPMS_SUSPEND,
167 WESTON_DPMS_OFF
168};
169
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500170struct weston_output {
Casey Dahlin58ba1372012-04-19 22:50:08 -0400171 uint32_t id;
Richard Hughesafe690c2013-05-02 10:10:04 +0100172 char *name;
Casey Dahlin58ba1372012-04-19 22:50:08 -0400173
John Kåre Alsaker94659272012-11-13 19:10:18 +0100174 void *renderer_state;
175
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500176 struct wl_list link;
Casey Dahlin9074db52012-04-19 22:50:09 -0400177 struct wl_list resource_list;
Benjamin Franzkeb6879402012-04-10 18:28:54 +0200178 struct wl_global *global;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500179 struct weston_compositor *compositor;
Jason Ekstrandfb23df72014-10-16 10:55:21 -0500180
181 /** From global to output buffer coordinates. */
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500182 struct weston_matrix matrix;
Derek Foremanc0023212015-03-24 11:36:13 -0500183 /** From output buffer to global coordinates. */
184 struct weston_matrix inverse_matrix;
Jason Ekstrandfb23df72014-10-16 10:55:21 -0500185
Scott Moreau9d1b1122012-06-08 19:40:53 -0600186 struct wl_list animation_list;
Scott Moreau1bad5db2012-08-18 01:04:05 -0600187 int32_t x, y, width, height;
188 int32_t mm_width, mm_height;
Pekka Paalanenefd08c72015-02-23 13:54:49 +0200189
190 /** Output area in global coordinates, simple rect */
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500191 pixman_region32_t region;
Pekka Paalanenefd08c72015-02-23 13:54:49 +0200192
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;
Pekka Paalanen0513a952014-05-21 16:17:27 +0300196 struct wl_event_source *repaint_timer;
Scott Moreauccbf29d2012-02-22 14:21:41 -0700197 struct weston_output_zoom zoom;
198 int dirty;
Kristian Høgsberg5fb70bf2012-05-24 12:29:46 -0400199 struct wl_signal frame_signal;
Richard Hughes64ddde12013-05-01 21:52:10 +0100200 struct wl_signal destroy_signal;
Zhang, Xiong Yf3012412013-12-13 22:10:53 +0200201 int move_x, move_y;
Pekka Paalanenb5eedad2014-09-23 22:08:45 -0400202 uint32_t frame_time; /* presentation timestamp in milliseconds */
Pekka Paalanen641307c2014-09-23 22:08:47 -0400203 uint64_t msc; /* media stream counter */
Kristian Høgsberg79af73e2012-08-03 15:45:23 -0400204 int disable_planes;
Ander Conselvan de Oliveirae1e23522013-12-13 22:10:55 +0200205 int destroying;
Pekka Paalanen133e4392014-09-23 22:08:46 -0400206 struct wl_list feedback_list;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500207
Richard Hughes2b2092a2013-04-24 14:58:02 +0100208 char *make, *model, *serial_number;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500209 uint32_t subpixel;
Kristian Høgsberg05890dc2012-08-10 10:09:20 -0400210 uint32_t transform;
Hardening57388e42013-09-18 23:56:36 +0200211 int32_t native_scale;
Hardeningff39efa2013-09-18 23:56:35 +0200212 int32_t current_scale;
Hardening57388e42013-09-18 23:56:36 +0200213 int32_t original_scale;
Alexander Larsson4ea95522013-05-22 14:41:37 +0200214
Hardening57388e42013-09-18 23:56:36 +0200215 struct weston_mode *native_mode;
Hardeningff39efa2013-09-18 23:56:35 +0200216 struct weston_mode *current_mode;
217 struct weston_mode *original_mode;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500218 struct wl_list mode_list;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500219
Jonas Ådahle5a12252013-04-05 23:07:11 +0200220 void (*start_repaint_loop)(struct weston_output *output);
David Herrmann1edf44c2013-10-22 17:11:26 +0200221 int (*repaint)(struct weston_output *output,
Kristian Høgsbergd7c17262012-09-05 21:54:15 -0400222 pixman_region32_t *damage);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500223 void (*destroy)(struct weston_output *output);
Jesse Barnes5308a5e2012-02-09 13:12:57 -0800224 void (*assign_planes)(struct weston_output *output);
Alex Wu2dda6042012-04-17 17:20:47 +0800225 int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
Tiago Vignatti8e53c7f2012-02-29 19:53:50 +0200226
Tiago Vignatti5ab91ad2012-03-12 19:40:09 -0300227 /* backlight values are on 0-255 range, where higher is brighter */
Kristian Høgsberg7c609122013-05-23 20:30:26 -0400228 int32_t backlight_current;
Tiago Vignatti8e53c7f2012-02-29 19:53:50 +0200229 void (*set_backlight)(struct weston_output *output, uint32_t value);
230 void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
Richard Hughese7299962013-05-01 21:52:12 +0100231
Richard Hughesb24e48e2013-05-09 20:31:09 +0100232 int connection_internal;
Richard Hughese7299962013-05-01 21:52:12 +0100233 uint16_t gamma_size;
234 void (*set_gamma)(struct weston_output *output,
235 uint16_t size,
236 uint16_t *r,
237 uint16_t *g,
238 uint16_t *b);
Pekka Paalanenb5026542014-11-12 15:09:24 +0200239
240 struct weston_timeline_object timeline;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500241};
242
Jonas Ådahld2510102014-10-05 21:39:14 +0200243enum weston_pointer_motion_mask {
244 WESTON_POINTER_MOTION_ABS = 1 << 0,
245 WESTON_POINTER_MOTION_REL = 1 << 1,
Jonas Ådahl3845b322014-10-21 23:51:29 +0200246 WESTON_POINTER_MOTION_REL_UNACCEL = 1 << 2,
Jonas Ådahld2510102014-10-05 21:39:14 +0200247};
248
249struct weston_pointer_motion_event {
250 uint32_t mask;
Jonas Ådahlde1ed2e2015-07-29 14:18:02 +0800251 uint64_t time_usec;
Jonas Ådahld2510102014-10-05 21:39:14 +0200252 double x;
253 double y;
254 double dx;
255 double dy;
Jonas Ådahl3845b322014-10-21 23:51:29 +0200256 double dx_unaccel;
257 double dy_unaccel;
Jonas Ådahld2510102014-10-05 21:39:14 +0200258};
259
Peter Hutterer89b6a492016-01-18 15:58:17 +1000260struct weston_pointer_axis_event {
261 uint32_t axis;
Giulio Camuffo90a6fc62016-03-22 17:44:54 +0200262 double value;
Peter Hutterer87743e92016-01-18 16:38:22 +1000263 bool has_discrete;
264 int32_t discrete;
Peter Hutterer89b6a492016-01-18 15:58:17 +1000265};
266
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400267struct weston_pointer_grab;
268struct weston_pointer_grab_interface {
Kristian Høgsberg6848c252013-05-08 22:02:59 -0400269 void (*focus)(struct weston_pointer_grab *grab);
Giulio Camuffo1959ab82013-11-14 23:42:52 +0100270 void (*motion)(struct weston_pointer_grab *grab, uint32_t time,
Jonas Ådahld2510102014-10-05 21:39:14 +0200271 struct weston_pointer_motion_event *event);
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400272 void (*button)(struct weston_pointer_grab *grab,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400273 uint32_t time, uint32_t button, uint32_t state);
Jonas Ådahl0336ca02014-10-04 16:28:29 +0200274 void (*axis)(struct weston_pointer_grab *grab,
Peter Hutterer89b6a492016-01-18 15:58:17 +1000275 uint32_t time,
276 struct weston_pointer_axis_event *event);
Peter Hutterer87743e92016-01-18 16:38:22 +1000277 void (*axis_source)(struct weston_pointer_grab *grab, uint32_t source);
278 void (*frame)(struct weston_pointer_grab *grab);
Jonas Ådahl1ea343e2013-10-25 23:18:05 +0200279 void (*cancel)(struct weston_pointer_grab *grab);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400280};
281
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400282struct weston_pointer_grab {
283 const struct weston_pointer_grab_interface *interface;
284 struct weston_pointer *pointer;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400285};
286
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400287struct weston_keyboard_grab;
288struct weston_keyboard_grab_interface {
289 void (*key)(struct weston_keyboard_grab *grab, uint32_t time,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400290 uint32_t key, uint32_t state);
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400291 void (*modifiers)(struct weston_keyboard_grab *grab, uint32_t serial,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400292 uint32_t mods_depressed, uint32_t mods_latched,
293 uint32_t mods_locked, uint32_t group);
Jonas Ådahl1ea343e2013-10-25 23:18:05 +0200294 void (*cancel)(struct weston_keyboard_grab *grab);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400295};
296
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400297struct weston_keyboard_grab {
298 const struct weston_keyboard_grab_interface *interface;
299 struct weston_keyboard *keyboard;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400300};
301
Kristian Høgsberge329f362013-05-06 22:19:57 -0400302struct weston_touch_grab;
303struct weston_touch_grab_interface {
304 void (*down)(struct weston_touch_grab *grab,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400305 uint32_t time,
306 int touch_id,
307 wl_fixed_t sx,
308 wl_fixed_t sy);
Kristian Høgsberge329f362013-05-06 22:19:57 -0400309 void (*up)(struct weston_touch_grab *grab,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400310 uint32_t time,
311 int touch_id);
Kristian Høgsberge329f362013-05-06 22:19:57 -0400312 void (*motion)(struct weston_touch_grab *grab,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400313 uint32_t time,
314 int touch_id,
315 wl_fixed_t sx,
316 wl_fixed_t sy);
Jonas Ådahl1679f232014-04-12 09:39:51 +0200317 void (*frame)(struct weston_touch_grab *grab);
Jonas Ådahl1ea343e2013-10-25 23:18:05 +0200318 void (*cancel)(struct weston_touch_grab *grab);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400319};
320
Kristian Høgsberge329f362013-05-06 22:19:57 -0400321struct weston_touch_grab {
322 const struct weston_touch_grab_interface *interface;
323 struct weston_touch *touch;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400324};
325
Kristian Høgsberg5e76a492013-07-25 16:09:37 -0700326struct weston_data_offer {
Jason Ekstrand8a4a9eb2013-06-14 10:07:55 -0500327 struct wl_resource *resource;
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700328 struct weston_data_source *source;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400329 struct wl_listener source_destroy_listener;
Carlos Garnacho9c931792016-01-18 23:52:12 +0100330 uint32_t dnd_actions;
331 enum wl_data_device_manager_dnd_action preferred_dnd_action;
332 bool in_ask;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400333};
334
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700335struct weston_data_source {
Jason Ekstrand8a4a9eb2013-06-14 10:07:55 -0500336 struct wl_resource *resource;
337 struct wl_signal destroy_signal;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400338 struct wl_array mime_types;
Carlos Garnacho78d4bf92016-01-15 21:14:23 +0100339 struct weston_data_offer *offer;
340 struct weston_seat *seat;
341 bool accepted;
Carlos Garnacho9c931792016-01-18 23:52:12 +0100342 bool actions_set;
343 uint32_t dnd_actions;
344 enum wl_data_device_manager_dnd_action current_dnd_action;
Carlos Garnachob2889882016-01-15 21:14:26 +0100345 enum wl_data_device_manager_dnd_action compositor_action;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400346
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700347 void (*accept)(struct weston_data_source *source,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400348 uint32_t serial, const char *mime_type);
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700349 void (*send)(struct weston_data_source *source,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400350 const char *mime_type, int32_t fd);
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700351 void (*cancel)(struct weston_data_source *source);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400352};
353
Jonas Ådahl2cbf2932015-07-22 12:05:38 +0800354struct weston_pointer_client {
355 struct wl_list link;
356 struct wl_client *client;
357 struct wl_list pointer_resources;
Jonas Ådahl30d61d82014-10-22 21:21:17 +0200358 struct wl_list relative_pointer_resources;
Jonas Ådahl2cbf2932015-07-22 12:05:38 +0800359};
360
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400361struct weston_pointer {
Kristian Høgsberge3148752013-05-06 23:19:49 -0400362 struct weston_seat *seat;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400363
Jonas Ådahl2cbf2932015-07-22 12:05:38 +0800364 struct wl_list pointer_clients;
365
Jason Ekstranda7af7042013-10-12 22:38:11 -0500366 struct weston_view *focus;
Jonas Ådahl2cbf2932015-07-22 12:05:38 +0800367 struct weston_pointer_client *focus_client;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400368 uint32_t focus_serial;
Giulio Camuffo576fe2a2013-11-20 18:00:24 +0100369 struct wl_listener focus_view_listener;
370 struct wl_listener focus_resource_listener;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400371 struct wl_signal focus_signal;
Giulio Camuffo6fcb3782013-11-14 23:42:50 +0100372 struct wl_signal motion_signal;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400373
Jason Ekstranda7af7042013-10-12 22:38:11 -0500374 struct weston_view *sprite;
Kristian Høgsberg195b8692013-05-08 15:02:05 -0400375 struct wl_listener sprite_destroy_listener;
376 int32_t hotspot_x, hotspot_y;
377
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400378 struct weston_pointer_grab *grab;
379 struct weston_pointer_grab default_grab;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400380 wl_fixed_t grab_x, grab_y;
381 uint32_t grab_button;
382 uint32_t grab_serial;
383 uint32_t grab_time;
384
385 wl_fixed_t x, y;
Kristian Høgsbergdb1fccb2014-02-05 17:14:42 -0800386 wl_fixed_t sx, sy;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400387 uint32_t button_count;
Ander Conselvan de Oliveiraf84327a2014-01-29 18:47:51 +0200388
389 struct wl_listener output_destroy_listener;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400390};
391
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400392
Kristian Høgsberge329f362013-05-06 22:19:57 -0400393struct weston_touch {
Kristian Høgsberge3148752013-05-06 23:19:49 -0400394 struct weston_seat *seat;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400395
396 struct wl_list resource_list;
Neil Roberts96d790e2013-09-19 17:32:00 +0100397 struct wl_list focus_resource_list;
Jason Ekstranda7af7042013-10-12 22:38:11 -0500398 struct weston_view *focus;
Giulio Camuffo576fe2a2013-11-20 18:00:24 +0100399 struct wl_listener focus_view_listener;
400 struct wl_listener focus_resource_listener;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400401 uint32_t focus_serial;
402 struct wl_signal focus_signal;
403
Jonas Ådahl9484b692013-12-02 22:05:03 +0100404 uint32_t num_tp;
405
Kristian Høgsberge329f362013-05-06 22:19:57 -0400406 struct weston_touch_grab *grab;
407 struct weston_touch_grab default_grab;
Neil Roberts306fe082013-10-03 16:43:06 +0100408 int grab_touch_id;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400409 wl_fixed_t grab_x, grab_y;
410 uint32_t grab_serial;
411 uint32_t grab_time;
412};
413
Jonas Ådahld2510102014-10-05 21:39:14 +0200414void
415weston_pointer_motion_to_abs(struct weston_pointer *pointer,
416 struct weston_pointer_motion_event *event,
417 wl_fixed_t *x, wl_fixed_t *y);
418
Kristian Høgsberga4036bb2013-05-07 23:52:07 -0400419struct weston_pointer *
Giulio Camuffocdb4d292013-11-14 23:42:53 +0100420weston_pointer_create(struct weston_seat *seat);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400421void
Kristian Høgsberga4036bb2013-05-07 23:52:07 -0400422weston_pointer_destroy(struct weston_pointer *pointer);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400423void
Jonas Ådahl0336ca02014-10-04 16:28:29 +0200424weston_pointer_send_axis(struct weston_pointer *pointer,
Peter Hutterer89b6a492016-01-18 15:58:17 +1000425 uint32_t time,
426 struct weston_pointer_axis_event *event);
Jonas Ådahl0336ca02014-10-04 16:28:29 +0200427void
Peter Hutterer87743e92016-01-18 16:38:22 +1000428weston_pointer_send_axis_source(struct weston_pointer *pointer,
429 uint32_t source);
430void
431weston_pointer_send_frame(struct weston_pointer *pointer);
432
433void
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400434weston_pointer_set_focus(struct weston_pointer *pointer,
Jason Ekstranda7af7042013-10-12 22:38:11 -0500435 struct weston_view *view,
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400436 wl_fixed_t sx, wl_fixed_t sy);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400437void
Derek Foremanf9318d12015-05-11 15:40:11 -0500438weston_pointer_clear_focus(struct weston_pointer *pointer);
439void
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400440weston_pointer_start_grab(struct weston_pointer *pointer,
441 struct weston_pointer_grab *grab);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400442void
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400443weston_pointer_end_grab(struct weston_pointer *pointer);
Rob Bradford806d8c02013-06-25 18:56:41 +0100444void
445weston_pointer_clamp(struct weston_pointer *pointer,
446 wl_fixed_t *fx, wl_fixed_t *fy);
Giulio Camuffo1959ab82013-11-14 23:42:52 +0100447void
448weston_pointer_move(struct weston_pointer *pointer,
Jonas Ådahld2510102014-10-05 21:39:14 +0200449 struct weston_pointer_motion_event *event);
Giulio Camuffocdb4d292013-11-14 23:42:53 +0100450void
451weston_pointer_set_default_grab(struct weston_pointer *pointer,
452 const struct weston_pointer_grab_interface *interface);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400453
Kristian Høgsberga4036bb2013-05-07 23:52:07 -0400454struct weston_keyboard *
455weston_keyboard_create(void);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400456void
Kristian Høgsberga4036bb2013-05-07 23:52:07 -0400457weston_keyboard_destroy(struct weston_keyboard *keyboard);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400458void
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400459weston_keyboard_set_focus(struct weston_keyboard *keyboard,
Kristian Høgsbergfe7aa902013-05-08 09:54:37 -0400460 struct weston_surface *surface);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400461void
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400462weston_keyboard_start_grab(struct weston_keyboard *device,
463 struct weston_keyboard_grab *grab);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400464void
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400465weston_keyboard_end_grab(struct weston_keyboard *keyboard);
Giulio Camuffo6ef444d2014-08-28 19:44:09 +0300466int
467/*
468 * 'mask' and 'value' should be a bitwise mask of one or more
469 * valued of the weston_keyboard_locks enum.
470 */
471weston_keyboard_set_locks(struct weston_keyboard *keyboard,
472 uint32_t mask, uint32_t value);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400473
Kristian Høgsberga4036bb2013-05-07 23:52:07 -0400474struct weston_touch *
475weston_touch_create(void);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400476void
Kristian Høgsberga4036bb2013-05-07 23:52:07 -0400477weston_touch_destroy(struct weston_touch *touch);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400478void
Derek Foreman4c93c082015-04-30 16:45:41 -0500479weston_touch_set_focus(struct weston_touch *touch,
Jason Ekstranda7af7042013-10-12 22:38:11 -0500480 struct weston_view *view);
Michael Fua2bb7912013-07-23 15:51:06 +0800481void
Kristian Høgsberge329f362013-05-06 22:19:57 -0400482weston_touch_start_grab(struct weston_touch *device,
483 struct weston_touch_grab *grab);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400484void
Kristian Høgsberge329f362013-05-06 22:19:57 -0400485weston_touch_end_grab(struct weston_touch *touch);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400486
487void
Kristian Høgsberge3148752013-05-06 23:19:49 -0400488wl_data_device_set_keyboard_focus(struct weston_seat *seat);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400489
490int
491wl_data_device_manager_init(struct wl_display *display);
492
493
494void
Kristian Høgsberge3148752013-05-06 23:19:49 -0400495weston_seat_set_selection(struct weston_seat *seat,
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700496 struct weston_data_source *source, uint32_t serial);
Giulio Camuffodddf9e62015-05-01 12:59:35 +0300497void
498weston_seat_send_selection(struct weston_seat *seat, struct wl_client *client);
499
Kristian Høgsberg85de9c22013-09-04 20:44:26 -0700500int
Xiong Zhangfd51e7b2013-11-25 18:42:49 +0800501weston_pointer_start_drag(struct weston_pointer *pointer,
Kristian Høgsberg85de9c22013-09-04 20:44:26 -0700502 struct weston_data_source *source,
503 struct weston_surface *icon,
504 struct wl_client *client);
Xiong Zhangfd51e7b2013-11-25 18:42:49 +0800505int
506weston_touch_start_drag(struct weston_touch *touch,
507 struct weston_data_source *source,
508 struct weston_surface *icon,
509 struct wl_client *client);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400510
Daniel Stoned65b9092012-05-30 16:32:05 +0100511struct weston_xkb_info {
512 struct xkb_keymap *keymap;
Daniel Stoneb7452fe2012-06-01 12:14:06 +0100513 int keymap_fd;
514 size_t keymap_size;
515 char *keymap_area;
Andrew Wedgbury9a6f02a2013-09-05 13:31:40 +0000516 int32_t ref_count;
Daniel Stoneabb9dcd2012-06-22 13:21:33 +0100517 xkb_mod_index_t shift_mod;
518 xkb_mod_index_t caps_mod;
Daniel Stoned65b9092012-05-30 16:32:05 +0100519 xkb_mod_index_t ctrl_mod;
520 xkb_mod_index_t alt_mod;
Daniel Stoneabb9dcd2012-06-22 13:21:33 +0100521 xkb_mod_index_t mod2_mod;
522 xkb_mod_index_t mod3_mod;
Daniel Stoned65b9092012-05-30 16:32:05 +0100523 xkb_mod_index_t super_mod;
Daniel Stoneabb9dcd2012-06-22 13:21:33 +0100524 xkb_mod_index_t mod5_mod;
Daniel Stoned65b9092012-05-30 16:32:05 +0100525 xkb_led_index_t num_led;
526 xkb_led_index_t caps_led;
527 xkb_led_index_t scroll_led;
528};
529
Jan Arne Petersena75a7892013-01-16 21:26:50 +0100530struct weston_keyboard {
Kristian Høgsberge3148752013-05-06 23:19:49 -0400531 struct weston_seat *seat;
Jan Arne Petersena75a7892013-01-16 21:26:50 +0100532
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400533 struct wl_list resource_list;
Neil Roberts96d790e2013-09-19 17:32:00 +0100534 struct wl_list focus_resource_list;
Kristian Høgsbergfe7aa902013-05-08 09:54:37 -0400535 struct weston_surface *focus;
Giulio Camuffo576fe2a2013-11-20 18:00:24 +0100536 struct wl_listener focus_resource_listener;
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400537 uint32_t focus_serial;
538 struct wl_signal focus_signal;
539
540 struct weston_keyboard_grab *grab;
541 struct weston_keyboard_grab default_grab;
542 uint32_t grab_key;
543 uint32_t grab_serial;
544 uint32_t grab_time;
545
546 struct wl_array keys;
547
548 struct {
549 uint32_t mods_depressed;
550 uint32_t mods_latched;
551 uint32_t mods_locked;
552 uint32_t group;
553 } modifiers;
554
555 struct weston_keyboard_grab input_method_grab;
Jan Arne Petersena75a7892013-01-16 21:26:50 +0100556 struct wl_resource *input_method_resource;
Jonas Ådahl7395ea02013-12-03 09:14:26 +0100557
558 struct weston_xkb_info *xkb_info;
559 struct {
560 struct xkb_state *state;
561 enum weston_led leds;
562 } xkb_state;
563 struct xkb_keymap *pending_keymap;
Jan Arne Petersena75a7892013-01-16 21:26:50 +0100564};
565
Daniel Stone37816df2012-05-16 18:45:18 +0100566struct weston_seat {
Kristian Høgsberge3148752013-05-06 23:19:49 -0400567 struct wl_list base_resource_list;
568
Kristian Høgsbergaaadc772013-07-08 16:20:31 -0400569 struct wl_global *global;
Derek Foreman1281a362015-07-31 16:55:32 -0500570 struct weston_pointer *pointer_state;
571 struct weston_keyboard *keyboard_state;
572 struct weston_touch *touch_state;
Jonas Ådahld6e1c342013-10-17 23:04:05 +0200573 int pointer_device_count;
574 int keyboard_device_count;
575 int touch_device_count;
Kristian Høgsberge3148752013-05-06 23:19:49 -0400576
Rob Bradford66bd9f52013-06-25 18:56:42 +0100577 struct weston_output *output; /* constraint */
578
Giulio Camuffo5085a752013-03-25 21:42:45 +0100579 struct wl_signal destroy_signal;
Jason Ekstranda4ab5422014-04-02 19:53:45 -0500580 struct wl_signal updated_caps_signal;
Daniel Stone74419a22012-05-30 16:32:02 +0100581
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500582 struct weston_compositor *compositor;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500583 struct wl_list link;
Daniel Stone496ca172012-05-30 16:31:42 +0100584 enum weston_keyboard_modifier modifier_state;
Kristian Høgsbergfe7aa902013-05-08 09:54:37 -0400585 struct weston_surface *saved_kbd_focus;
Ander Conselvan de Oliveira71b1d0c2012-03-16 17:25:11 +0200586 struct wl_listener saved_kbd_focus_listener;
Kristian Høgsberg054c50a2013-05-08 15:27:47 -0400587 struct wl_list drag_resource_list;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500588
Kristian Høgsberge3148752013-05-06 23:19:49 -0400589 uint32_t selection_serial;
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700590 struct weston_data_source *selection_data_source;
Kristian Høgsberge3148752013-05-06 23:19:49 -0400591 struct wl_listener selection_data_source_listener;
592 struct wl_signal selection_signal;
593
Daniel Stone8c8164f2012-05-30 16:31:45 +0100594 void (*led_update)(struct weston_seat *ws, enum weston_led leds);
595
Jan Arne Petersene829adc2012-08-10 16:47:22 +0200596 struct input_method *input_method;
Rob Bradford9af5f9e2013-05-31 18:09:50 +0100597 char *seat_name;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500598};
599
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500600enum {
Bryce Harringtonc2be8572015-12-11 13:11:37 -0800601 WESTON_COMPOSITOR_ACTIVE, /* normal rendering and events */
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500602 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
Philipp Brüschweiler57edf7f2013-03-29 13:01:56 +0100603 WESTON_COMPOSITOR_OFFSCREEN, /* no rendering, no frame events */
Bryce Harringtonc2be8572015-12-11 13:11:37 -0800604 WESTON_COMPOSITOR_SLEEPING /* same as offscreen, but also set dpms
Philipp Brüschweiler57edf7f2013-03-29 13:01:56 +0100605 * to off */
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500606};
607
Giulio Camuffo412e6a52014-07-09 22:12:56 +0300608struct weston_layer_entry {
609 struct wl_list link;
610 struct weston_layer *layer;
611};
612
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -0500613struct weston_layer {
Giulio Camuffo412e6a52014-07-09 22:12:56 +0300614 struct weston_layer_entry view_list;
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -0500615 struct wl_list link;
Giulio Camuffo95ec0f92014-07-09 22:12:57 +0300616 pixman_box32_t mask;
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -0500617};
618
Kristian Høgsberg65a11e12012-08-03 11:30:18 -0400619struct weston_plane {
Xiong Zhang97116532013-10-23 13:58:31 +0800620 struct weston_compositor *compositor;
Pekka Paalanen502f5e02015-02-23 14:08:25 +0200621 pixman_region32_t damage; /**< in global coords */
Ander Conselvan de Oliveirae1bd5a02013-03-05 17:30:29 +0200622 pixman_region32_t clip;
Kristian Høgsberg65a11e12012-08-03 11:30:18 -0400623 int32_t x, y;
Ander Conselvan de Oliveira8ad19822013-03-05 17:30:27 +0200624 struct wl_list link;
Kristian Høgsberg65a11e12012-08-03 11:30:18 -0400625};
626
Kristian Høgsbergfa1be022012-09-05 22:49:55 -0400627struct weston_renderer {
John Kåre Alsakera95b2d62012-11-13 19:10:21 +0100628 int (*read_pixels)(struct weston_output *output,
629 pixman_format_code_t format, void *pixels,
630 uint32_t x, uint32_t y,
631 uint32_t width, uint32_t height);
Kristian Høgsbergfa1be022012-09-05 22:49:55 -0400632 void (*repaint_output)(struct weston_output *output,
633 pixman_region32_t *output_damage);
634 void (*flush_damage)(struct weston_surface *surface);
Jason Ekstrand6bd62942013-06-20 20:38:23 -0500635 void (*attach)(struct weston_surface *es, struct weston_buffer *buffer);
John Kåre Alsaker878f4492012-11-13 19:10:23 +0100636 void (*surface_set_color)(struct weston_surface *surface,
637 float red, float green,
638 float blue, float alpha);
Vasily Khoruzhick52cfd612013-01-08 19:09:01 +0300639 void (*destroy)(struct weston_compositor *ec);
Pekka Paalanenc647ed72015-02-09 13:16:57 +0200640
641
642 /** See weston_surface_get_content_size() */
643 void (*surface_get_content_size)(struct weston_surface *surface,
644 int *width, int *height);
645
646 /** See weston_surface_copy_content() */
647 int (*surface_copy_content)(struct weston_surface *surface,
648 void *target, size_t size,
649 int src_x, int src_y,
650 int width, int height);
Pekka Paalanen230f3b12014-09-29 14:18:40 -0400651
652 /** See weston_compositor_import_dmabuf() */
653 bool (*import_dmabuf)(struct weston_compositor *ec,
654 struct linux_dmabuf_buffer *buffer);
Kristian Høgsbergfa1be022012-09-05 22:49:55 -0400655};
656
Pekka Paalanen7bb65102013-05-22 18:03:04 +0300657enum weston_capability {
658 /* backend/renderer supports arbitrary rotation */
659 WESTON_CAP_ROTATION_ANY = 0x0001,
Pekka Paalanen4fc5dd02013-05-22 18:03:05 +0300660
661 /* screencaptures need to be y-flipped */
662 WESTON_CAP_CAPTURE_YFLIP = 0x0002,
Jason Ekstrand9fc71512014-04-02 19:53:46 -0500663
Bryce Harringtona86c3ee2015-03-18 18:42:00 -0700664 /* backend/renderer has a separate cursor plane */
Jason Ekstrand9fc71512014-04-02 19:53:46 -0500665 WESTON_CAP_CURSOR_PLANE = 0x0004,
666
667 /* backend supports setting arbitrary resolutions */
668 WESTON_CAP_ARBITRARY_MODES = 0x0008,
Pekka Paalanen380adf52015-02-16 14:39:11 +0200669
670 /* renderer supports weston_view_set_mask() clipping */
671 WESTON_CAP_VIEW_CLIP_MASK = 0x0010,
Pekka Paalanen7bb65102013-05-22 18:03:04 +0300672};
673
Giulio Camuffoe3c0d8a2015-10-17 19:24:13 +0300674/* Configuration struct for an output.
675 *
676 * This struct is used to pass the configuration for an output
677 * to the compositor backend when creating a new output.
678 * The backend can subclass this struct to handle backend
679 * specific data.
680 */
681struct weston_backend_output_config {
682 uint32_t transform;
Bryce Harrington32c32112015-10-23 15:29:23 -0700683 uint32_t width;
684 uint32_t height;
685 uint32_t scale;
Giulio Camuffoe3c0d8a2015-10-17 19:24:13 +0300686};
687
688/* Configuration struct for a backend.
689 *
690 * This struct carries the configuration for a backend, and it's
691 * passed to the backend's init entry point. The backend will
692 * likely want to subclass this in order to handle backend specific
693 * data.
Bryce Harrington20b66c32016-04-15 20:28:29 -0700694 *
695 * NOTE: Alternate designs were proposed (Feb 2016) for using opaque
696 * structures[1] and for section+key/value getter/setters[2]. The rationale
697 * for selecting the transparent structure design is based on several
698 * assumptions[3] which may require re-evaluating the design choice if they
699 * fail to hold.
700 *
701 * 1: https://lists.freedesktop.org/archives/wayland-devel/2016-February/026989.html
702 * 2: https://lists.freedesktop.org/archives/wayland-devel/2016-February/026929.html
703 * 3: https://lists.freedesktop.org/archives/wayland-devel/2016-February/027228.html
Giulio Camuffoe3c0d8a2015-10-17 19:24:13 +0300704 */
705struct weston_backend_config {
Bryce Harrington20b66c32016-04-15 20:28:29 -0700706 /** Major version for the backend-specific config struct
707 *
708 * This version must match exactly what the backend expects, otherwise
709 * the struct is incompatible.
710 */
711 uint32_t struct_version;
712
713 /** Minor version of the backend-specific config struct
714 *
715 * This must be set to sizeof(struct backend-specific config).
716 * If the value here is smaller than what the backend expects, the
717 * extra config members will assume their default values.
718 *
719 * A value greater than what the backend expects is incompatible.
720 */
721 size_t struct_size;
Giulio Camuffoe3c0d8a2015-10-17 19:24:13 +0300722};
723
Giulio Camuffo954f1832014-10-11 18:27:30 +0300724struct weston_backend {
Giulio Camuffoe3c0d8a2015-10-17 19:24:13 +0300725 void (*destroy)(struct weston_compositor *compositor);
726 void (*restore)(struct weston_compositor *compositor);
Giulio Camuffo954f1832014-10-11 18:27:30 +0300727};
728
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500729struct weston_compositor {
Kristian Høgsberg02e79dc2012-04-12 09:55:26 -0400730 struct wl_signal destroy_signal;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500731
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500732 struct wl_display *wl_display;
Tiago Vignattibc052c92012-04-19 16:18:18 +0300733 struct weston_shell_interface shell_interface;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500734
Tiago Vignattifb2adba2013-06-12 15:43:21 -0300735 /* surface signals */
Kristian Høgsbergf03a04a2014-04-06 22:04:50 -0700736 struct wl_signal create_surface_signal;
Kristian Høgsberg02e79dc2012-04-12 09:55:26 -0400737 struct wl_signal activate_signal;
Tiago Vignattifb2adba2013-06-12 15:43:21 -0300738 struct wl_signal transform_signal;
739
Tiago Vignatti1d01b012012-09-27 17:48:36 +0300740 struct wl_signal kill_signal;
Ander Conselvan de Oliveiraa4575632013-02-21 18:35:23 +0200741 struct wl_signal idle_signal;
742 struct wl_signal wake_signal;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500743
Jan Arne Petersen42feced2012-06-21 21:52:17 +0200744 struct wl_signal show_input_panel_signal;
745 struct wl_signal hide_input_panel_signal;
Jan Arne Petersen14da96b2013-04-18 16:47:28 +0200746 struct wl_signal update_input_panel_signal;
Jan Arne Petersen42feced2012-06-21 21:52:17 +0200747
Jan Arne Petersen674fd1d2012-11-18 19:06:42 +0100748 struct wl_signal seat_created_signal;
Richard Hughes59d5da72013-05-01 21:52:11 +0100749 struct wl_signal output_created_signal;
Ander Conselvan de Oliveiraf84327a2014-01-29 18:47:51 +0200750 struct wl_signal output_destroyed_signal;
Ander Conselvan de Oliveiraa8a9baf2014-01-29 18:47:52 +0200751 struct wl_signal output_moved_signal;
David Fort0de859e2016-05-27 23:22:57 +0200752 struct wl_signal output_resized_signal; /* callback argument: resized output */
Jan Arne Petersen674fd1d2012-11-18 19:06:42 +0100753
Kristian Høgsberg61741a22013-09-17 16:02:57 -0700754 struct wl_signal session_signal;
755 int session_active;
756
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -0500757 struct weston_layer fade_layer;
758 struct weston_layer cursor_layer;
759
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500760 struct wl_list output_list;
Daniel Stone37816df2012-05-16 18:45:18 +0100761 struct wl_list seat_list;
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -0500762 struct wl_list layer_list;
Pekka Paalanen20c7e552016-03-30 14:08:24 +0300763 struct wl_list view_list; /* struct weston_view::link */
Ander Conselvan de Oliveira8ad19822013-03-05 17:30:27 +0200764 struct wl_list plane_list;
Daniel Stone325fc2d2012-05-30 16:31:58 +0100765 struct wl_list key_binding_list;
Daniel Stone96d47c02013-11-19 11:37:12 +0100766 struct wl_list modifier_binding_list;
Daniel Stone325fc2d2012-05-30 16:31:58 +0100767 struct wl_list button_binding_list;
Neil Robertsa28c6932013-10-03 16:43:04 +0100768 struct wl_list touch_binding_list;
Daniel Stone325fc2d2012-05-30 16:31:58 +0100769 struct wl_list axis_binding_list;
Ander Conselvan de Oliveirac509d2b2012-11-08 17:20:45 +0200770 struct wl_list debug_binding_list;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500771
772 uint32_t state;
773 struct wl_event_source *idle_source;
774 uint32_t idle_inhibit;
Philipp Brüschweiler4b409c32013-03-10 14:37:04 +0100775 int idle_time; /* timeout, s */
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500776
Giulio Camuffocdb4d292013-11-14 23:42:53 +0100777 const struct weston_pointer_grab_interface *default_pointer_grab;
778
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500779 /* Repaint state. */
Kristian Høgsberg65a11e12012-08-03 11:30:18 -0400780 struct weston_plane primary_plane;
Pekka Paalanen7bb65102013-05-22 18:03:04 +0300781 uint32_t capabilities; /* combination of enum weston_capability */
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500782
Kristian Høgsbergfa1be022012-09-05 22:49:55 -0400783 struct weston_renderer *renderer;
784
John Kåre Alsakerf9e710b2012-11-13 19:10:22 +0100785 pixman_format_code_t read_format;
Pekka Paalanen52bfbaa2012-04-11 16:19:37 +0300786
Giulio Camuffo954f1832014-10-11 18:27:30 +0300787 struct weston_backend *backend;
Kristian Høgsberg3466bc82012-01-03 11:29:15 -0500788
Kristian Høgsberg05ad1e42013-09-17 14:41:03 -0700789 struct weston_launcher *launcher;
Casey Dahlin58ba1372012-04-19 22:50:08 -0400790
Pekka Paalanen827b5d22016-06-29 11:54:26 +0200791 struct wl_list plugin_api_list; /* struct weston_plugin_api::link */
792
Casey Dahlin58ba1372012-04-19 22:50:08 -0400793 uint32_t output_id_pool;
Daniel Stone855028f2012-05-01 20:37:10 +0100794
Daniel Stonee379da92012-05-30 16:32:04 +0100795 struct xkb_rule_names xkb_names;
796 struct xkb_context *xkb_context;
Andrew Wedgbury9a6f02a2013-09-05 13:31:40 +0000797 struct weston_xkb_info *xkb_info;
Matt Roper01a92732013-06-24 16:52:44 +0100798
799 /* Raw keyboard processing (no libxkbcommon initialization or handling) */
800 int use_xkbcommon;
Jonny Lamb66a41a02014-08-12 14:58:25 +0200801
802 int32_t kb_repeat_rate;
803 int32_t kb_repeat_delay;
Pekka Paalanenb5eedad2014-09-23 22:08:45 -0400804
Bob Ham91880f12016-01-12 10:21:47 +0000805 bool vt_switching;
806
Pekka Paalanenb5eedad2014-09-23 22:08:45 -0400807 clockid_t presentation_clock;
Pekka Paalanen0513a952014-05-21 16:17:27 +0300808 int32_t repaint_msec;
Frederic Plourdec336f062014-10-29 14:44:33 -0400809
Jonas Ådahl94e2e2d2014-10-18 18:42:19 +0200810 unsigned int activate_serial;
811
Frederic Plourdec336f062014-10-29 14:44:33 -0400812 int exit_code;
Giulio Camuffo459137b2014-10-11 23:56:24 +0300813
814 void *user_data;
815 void (*exit)(struct weston_compositor *c);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500816};
817
Jason Ekstrand6bd62942013-06-20 20:38:23 -0500818struct weston_buffer {
819 struct wl_resource *resource;
820 struct wl_signal destroy_signal;
821 struct wl_listener destroy_listener;
822
823 union {
824 struct wl_shm_buffer *shm_buffer;
Jason Ekstranda85118c2013-06-27 20:17:02 -0500825 void *legacy_buffer;
Jason Ekstrand6bd62942013-06-20 20:38:23 -0500826 };
827 int32_t width, height;
828 uint32_t busy_count;
Stanislav Vorobiovbfbb8e52013-08-29 11:36:44 +0400829 int y_inverted;
Jason Ekstrand6bd62942013-06-20 20:38:23 -0500830};
831
Pekka Paalanende685b82012-12-04 15:58:12 +0200832struct weston_buffer_reference {
Jason Ekstrand6bd62942013-06-20 20:38:23 -0500833 struct weston_buffer *buffer;
Pekka Paalanende685b82012-12-04 15:58:12 +0200834 struct wl_listener destroy_listener;
835};
836
Pekka Paalanen1fd9c0f2013-11-26 18:19:41 +0100837struct weston_buffer_viewport {
Pekka Paalanen952b6c82014-03-14 14:38:15 +0200838 struct {
839 /* wl_surface.set_buffer_transform */
840 uint32_t transform;
Pekka Paalanen1fd9c0f2013-11-26 18:19:41 +0100841
Pekka Paalanen952b6c82014-03-14 14:38:15 +0200842 /* wl_surface.set_scaling_factor */
843 int32_t scale;
Jonny Lamb74130762013-11-26 18:19:46 +0100844
Pekka Paalanenf0cad482014-03-14 14:38:16 +0200845 /*
846 * If src_width != wl_fixed_from_int(-1),
847 * then and only then src_* are used.
848 */
Pekka Paalanen952b6c82014-03-14 14:38:15 +0200849 wl_fixed_t src_x, src_y;
850 wl_fixed_t src_width, src_height;
851 } buffer;
852
853 struct {
Pekka Paalanenf0cad482014-03-14 14:38:16 +0200854 /*
855 * If width == -1, the size is inferred from the buffer.
856 */
Pekka Paalanen952b6c82014-03-14 14:38:15 +0200857 int32_t width, height;
858 } surface;
George Kiagiadakis8f9e87f2014-06-13 18:14:20 +0200859
860 int changed;
Pekka Paalanen1fd9c0f2013-11-26 18:19:41 +0100861};
862
Kristian Høgsberg5e7e6f22012-02-23 16:11:59 -0500863struct weston_region {
Jason Ekstrand8895efc2013-06-14 10:07:56 -0500864 struct wl_resource *resource;
Kristian Høgsberg5e7e6f22012-02-23 16:11:59 -0500865 pixman_region32_t region;
866};
867
Jason Ekstranda7af7042013-10-12 22:38:11 -0500868/* Using weston_view transformations
Pekka Paalanen44ab69c2012-02-07 13:18:00 +0200869 *
Jason Ekstranda7af7042013-10-12 22:38:11 -0500870 * To add a transformation to a view, create a struct weston_transform, and
871 * add it to the list view->geometry.transformation_list. Whenever you
872 * change the list, anything under view->geometry, or anything in the
Pekka Paalanenc3ce7382013-03-08 14:56:49 +0200873 * weston_transforms linked into the list, you must call
Jason Ekstranda7af7042013-10-12 22:38:11 -0500874 * weston_view_geometry_dirty().
Pekka Paalanen44ab69c2012-02-07 13:18:00 +0200875 *
876 * The order in the list defines the order of transformations. Let the list
877 * contain the transformation matrices M1, ..., Mn as head to tail. The
Jason Ekstranda7af7042013-10-12 22:38:11 -0500878 * transformation is applied to view-local coordinate vector p as
Pekka Paalanen44ab69c2012-02-07 13:18:00 +0200879 * P = Mn * ... * M2 * M1 * p
880 * to produce the global coordinate vector P. The total transform
881 * Mn * ... * M2 * M1
Jason Ekstranda7af7042013-10-12 22:38:11 -0500882 * is cached in view->transform.matrix, and the inverse of it in
883 * view->transform.inverse.
Pekka Paalanen44ab69c2012-02-07 13:18:00 +0200884 *
Jason Ekstranda7af7042013-10-12 22:38:11 -0500885 * The list always contains view->transform.position transformation, which
886 * is the translation by view->geometry.x and y.
Pekka Paalanen44ab69c2012-02-07 13:18:00 +0200887 *
888 * If you want to apply a transformation in local coordinates, add your
889 * weston_transform to the head of the list. If you want to apply a
890 * transformation in global coordinates, add it to the tail of the list.
Pekka Paalanen483243f2013-03-08 14:56:50 +0200891 *
Jason Ekstranda7af7042013-10-12 22:38:11 -0500892 * If view->geometry.parent is set, the total transformation of this
893 * view will be the parent's total transformation and this transformation
Pekka Paalanen483243f2013-03-08 14:56:50 +0200894 * combined:
895 * Mparent * Mn * ... * M2 * M1
Pekka Paalanen44ab69c2012-02-07 13:18:00 +0200896 */
897
Jason Ekstranda7af7042013-10-12 22:38:11 -0500898struct weston_view {
899 struct weston_surface *surface;
900 struct wl_list surface_link;
Jason Ekstrand26ed73c2013-06-06 22:34:41 -0500901 struct wl_signal destroy_signal;
Jason Ekstranda7af7042013-10-12 22:38:11 -0500902
Pekka Paalanen20c7e552016-03-30 14:08:24 +0300903 struct wl_list link; /* weston_compositor::view_list */
Pekka Paalanen8844bf22015-02-18 16:30:47 +0200904 struct weston_layer_entry layer_link; /* part of geometry */
Kristian Høgsberg65a11e12012-08-03 11:30:18 -0400905 struct weston_plane *plane;
Pekka Paalanen2d6e5512015-02-18 16:06:46 +0200906
907 /* For weston_layer inheritance from another view */
Giulio Camuffo95ec0f92014-07-09 22:12:57 +0300908 struct weston_view *parent_view;
Jason Ekstranda7af7042013-10-12 22:38:11 -0500909
Jonas Ådahl94e2e2d2014-10-18 18:42:19 +0200910 unsigned int click_to_activate_serial;
911
Pekka Paalanen51723d52015-02-17 13:10:01 +0200912 pixman_region32_t clip; /* See weston_view_damage_below() */
Jason Ekstranda7af7042013-10-12 22:38:11 -0500913 float alpha; /* part of geometry, see below */
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500914
John Kåre Alsaker878f4492012-11-13 19:10:23 +0100915 void *renderer_state;
916
Pekka Paalanenbc0b7e72012-01-24 09:53:37 +0200917 /* Surface geometry state, mutable.
Pekka Paalanenc3ce7382013-03-08 14:56:49 +0200918 * If you change anything, call weston_surface_geometry_dirty().
Pekka Paalanenbc0b7e72012-01-24 09:53:37 +0200919 * That includes the transformations referenced from the list.
920 */
Pekka Paalanenc61eca62012-01-06 14:10:06 +0200921 struct {
John Kåre Alsaker490d02a2012-09-30 02:57:21 +0200922 float x, y; /* surface translation on display */
Pekka Paalanenba3cf952012-01-25 16:22:05 +0200923
Pekka Paalanenbc0b7e72012-01-24 09:53:37 +0200924 /* struct weston_transform */
925 struct wl_list transformation_list;
Pekka Paalanen483243f2013-03-08 14:56:50 +0200926
927 /* managed by weston_surface_set_transform_parent() */
Jason Ekstranda7af7042013-10-12 22:38:11 -0500928 struct weston_view *parent;
Pekka Paalanen483243f2013-03-08 14:56:50 +0200929 struct wl_listener parent_destroy_listener;
930 struct wl_list child_list; /* geometry.parent_link */
931 struct wl_list parent_link;
Pekka Paalanen380adf52015-02-16 14:39:11 +0200932
933 /* managed by weston_view_set_mask() */
934 bool scissor_enabled;
935 pixman_region32_t scissor; /* always a simple rect */
Pekka Paalanenbc0b7e72012-01-24 09:53:37 +0200936 } geometry;
937
938 /* State derived from geometry state, read-only.
Jason Ekstranda7af7042013-10-12 22:38:11 -0500939 * This is updated by weston_view_update_transform().
Pekka Paalanenbc0b7e72012-01-24 09:53:37 +0200940 */
941 struct {
Pekka Paalanenc3ce7382013-03-08 14:56:49 +0200942 int dirty;
943
Pekka Paalanenfbd00f12015-02-19 11:49:18 +0200944 /* Approximations in global coordinates:
945 * - boundingbox is guaranteed to include the whole view in
946 * the smallest possible single rectangle.
947 * - opaque is guaranteed to be fully opaque, though not
948 * necessarily include all opaque areas.
949 */
Pekka Paalanen6720d8f2012-01-25 15:17:40 +0200950 pixman_region32_t boundingbox;
Pekka Paalanen730d87e2012-02-09 16:39:38 +0200951 pixman_region32_t opaque;
Pekka Paalanen6720d8f2012-01-25 15:17:40 +0200952
Pekka Paalanenbc0b7e72012-01-24 09:53:37 +0200953 /* matrix and inverse are used only if enabled = 1.
954 * If enabled = 0, use x, y, width, height directly.
955 */
956 int enabled;
Pekka Paalanen061b7472012-01-12 15:00:57 +0200957 struct weston_matrix matrix;
Pekka Paalanend1f0ab62012-01-20 10:47:57 +0200958 struct weston_matrix inverse;
Pekka Paalanencd403622012-01-25 13:37:39 +0200959
960 struct weston_transform position; /* matrix from x, y */
Pekka Paalanenc61eca62012-01-06 14:10:06 +0200961 } transform;
962
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500963 /*
Pekka Paalanen130ae6e2016-03-30 14:33:33 +0300964 * The primary output for this view.
965 * Used for picking the output for driving internal animations on the
966 * view, inheriting the primary output for related views in shells, etc.
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500967 */
968 struct weston_output *output;
969
Casey Dahlin9074db52012-04-19 22:50:09 -0400970 /*
971 * A more complete representation of all outputs this surface is
972 * displayed on.
973 */
974 uint32_t output_mask;
Pekka Paalanenbf0e0312014-12-17 16:20:41 +0200975
976 /* Per-surface Presentation feedback flags, controlled by backend. */
977 uint32_t psf_flags;
Armin Krezovićf8486c32016-06-30 06:04:28 +0200978
979 bool is_mapped;
Jason Ekstranda7af7042013-10-12 22:38:11 -0500980};
981
Jason Ekstrand7b982072014-05-20 14:33:03 -0500982struct weston_surface_state {
983 /* wl_surface.attach */
984 int newly_attached;
985 struct weston_buffer *buffer;
986 struct wl_listener buffer_destroy_listener;
987 int32_t sx;
988 int32_t sy;
989
990 /* wl_surface.damage */
Derek Foreman152254b2015-11-26 14:17:48 -0600991 pixman_region32_t damage_surface;
992 /* wl_surface.damage_buffer */
993 pixman_region32_t damage_buffer;
Jason Ekstrand7b982072014-05-20 14:33:03 -0500994
995 /* wl_surface.set_opaque_region */
996 pixman_region32_t opaque;
997
998 /* wl_surface.set_input_region */
999 pixman_region32_t input;
1000
1001 /* wl_surface.frame */
1002 struct wl_list frame_callback_list;
1003
Pekka Paalanen133e4392014-09-23 22:08:46 -04001004 /* presentation.feedback */
1005 struct wl_list feedback_list;
1006
Jason Ekstrand7b982072014-05-20 14:33:03 -05001007 /* wl_surface.set_buffer_transform */
1008 /* wl_surface.set_scaling_factor */
Pekka Paalanene95ad5c2016-04-15 14:47:08 +03001009 /* wp_viewport.set_source */
1010 /* wp_viewport.set_destination */
Jason Ekstrand7b982072014-05-20 14:33:03 -05001011 struct weston_buffer_viewport buffer_viewport;
1012};
1013
Jonas Ådahlf7deb6a2016-07-22 17:50:26 +08001014struct weston_surface_activation_data {
1015 struct weston_surface *surface;
1016 struct weston_seat *seat;
1017};
1018
Jason Ekstranda7af7042013-10-12 22:38:11 -05001019struct weston_surface {
1020 struct wl_resource *resource;
Pekka Paalanenca790762015-04-17 14:23:38 +03001021 struct wl_signal destroy_signal; /* callback argument: this surface */
Jason Ekstranda7af7042013-10-12 22:38:11 -05001022 struct weston_compositor *compositor;
Jonas Ådahl5d9ca272016-07-22 17:48:03 +08001023 struct wl_signal commit_signal;
Pekka Paalanene508ce62015-02-19 13:59:55 +02001024
1025 /** Damage in local coordinates from the client, for tex upload. */
Jason Ekstranda7af7042013-10-12 22:38:11 -05001026 pixman_region32_t damage;
Pekka Paalanene508ce62015-02-19 13:59:55 +02001027
Jason Ekstranda7af7042013-10-12 22:38:11 -05001028 pixman_region32_t opaque; /* part of geometry, see below */
1029 pixman_region32_t input;
1030 int32_t width, height;
1031 int32_t ref_count;
1032
1033 /* Not for long-term storage. This exists for book-keeping while
1034 * iterating over surfaces and views
1035 */
Derek Foreman060cf112015-11-18 16:32:26 -06001036 bool touched;
Jason Ekstranda7af7042013-10-12 22:38:11 -05001037
1038 void *renderer_state;
1039
1040 struct wl_list views;
1041
1042 /*
1043 * Which output to vsync this surface to.
Pekka Paalanen130ae6e2016-03-30 14:33:33 +03001044 * Used to determine whether to send or queue frame events, and for
1045 * other client-visible syncing/throttling tied to the output
1046 * repaint cycle.
Jason Ekstranda7af7042013-10-12 22:38:11 -05001047 */
1048 struct weston_output *output;
1049
1050 /*
1051 * A more complete representation of all outputs this surface is
1052 * displayed on.
1053 */
1054 uint32_t output_mask;
Casey Dahlin9074db52012-04-19 22:50:09 -04001055
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001056 struct wl_list frame_callback_list;
Pekka Paalanen133e4392014-09-23 22:08:46 -04001057 struct wl_list feedback_list;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001058
Pekka Paalanende685b82012-12-04 15:58:12 +02001059 struct weston_buffer_reference buffer_ref;
Pekka Paalanen1fd9c0f2013-11-26 18:19:41 +01001060 struct weston_buffer_viewport buffer_viewport;
Pekka Paalanen0b4c5352014-03-14 14:38:17 +02001061 int32_t width_from_buffer; /* before applying viewport */
1062 int32_t height_from_buffer;
Derek Foreman0fd6d4e2014-10-10 09:36:45 -05001063 bool keep_buffer; /* for backends to prevent early release */
Alex Wu8811bf92012-02-28 18:07:54 +08001064
Pekka Paalanene95ad5c2016-04-15 14:47:08 +03001065 /* wp_viewport resource for this surface */
Pekka Paalanenb0420ae2014-01-08 15:39:17 +02001066 struct wl_resource *viewport_resource;
Jonny Lamb74130762013-11-26 18:19:46 +01001067
Pekka Paalanen5df44de2012-10-10 12:49:23 +03001068 /* All the pending state, that wl_surface.commit will apply. */
Jason Ekstrand7b982072014-05-20 14:33:03 -05001069 struct weston_surface_state pending;
Pekka Paalanen5df44de2012-10-10 12:49:23 +03001070
Jason Ekstrand1e059042014-10-16 10:55:19 -05001071 /* Matrices representating of the full transformation between
1072 * buffer and surface coordinates. These matrices are updated
1073 * using the weston_surface_build_buffer_matrix function. */
1074 struct weston_matrix buffer_to_surface_matrix;
1075 struct weston_matrix surface_to_buffer_matrix;
1076
Ander Conselvan de Oliveira093bfa32012-03-27 17:36:41 +03001077 /*
Jasper St. Pierred67b52a2014-04-28 11:19:27 -04001078 * If non-NULL, this function will be called on
1079 * wl_surface::commit after a new buffer has been set up for
1080 * this surface. The integer params are the sx and sy
1081 * parameters supplied to wl_surface::attach.
Ander Conselvan de Oliveira093bfa32012-03-27 17:36:41 +03001082 */
Jason Ekstrand918f2dd2013-12-02 21:01:53 -06001083 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
Giulio Camuffo7fe01b12013-03-28 18:02:42 +01001084 void *configure_private;
Pekka Paalanen8274d902014-08-06 19:36:51 +03001085 int (*get_label)(struct weston_surface *surface, char *buf, size_t len);
Pekka Paalanene67858b2013-04-25 13:57:42 +03001086
1087 /* Parent's list of its sub-surfaces, weston_subsurface:parent_link.
1088 * Contains also the parent itself as a dummy weston_subsurface,
1089 * if the list is not empty.
1090 */
1091 struct wl_list subsurface_list; /* weston_subsurface::parent_link */
1092 struct wl_list subsurface_list_pending; /* ...::parent_link_pending */
Pekka Paalanen50b67472014-10-01 15:02:41 +03001093
1094 /*
1095 * For tracking protocol role assignments. Different roles may
1096 * have the same configure hook, e.g. in shell.c. Configure hook
1097 * may get reset, this will not.
1098 * XXX: map configure functions 1:1 to roles, and never reset it,
1099 * and replace role_name with configure.
1100 */
1101 const char *role_name;
Pekka Paalanenb5026542014-11-12 15:09:24 +02001102
1103 struct weston_timeline_object timeline;
Armin Krezovićf8486c32016-06-30 06:04:28 +02001104
1105 bool is_mapped;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001106};
1107
Jason Ekstrande9d40e32014-05-20 11:23:53 -05001108struct weston_subsurface {
1109 struct wl_resource *resource;
1110
1111 /* guaranteed to be valid and non-NULL */
1112 struct weston_surface *surface;
1113 struct wl_listener surface_destroy_listener;
1114
1115 /* can be NULL */
1116 struct weston_surface *parent;
1117 struct wl_listener parent_destroy_listener;
1118 struct wl_list parent_link;
1119 struct wl_list parent_link_pending;
1120
1121 struct {
1122 int32_t x;
1123 int32_t y;
1124 int set;
1125 } position;
1126
Jason Ekstrand7b982072014-05-20 14:33:03 -05001127 int has_cached_data;
1128 struct weston_surface_state cached;
1129 struct weston_buffer_reference cached_buffer_ref;
Jason Ekstrande9d40e32014-05-20 11:23:53 -05001130
1131 int synchronized;
1132
1133 /* Used for constructing the view tree */
1134 struct wl_list unused_views;
1135};
1136
Daniel Stoned6da09e2012-06-22 13:21:29 +01001137enum weston_key_state_update {
1138 STATE_UPDATE_AUTOMATIC,
1139 STATE_UPDATE_NONE,
1140};
1141
Jonas Ådahl4361b4e2014-10-18 18:20:16 +02001142enum weston_activate_flag {
1143 WESTON_ACTIVATE_FLAG_NONE = 0,
1144 WESTON_ACTIVATE_FLAG_CONFIGURE = 1 << 0,
Jonas Ådahl94e2e2d2014-10-18 18:42:19 +02001145 WESTON_ACTIVATE_FLAG_CLICKED = 1 << 1,
Jonas Ådahl4361b4e2014-10-18 18:20:16 +02001146};
1147
Kristian Høgsberg9ddb8262012-01-04 21:30:29 -05001148void
Kristian Høgsbergaf4f2aa2013-02-15 20:53:20 -05001149weston_version(int *major, int *minor, int *micro);
1150
1151void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001152weston_view_update_transform(struct weston_view *view);
Pekka Paalanen460099f2012-01-20 16:48:25 +02001153
1154void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001155weston_view_geometry_dirty(struct weston_view *view);
Pekka Paalanenc3ce7382013-03-08 14:56:49 +02001156
1157void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001158weston_view_to_global_fixed(struct weston_view *view,
1159 wl_fixed_t sx, wl_fixed_t sy,
1160 wl_fixed_t *x, wl_fixed_t *y);
Daniel Stonebd3489b2012-05-08 17:17:53 +01001161void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001162weston_view_to_global_float(struct weston_view *view,
1163 float sx, float sy, float *x, float *y);
Pekka Paalanene0f3cb22012-01-24 09:59:29 +02001164
1165void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001166weston_view_from_global_float(struct weston_view *view,
1167 float x, float y, float *vx, float *vy);
Kristian Høgsbergecf6ede2012-09-05 21:59:35 -04001168void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001169weston_view_from_global(struct weston_view *view,
1170 int32_t x, int32_t y, int32_t *vx, int32_t *vy);
Daniel Stonebd3489b2012-05-08 17:17:53 +01001171void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001172weston_view_from_global_fixed(struct weston_view *view,
1173 wl_fixed_t x, wl_fixed_t y,
1174 wl_fixed_t *vx, wl_fixed_t *vy);
Pekka Paalanene0f3cb22012-01-24 09:59:29 +02001175
Derek Foremand1be3122014-09-18 16:46:49 -05001176void
Ander Conselvan de Oliveira0396ba22012-11-28 17:10:26 +02001177weston_surface_to_buffer_float(struct weston_surface *surface,
1178 float x, float y, float *bx, float *by);
1179pixman_box32_t
1180weston_surface_to_buffer_rect(struct weston_surface *surface,
1181 pixman_box32_t rect);
1182
Pekka Paalanene0f3cb22012-01-24 09:59:29 +02001183void
Pekka Paalanene54e31c2015-03-04 14:23:28 +02001184weston_surface_to_buffer_region(struct weston_surface *surface,
1185 pixman_region32_t *surface_region,
1186 pixman_region32_t *buffer_region);
1187
1188void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001189weston_spring_init(struct weston_spring *spring,
1190 double k, double current, double target);
1191void
1192weston_spring_update(struct weston_spring *spring, uint32_t msec);
1193int
1194weston_spring_done(struct weston_spring *spring);
1195
1196void
Jonas Ådahl94e2e2d2014-10-18 18:42:19 +02001197weston_view_activate(struct weston_view *view,
1198 struct weston_seat *seat,
1199 uint32_t flags);
1200
1201void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001202notify_motion(struct weston_seat *seat, uint32_t time,
Jonas Ådahld2510102014-10-05 21:39:14 +02001203 struct weston_pointer_motion_event *event);
Rob Bradfordc088e2c2013-03-27 15:59:43 +00001204void
1205notify_motion_absolute(struct weston_seat *seat, uint32_t time,
Giulio Camuffo90a6fc62016-03-22 17:44:54 +02001206 double x, double y);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001207void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001208notify_button(struct weston_seat *seat, uint32_t time, int32_t button,
Daniel Stone4dbadb12012-05-30 16:31:51 +01001209 enum wl_pointer_button_state state);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001210void
Peter Hutterer89b6a492016-01-18 15:58:17 +10001211notify_axis(struct weston_seat *seat, uint32_t time,
1212 struct weston_pointer_axis_event *event);
Scott Moreau210d0792012-03-22 10:47:01 -06001213void
Peter Hutterer87743e92016-01-18 16:38:22 +10001214notify_axis_source(struct weston_seat *seat, uint32_t source);
1215
1216void
1217notify_pointer_frame(struct weston_seat *seat);
1218
1219void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001220notify_key(struct weston_seat *seat, uint32_t time, uint32_t key,
Daniel Stone1b4e11f2012-06-22 13:21:37 +01001221 enum wl_keyboard_key_state state,
1222 enum weston_key_state_update update_state);
Daniel Stone05d58682012-06-22 13:21:38 +01001223void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001224notify_modifiers(struct weston_seat *seat, uint32_t serial);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001225
1226void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001227notify_pointer_focus(struct weston_seat *seat, struct weston_output *output,
Giulio Camuffo90a6fc62016-03-22 17:44:54 +02001228 double x, double y);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001229
1230void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001231notify_keyboard_focus_in(struct weston_seat *seat, struct wl_array *keys,
Daniel Stoned6da09e2012-06-22 13:21:29 +01001232 enum weston_key_state_update update_state);
1233void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001234notify_keyboard_focus_out(struct weston_seat *seat);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001235
1236void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001237notify_touch(struct weston_seat *seat, uint32_t time, int touch_id,
Giulio Camuffo90a6fc62016-03-22 17:44:54 +02001238 double x, double y, int touch_type);
Jonas Ådahl1679f232014-04-12 09:39:51 +02001239void
1240notify_touch_frame(struct weston_seat *seat);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001241
1242void
Derek Foreman3cc004a2015-11-06 15:56:09 -06001243notify_touch_cancel(struct weston_seat *seat);
1244
1245void
Giulio Camuffo412e6a52014-07-09 22:12:56 +03001246weston_layer_entry_insert(struct weston_layer_entry *list,
1247 struct weston_layer_entry *entry);
1248void
1249weston_layer_entry_remove(struct weston_layer_entry *entry);
1250void
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -05001251weston_layer_init(struct weston_layer *layer, struct wl_list *below);
1252
1253void
Giulio Camuffo95ec0f92014-07-09 22:12:57 +03001254weston_layer_set_mask(struct weston_layer *layer, int x, int y, int width, int height);
1255
1256void
1257weston_layer_set_mask_infinite(struct weston_layer *layer);
1258
1259void
Xiong Zhang97116532013-10-23 13:58:31 +08001260weston_plane_init(struct weston_plane *plane,
1261 struct weston_compositor *ec,
1262 int32_t x, int32_t y);
Kristian Høgsberg65a11e12012-08-03 11:30:18 -04001263void
1264weston_plane_release(struct weston_plane *plane);
1265
1266void
Ander Conselvan de Oliveira8ad19822013-03-05 17:30:27 +02001267weston_compositor_stack_plane(struct weston_compositor *ec,
1268 struct weston_plane *plane,
1269 struct weston_plane *above);
1270
Pekka Paalanen363aa7b2014-12-17 16:20:40 +02001271/* An invalid flag in presented_flags to catch logic errors. */
Pekka Paalanenb00c79b2016-02-18 16:53:27 +02001272#define WP_PRESENTATION_FEEDBACK_INVALID (1U << 31)
Pekka Paalanen363aa7b2014-12-17 16:20:40 +02001273
Ander Conselvan de Oliveira8ad19822013-03-05 17:30:27 +02001274void
Pekka Paalanenb5eedad2014-09-23 22:08:45 -04001275weston_output_finish_frame(struct weston_output *output,
Pekka Paalanen363aa7b2014-12-17 16:20:40 +02001276 const struct timespec *stamp,
1277 uint32_t presented_flags);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001278void
Kristian Høgsberg49952d12012-06-20 00:35:59 -04001279weston_output_schedule_repaint(struct weston_output *output);
1280void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001281weston_output_damage(struct weston_output *output);
1282void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001283weston_compositor_schedule_repaint(struct weston_compositor *compositor);
1284void
1285weston_compositor_fade(struct weston_compositor *compositor, float tint);
1286void
1287weston_compositor_damage_all(struct weston_compositor *compositor);
1288void
1289weston_compositor_unlock(struct weston_compositor *compositor);
1290void
1291weston_compositor_wake(struct weston_compositor *compositor);
1292void
Philipp Brüschweiler57edf7f2013-03-29 13:01:56 +01001293weston_compositor_offscreen(struct weston_compositor *compositor);
1294void
Ander Conselvan de Oliveira87524b62013-02-21 18:35:22 +02001295weston_compositor_sleep(struct weston_compositor *compositor);
Jason Ekstranda7af7042013-10-12 22:38:11 -05001296struct weston_view *
1297weston_compositor_pick_view(struct weston_compositor *compositor,
1298 wl_fixed_t x, wl_fixed_t y,
1299 wl_fixed_t *sx, wl_fixed_t *sy);
Ander Conselvan de Oliveira30eebc72012-02-15 17:02:57 +02001300
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001301
1302struct weston_binding;
Derek Foreman8ae2db52015-07-15 13:00:36 -05001303typedef void (*weston_key_binding_handler_t)(struct weston_keyboard *keyboard,
Daniel Stone325fc2d2012-05-30 16:31:58 +01001304 uint32_t time, uint32_t key,
1305 void *data);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001306struct weston_binding *
Daniel Stone325fc2d2012-05-30 16:31:58 +01001307weston_compositor_add_key_binding(struct weston_compositor *compositor,
1308 uint32_t key,
1309 enum weston_keyboard_modifier modifier,
1310 weston_key_binding_handler_t binding,
1311 void *data);
1312
Derek Foreman8ae2db52015-07-15 13:00:36 -05001313typedef void (*weston_modifier_binding_handler_t)(struct weston_keyboard *keyboard,
Daniel Stone96d47c02013-11-19 11:37:12 +01001314 enum weston_keyboard_modifier modifier,
1315 void *data);
1316struct weston_binding *
1317weston_compositor_add_modifier_binding(struct weston_compositor *compositor,
1318 enum weston_keyboard_modifier modifier,
1319 weston_modifier_binding_handler_t binding,
1320 void *data);
1321
Derek Foreman8ae2db52015-07-15 13:00:36 -05001322typedef void (*weston_button_binding_handler_t)(struct weston_pointer *pointer,
Daniel Stone325fc2d2012-05-30 16:31:58 +01001323 uint32_t time, uint32_t button,
1324 void *data);
1325struct weston_binding *
1326weston_compositor_add_button_binding(struct weston_compositor *compositor,
1327 uint32_t button,
1328 enum weston_keyboard_modifier modifier,
1329 weston_button_binding_handler_t binding,
1330 void *data);
1331
Derek Foreman8ae2db52015-07-15 13:00:36 -05001332typedef void (*weston_touch_binding_handler_t)(struct weston_touch *touch,
Neil Robertsa28c6932013-10-03 16:43:04 +01001333 uint32_t time,
1334 void *data);
1335struct weston_binding *
1336weston_compositor_add_touch_binding(struct weston_compositor *compositor,
1337 enum weston_keyboard_modifier modifier,
1338 weston_touch_binding_handler_t binding,
1339 void *data);
1340
Derek Foreman8ae2db52015-07-15 13:00:36 -05001341typedef void (*weston_axis_binding_handler_t)(struct weston_pointer *pointer,
Peter Hutterer89b6a492016-01-18 15:58:17 +10001342 uint32_t time,
1343 struct weston_pointer_axis_event *event,
1344 void *data);
Daniel Stone325fc2d2012-05-30 16:31:58 +01001345struct weston_binding *
1346weston_compositor_add_axis_binding(struct weston_compositor *compositor,
1347 uint32_t axis,
1348 enum weston_keyboard_modifier modifier,
1349 weston_axis_binding_handler_t binding,
1350 void *data);
Ander Conselvan de Oliveirac509d2b2012-11-08 17:20:45 +02001351struct weston_binding *
1352weston_compositor_add_debug_binding(struct weston_compositor *compositor,
1353 uint32_t key,
1354 weston_key_binding_handler_t binding,
1355 void *data);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001356void
1357weston_binding_destroy(struct weston_binding *binding);
1358
1359void
Pekka Paalanen2829f7c2015-02-19 17:02:13 +02001360weston_install_debug_key_binding(struct weston_compositor *compositor,
1361 uint32_t mod);
1362
1363void
Kristian Høgsberg3466bc82012-01-03 11:29:15 -05001364weston_binding_list_destroy_all(struct wl_list *list);
1365
Pekka Paalanen86b53962014-11-19 13:43:32 +02001366void
Daniel Stone325fc2d2012-05-30 16:31:58 +01001367weston_compositor_run_key_binding(struct weston_compositor *compositor,
Derek Foreman99a6a2d2015-07-15 13:00:43 -05001368 struct weston_keyboard *keyboard,
1369 uint32_t time,
Daniel Stone325fc2d2012-05-30 16:31:58 +01001370 uint32_t key,
1371 enum wl_keyboard_key_state state);
Daniel Stone96d47c02013-11-19 11:37:12 +01001372
1373void
1374weston_compositor_run_modifier_binding(struct weston_compositor *compositor,
Derek Foreman99a6a2d2015-07-15 13:00:43 -05001375 struct weston_keyboard *keyboard,
Daniel Stone96d47c02013-11-19 11:37:12 +01001376 enum weston_keyboard_modifier modifier,
1377 enum wl_keyboard_key_state state);
Daniel Stone325fc2d2012-05-30 16:31:58 +01001378void
1379weston_compositor_run_button_binding(struct weston_compositor *compositor,
Derek Foreman99a6a2d2015-07-15 13:00:43 -05001380 struct weston_pointer *pointer, uint32_t time,
Daniel Stone325fc2d2012-05-30 16:31:58 +01001381 uint32_t button,
1382 enum wl_pointer_button_state value);
Neil Robertsa28c6932013-10-03 16:43:04 +01001383void
1384weston_compositor_run_touch_binding(struct weston_compositor *compositor,
Derek Foreman99a6a2d2015-07-15 13:00:43 -05001385 struct weston_touch *touch, uint32_t time,
Neil Robertsa28c6932013-10-03 16:43:04 +01001386 int touch_type);
Rune K. Svendsen14b2fe72013-03-07 21:50:00 +01001387int
Daniel Stone325fc2d2012-05-30 16:31:58 +01001388weston_compositor_run_axis_binding(struct weston_compositor *compositor,
Derek Foreman99a6a2d2015-07-15 13:00:43 -05001389 struct weston_pointer *pointer, uint32_t time,
Peter Hutterer89b6a492016-01-18 15:58:17 +10001390 struct weston_pointer_axis_event *event);
Ander Conselvan de Oliveirac509d2b2012-11-08 17:20:45 +02001391int
1392weston_compositor_run_debug_binding(struct weston_compositor *compositor,
Derek Foreman99a6a2d2015-07-15 13:00:43 -05001393 struct weston_keyboard *keyboard, uint32_t time,
Ander Conselvan de Oliveirac509d2b2012-11-08 17:20:45 +02001394 uint32_t key,
1395 enum wl_keyboard_key_state state);
Daniel Stone325fc2d2012-05-30 16:31:58 +01001396
Giulio Camuffocdb4d292013-11-14 23:42:53 +01001397void
1398weston_compositor_set_default_pointer_grab(struct weston_compositor *compositor,
1399 const struct weston_pointer_grab_interface *interface);
1400
Benjamin Franzkebfeda132012-01-30 14:04:04 +01001401int
1402weston_environment_get_fd(const char *env);
1403
Kristian Høgsberga82c4862012-01-26 01:03:58 -05001404struct wl_list *
1405weston_compositor_top(struct weston_compositor *compositor);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001406
1407struct weston_surface *
Kristian Høgsberg18c93002012-01-27 11:58:31 -05001408weston_surface_create(struct weston_compositor *compositor);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001409
Jason Ekstranda7af7042013-10-12 22:38:11 -05001410struct weston_view *
1411weston_view_create(struct weston_surface *surface);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001412
1413void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001414weston_view_destroy(struct weston_view *view);
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -05001415
1416void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001417weston_view_set_position(struct weston_view *view,
1418 float x, float y);
1419
1420void
1421weston_view_set_transform_parent(struct weston_view *view,
1422 struct weston_view *parent);
1423
Pekka Paalanen380adf52015-02-16 14:39:11 +02001424void
1425weston_view_set_mask(struct weston_view *view,
1426 int x, int y, int width, int height);
1427
1428void
1429weston_view_set_mask_infinite(struct weston_view *view);
1430
Derek Foreman280e7dd2014-10-03 13:13:42 -05001431bool
Jason Ekstranda7af7042013-10-12 22:38:11 -05001432weston_view_is_mapped(struct weston_view *view);
1433
1434void
1435weston_view_schedule_repaint(struct weston_view *view);
Pekka Paalanen483243f2013-03-08 14:56:50 +02001436
Derek Foreman280e7dd2014-10-03 13:13:42 -05001437bool
Ander Conselvan de Oliveirab8ab14f2012-03-27 17:36:36 +03001438weston_surface_is_mapped(struct weston_surface *surface);
1439
Derek Foremand1be3122014-09-18 16:46:49 -05001440void
Jason Ekstrand5c11a332013-12-04 20:32:03 -06001441weston_surface_set_size(struct weston_surface *surface,
1442 int32_t width, int32_t height);
1443
Pekka Paalanen8fb8d3b2012-02-13 13:03:59 +02001444void
Kristian Høgsberg98238702012-08-03 16:29:12 -04001445weston_surface_schedule_repaint(struct weston_surface *surface);
1446
1447void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001448weston_surface_damage(struct weston_surface *surface);
1449
1450void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001451weston_view_damage_below(struct weston_view *view);
Kristian Høgsbergd8bf90c2012-02-23 23:03:14 -05001452
1453void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001454weston_view_move_to_plane(struct weston_view *view,
1455 struct weston_plane *plane);
1456void
1457weston_view_unmap(struct weston_view *view);
1458
Kristian Høgsberg65a11e12012-08-03 11:30:18 -04001459void
Kristian Høgsbergaf7b1ff2012-06-26 21:19:23 -04001460weston_surface_unmap(struct weston_surface *surface);
1461
Pekka Paalanen01388e22013-04-25 13:57:44 +03001462struct weston_surface *
1463weston_surface_get_main_surface(struct weston_surface *surface);
1464
Pekka Paalanen50b67472014-10-01 15:02:41 +03001465int
1466weston_surface_set_role(struct weston_surface *surface,
1467 const char *role_name,
1468 struct wl_resource *error_resource,
1469 uint32_t error_code);
1470
Pekka Paalanen8274d902014-08-06 19:36:51 +03001471void
1472weston_surface_set_label_func(struct weston_surface *surface,
1473 int (*desc)(struct weston_surface *,
1474 char *, size_t));
1475
Pekka Paalanenc647ed72015-02-09 13:16:57 +02001476void
1477weston_surface_get_content_size(struct weston_surface *surface,
1478 int *width, int *height);
1479
1480int
1481weston_surface_copy_content(struct weston_surface *surface,
1482 void *target, size_t size,
1483 int src_x, int src_y,
1484 int width, int height);
1485
Jason Ekstrand6bd62942013-06-20 20:38:23 -05001486struct weston_buffer *
1487weston_buffer_from_resource(struct wl_resource *resource);
1488
Kristian Høgsbergaf7b1ff2012-06-26 21:19:23 -04001489void
Pekka Paalanende685b82012-12-04 15:58:12 +02001490weston_buffer_reference(struct weston_buffer_reference *ref,
Jason Ekstrand6bd62942013-06-20 20:38:23 -05001491 struct weston_buffer *buffer);
Pekka Paalanende685b82012-12-04 15:58:12 +02001492
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001493uint32_t
1494weston_compositor_get_time(void);
1495
Giulio Camuffo459137b2014-10-11 23:56:24 +03001496void
1497weston_compositor_destroy(struct weston_compositor *ec);
1498struct weston_compositor *
1499weston_compositor_create(struct wl_display *display, void *user_data);
Pekka Paalanen50dbf382016-06-03 15:23:46 +03001500
1501enum weston_compositor_backend {
1502 WESTON_BACKEND_DRM,
1503 WESTON_BACKEND_FBDEV,
1504 WESTON_BACKEND_HEADLESS,
1505 WESTON_BACKEND_RDP,
1506 WESTON_BACKEND_WAYLAND,
1507 WESTON_BACKEND_X11,
1508};
1509
Pekka Paalanendd186732016-06-03 14:49:54 +03001510int
1511weston_compositor_load_backend(struct weston_compositor *compositor,
Pekka Paalanen50dbf382016-06-03 15:23:46 +03001512 enum weston_compositor_backend backend,
Pekka Paalanendd186732016-06-03 14:49:54 +03001513 struct weston_backend_config *config_base);
Giulio Camuffo459137b2014-10-11 23:56:24 +03001514void
1515weston_compositor_exit(struct weston_compositor *ec);
1516void *
1517weston_compositor_get_user_data(struct weston_compositor *compositor);
Pekka Paalanenb5eedad2014-09-23 22:08:45 -04001518int
1519weston_compositor_set_presentation_clock(struct weston_compositor *compositor,
1520 clockid_t clk_id);
1521int
1522weston_compositor_set_presentation_clock_software(
1523 struct weston_compositor *compositor);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001524void
Pekka Paalanen662f3842015-03-18 12:17:26 +02001525weston_compositor_read_presentation_clock(
1526 const struct weston_compositor *compositor,
1527 struct timespec *ts);
1528
Pekka Paalanen230f3b12014-09-29 14:18:40 -04001529bool
1530weston_compositor_import_dmabuf(struct weston_compositor *compositor,
1531 struct linux_dmabuf_buffer *buffer);
1532
Pekka Paalanen662f3842015-03-18 12:17:26 +02001533void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001534weston_compositor_shutdown(struct weston_compositor *ec);
1535void
Frederic Plourdec336f062014-10-29 14:44:33 -04001536weston_compositor_exit_with_code(struct weston_compositor *compositor,
1537 int exit_code);
1538void
Scott Moreau429490d2012-06-17 18:10:59 -06001539weston_output_init_zoom(struct weston_output *output);
1540void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001541weston_output_update_zoom(struct weston_output *output);
Scott Moreauccbf29d2012-02-22 14:21:41 -07001542void
Derek Foreman22276a52015-07-23 14:55:15 -05001543weston_output_activate_zoom(struct weston_output *output,
1544 struct weston_seat *seat);
Giulio Camuffo412b0242013-11-14 23:42:51 +01001545void
Scott Moreauccbf29d2012-02-22 14:21:41 -07001546weston_output_update_matrix(struct weston_output *output);
1547void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001548weston_output_move(struct weston_output *output, int x, int y);
1549void
1550weston_output_init(struct weston_output *output, struct weston_compositor *c,
Alexander Larssonedddbd12013-05-24 13:09:43 +02001551 int x, int y, int width, int height, uint32_t transform, int32_t scale);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001552void
Giulio Camuffob1147152015-05-06 21:41:57 +03001553weston_compositor_add_output(struct weston_compositor *compositor,
1554 struct weston_output *output);
1555void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001556weston_output_destroy(struct weston_output *output);
Kristian Høgsberg98c774f2013-07-22 14:33:42 -07001557void
Jason Ekstrandb6a3cc72013-10-27 22:25:00 -05001558weston_output_transform_coordinate(struct weston_output *output,
Giulio Camuffo90a6fc62016-03-22 17:44:54 +02001559 double device_x, double device_y,
1560 double *x, double *y);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001561
1562void
Rob Bradford9af5f9e2013-05-31 18:09:50 +01001563weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec,
1564 const char *seat_name);
Daniel Stone74419a22012-05-30 16:32:02 +01001565void
1566weston_seat_init_pointer(struct weston_seat *seat);
Jonas Ådahld6e1c342013-10-17 23:04:05 +02001567void
1568weston_seat_release_pointer(struct weston_seat *seat);
Kristian Høgsberg2f07ef62013-02-16 14:29:24 -05001569int
Daniel Stonebb1df6a2012-05-30 16:32:06 +01001570weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
Daniel Stone74419a22012-05-30 16:32:02 +01001571void
Jonas Ådahld6e1c342013-10-17 23:04:05 +02001572weston_seat_release_keyboard(struct weston_seat *seat);
1573void
Daniel Stone74419a22012-05-30 16:32:02 +01001574weston_seat_init_touch(struct weston_seat *seat);
Kristian Høgsbergb5e26102013-04-18 15:40:10 -04001575void
Jonas Ådahld6e1c342013-10-17 23:04:05 +02001576weston_seat_release_touch(struct weston_seat *seat);
1577void
Kristian Høgsberga71e8b22013-05-06 21:51:21 -04001578weston_seat_repick(struct weston_seat *seat);
Rui Matos65196bc2013-10-10 19:44:19 +02001579void
1580weston_seat_update_keymap(struct weston_seat *seat, struct xkb_keymap *keymap);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001581
1582void
Daniel Stone37816df2012-05-16 18:45:18 +01001583weston_seat_release(struct weston_seat *seat);
Kristian Høgsbergb5e26102013-04-18 15:40:10 -04001584int
Giulio Camuffo0358af42016-06-02 21:48:08 +03001585weston_compositor_set_xkb_rule_names(struct weston_compositor *ec,
1586 struct xkb_rule_names *names);
Kristian Høgsbergb5e26102013-04-18 15:40:10 -04001587void
1588weston_compositor_xkb_destroy(struct weston_compositor *ec);
Kristian Høgsberg3466bc82012-01-03 11:29:15 -05001589
Kristian Høgsberg64eca892012-08-01 00:00:57 -04001590/* String literal of spaces, the same width as the timestamp. */
1591#define STAMP_SPACE " "
1592
Giulio Camuffobe2b11a2016-06-02 21:48:13 +03001593typedef int (*log_func_t)(const char *fmt, va_list ap);
Kristian Høgsberg64eca892012-08-01 00:00:57 -04001594void
Giulio Camuffobe2b11a2016-06-02 21:48:13 +03001595weston_log_set_handler(log_func_t log, log_func_t cont);
Kristian Høgsberg64eca892012-08-01 00:00:57 -04001596int
Kristian Høgsberg082d58c2013-06-18 01:00:27 -04001597weston_vlog(const char *fmt, va_list ap);
1598int
1599weston_vlog_continue(const char *fmt, va_list ap);
1600int
Pekka Paalanend525b562012-08-06 14:57:04 +03001601weston_log(const char *fmt, ...)
1602 __attribute__ ((format (printf, 1, 2)));
Kristian Høgsberg64eca892012-08-01 00:00:57 -04001603int
Pekka Paalanend525b562012-08-06 14:57:04 +03001604weston_log_continue(const char *fmt, ...)
1605 __attribute__ ((format (printf, 1, 2)));
Kristian Høgsberg64eca892012-08-01 00:00:57 -04001606
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001607enum {
1608 TTY_ENTER_VT,
1609 TTY_LEAVE_VT
1610};
1611
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001612struct tty *
Kristian Høgsberg61741a22013-09-17 16:02:57 -07001613tty_create(struct weston_compositor *compositor, int tty_nr);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001614
1615void
1616tty_destroy(struct tty *tty);
1617
Kristian Høgsberg7b884bc2012-07-31 14:32:01 -04001618void
1619tty_reset(struct tty *tty);
1620
Kristian Høgsberg5d1c0c52012-04-10 00:11:50 -04001621int
1622tty_activate_vt(struct tty *tty, int vt);
1623
Giulio Camuffoe9022e72013-12-11 23:45:11 +01001624enum weston_screenshooter_outcome {
1625 WESTON_SCREENSHOOTER_SUCCESS,
1626 WESTON_SCREENSHOOTER_NO_MEMORY,
1627 WESTON_SCREENSHOOTER_BAD_BUFFER
1628};
1629
1630typedef void (*weston_screenshooter_done_func_t)(void *data,
1631 enum weston_screenshooter_outcome outcome);
1632int
1633weston_screenshooter_shoot(struct weston_output *output, struct weston_buffer *buffer,
1634 weston_screenshooter_done_func_t done, void *data);
Giulio Camuffo26f62d42016-06-02 21:48:09 +03001635struct weston_recorder *
1636weston_recorder_start(struct weston_output *output, const char *filename);
1637void
1638weston_recorder_stop(struct weston_recorder *recorder);
Giulio Camuffoe9022e72013-12-11 23:45:11 +01001639
Kristian Høgsberga7ceaff2012-06-03 10:20:13 -04001640struct clipboard *
1641clipboard_create(struct weston_seat *seat);
1642
Pekka Paalanenaa9536a2015-06-24 16:09:17 +03001643struct text_backend;
1644
1645struct text_backend *
Jan Arne Petersen674fd1d2012-11-18 19:06:42 +01001646text_backend_init(struct weston_compositor *ec);
Jan Arne Petersen1f17be42012-06-21 21:52:18 +02001647
Pekka Paalanenaa9536a2015-06-24 16:09:17 +03001648void
1649text_backend_destroy(struct text_backend *text_backend);
1650
Jason Ekstranda7af7042013-10-12 22:38:11 -05001651struct weston_view_animation;
1652typedef void (*weston_view_animation_done_func_t)(struct weston_view_animation *animation, void *data);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001653
Louis-Francis Ratté-Boulianneb482dbd2013-11-19 11:37:11 +01001654void
1655weston_view_animation_destroy(struct weston_view_animation *animation);
1656
Jason Ekstranda7af7042013-10-12 22:38:11 -05001657struct weston_view_animation *
1658weston_zoom_run(struct weston_view *view, float start, float stop,
1659 weston_view_animation_done_func_t done, void *data);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001660
Jason Ekstranda7af7042013-10-12 22:38:11 -05001661struct weston_view_animation *
1662weston_fade_run(struct weston_view *view,
Ander Conselvan de Oliveiraee416052013-02-21 18:35:17 +02001663 float start, float end, float k,
Jason Ekstranda7af7042013-10-12 22:38:11 -05001664 weston_view_animation_done_func_t done, void *data);
Daniel Stonea67e6b92013-11-19 11:37:13 +01001665
1666struct weston_view_animation *
1667weston_move_scale_run(struct weston_view *view, int dx, int dy,
1668 float start, float end, int reverse,
1669 weston_view_animation_done_func_t done, void *data);
1670
Ander Conselvan de Oliveiraee416052013-02-21 18:35:17 +02001671void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001672weston_fade_update(struct weston_view_animation *fade, float target);
Ander Conselvan de Oliveiraee416052013-02-21 18:35:17 +02001673
Jason Ekstranda7af7042013-10-12 22:38:11 -05001674struct weston_view_animation *
Louis-Francis Ratté-Boulianneb482dbd2013-11-19 11:37:11 +01001675weston_stable_fade_run(struct weston_view *front_view, float start,
1676 struct weston_view *back_view, float end,
1677 weston_view_animation_done_func_t done, void *data);
1678
1679struct weston_view_animation *
Jason Ekstranda7af7042013-10-12 22:38:11 -05001680weston_slide_run(struct weston_view *view, float start, float stop,
1681 weston_view_animation_done_func_t done, void *data);
Juan Zhaoe10d2792012-04-25 19:09:52 +08001682
Alex Wu8811bf92012-02-28 18:07:54 +08001683void
1684weston_surface_set_color(struct weston_surface *surface,
John Kåre Alsaker490d02a2012-09-30 02:57:21 +02001685 float red, float green, float blue, float alpha);
Alex Wu8811bf92012-02-28 18:07:54 +08001686
1687void
1688weston_surface_destroy(struct weston_surface *surface);
1689
Alex Wu2dda6042012-04-17 17:20:47 +08001690int
Derek Foreman6ae7bc92014-11-04 10:47:33 -06001691weston_output_mode_set_native(struct weston_output *output,
1692 struct weston_mode *mode,
1693 int32_t scale);
1694int
1695weston_output_mode_switch_to_temporary(struct weston_output *output,
1696 struct weston_mode *mode,
1697 int32_t scale);
1698int
1699weston_output_mode_switch_to_native(struct weston_output *output);
Alex Wu2dda6042012-04-17 17:20:47 +08001700
Ander Conselvan de Oliveira11f8d402012-10-29 18:19:24 +02001701int
1702noop_renderer_init(struct weston_compositor *ec);
Ander Conselvan de Oliveira11f8d402012-10-29 18:19:24 +02001703
Giulio Camuffo954f1832014-10-11 18:27:30 +03001704int
Jonas Ådahl30d61d82014-10-22 21:21:17 +02001705weston_input_init(struct weston_compositor *compositor);
1706
1707int
Giulio Camuffo954f1832014-10-11 18:27:30 +03001708backend_init(struct weston_compositor *c,
Giulio Camuffo93daabb2015-10-17 19:24:14 +03001709 struct weston_backend_config *config_base);
Kristian Høgsbergb00a9d32012-09-11 14:06:27 -04001710int
Kristian Høgsbergcb4685b2013-02-20 15:37:49 -05001711module_init(struct weston_compositor *compositor,
Ossama Othmana50e6e42013-05-14 09:48:26 -07001712 int *argc, char *argv[]);
Kristian Høgsbergb00a9d32012-09-11 14:06:27 -04001713
Ander Conselvan de Oliveira409eebf2012-12-05 15:14:04 +02001714void
1715weston_transformed_coord(int width, int height,
1716 enum wl_output_transform transform,
Alexander Larssonedddbd12013-05-24 13:09:43 +02001717 int32_t scale,
Ander Conselvan de Oliveira409eebf2012-12-05 15:14:04 +02001718 float sx, float sy, float *bx, float *by);
1719pixman_box32_t
1720weston_transformed_rect(int width, int height,
1721 enum wl_output_transform transform,
Alexander Larssonedddbd12013-05-24 13:09:43 +02001722 int32_t scale,
Ander Conselvan de Oliveira409eebf2012-12-05 15:14:04 +02001723 pixman_box32_t rect);
Jason Ekstrand33ff6362013-10-27 22:25:01 -05001724void
Derek Foremanbc9a61c2015-11-18 16:32:30 -06001725weston_matrix_transform_region(pixman_region32_t *dest,
1726 struct weston_matrix *matrix,
1727 pixman_region32_t *src);
1728void
Jason Ekstrand33ff6362013-10-27 22:25:01 -05001729weston_transformed_region(int width, int height,
1730 enum wl_output_transform transform,
1731 int32_t scale,
1732 pixman_region32_t *src, pixman_region32_t *dest);
Ander Conselvan de Oliveira409eebf2012-12-05 15:14:04 +02001733
Ander Conselvan de Oliveira97f29522013-10-14 15:57:11 +03001734void *
1735weston_load_module(const char *name, const char *entrypoint);
1736
Derek Foreman64a3df02014-10-23 12:24:18 -05001737int
1738weston_parse_transform(const char *transform, uint32_t *out);
1739
1740const char *
1741weston_transform_to_string(uint32_t output_transform);
1742
Derek Foreman1281a362015-07-31 16:55:32 -05001743struct weston_keyboard *
1744weston_seat_get_keyboard(struct weston_seat *seat);
1745
1746struct weston_pointer *
1747weston_seat_get_pointer(struct weston_seat *seat);
1748
1749struct weston_touch *
1750weston_seat_get_touch(struct weston_seat *seat);
1751
Bryce Harrington24f917e2016-06-29 19:04:07 -07001752void
1753weston_seat_set_keyboard_focus(struct weston_seat *seat,
1754 struct weston_surface *surface);
1755
Giulio Camuffo9c764df2016-06-29 11:54:27 +02001756int
1757weston_compositor_load_xwayland(struct weston_compositor *compositor);
1758
Giulio Camuffo7fe01b12013-03-28 18:02:42 +01001759#ifdef __cplusplus
1760}
1761#endif
1762
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001763#endif