blob: f2a0e4c19ec7f710f1343bad1f9591f67aad0d4e [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,
246};
247
248struct weston_pointer_motion_event {
249 uint32_t mask;
250 double x;
251 double y;
252 double dx;
253 double dy;
254};
255
Peter Hutterer89b6a492016-01-18 15:58:17 +1000256struct weston_pointer_axis_event {
257 uint32_t axis;
Giulio Camuffo90a6fc62016-03-22 17:44:54 +0200258 double value;
Peter Hutterer87743e92016-01-18 16:38:22 +1000259 bool has_discrete;
260 int32_t discrete;
Peter Hutterer89b6a492016-01-18 15:58:17 +1000261};
262
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400263struct weston_pointer_grab;
264struct weston_pointer_grab_interface {
Kristian Høgsberg6848c252013-05-08 22:02:59 -0400265 void (*focus)(struct weston_pointer_grab *grab);
Giulio Camuffo1959ab82013-11-14 23:42:52 +0100266 void (*motion)(struct weston_pointer_grab *grab, uint32_t time,
Jonas Ådahld2510102014-10-05 21:39:14 +0200267 struct weston_pointer_motion_event *event);
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400268 void (*button)(struct weston_pointer_grab *grab,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400269 uint32_t time, uint32_t button, uint32_t state);
Jonas Ådahl0336ca02014-10-04 16:28:29 +0200270 void (*axis)(struct weston_pointer_grab *grab,
Peter Hutterer89b6a492016-01-18 15:58:17 +1000271 uint32_t time,
272 struct weston_pointer_axis_event *event);
Peter Hutterer87743e92016-01-18 16:38:22 +1000273 void (*axis_source)(struct weston_pointer_grab *grab, uint32_t source);
274 void (*frame)(struct weston_pointer_grab *grab);
Jonas Ådahl1ea343e2013-10-25 23:18:05 +0200275 void (*cancel)(struct weston_pointer_grab *grab);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400276};
277
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400278struct weston_pointer_grab {
279 const struct weston_pointer_grab_interface *interface;
280 struct weston_pointer *pointer;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400281};
282
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400283struct weston_keyboard_grab;
284struct weston_keyboard_grab_interface {
285 void (*key)(struct weston_keyboard_grab *grab, uint32_t time,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400286 uint32_t key, uint32_t state);
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400287 void (*modifiers)(struct weston_keyboard_grab *grab, uint32_t serial,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400288 uint32_t mods_depressed, uint32_t mods_latched,
289 uint32_t mods_locked, uint32_t group);
Jonas Ådahl1ea343e2013-10-25 23:18:05 +0200290 void (*cancel)(struct weston_keyboard_grab *grab);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400291};
292
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400293struct weston_keyboard_grab {
294 const struct weston_keyboard_grab_interface *interface;
295 struct weston_keyboard *keyboard;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400296};
297
Kristian Høgsberge329f362013-05-06 22:19:57 -0400298struct weston_touch_grab;
299struct weston_touch_grab_interface {
300 void (*down)(struct weston_touch_grab *grab,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400301 uint32_t time,
302 int touch_id,
303 wl_fixed_t sx,
304 wl_fixed_t sy);
Kristian Høgsberge329f362013-05-06 22:19:57 -0400305 void (*up)(struct weston_touch_grab *grab,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400306 uint32_t time,
307 int touch_id);
Kristian Høgsberge329f362013-05-06 22:19:57 -0400308 void (*motion)(struct weston_touch_grab *grab,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400309 uint32_t time,
310 int touch_id,
311 wl_fixed_t sx,
312 wl_fixed_t sy);
Jonas Ådahl1679f232014-04-12 09:39:51 +0200313 void (*frame)(struct weston_touch_grab *grab);
Jonas Ådahl1ea343e2013-10-25 23:18:05 +0200314 void (*cancel)(struct weston_touch_grab *grab);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400315};
316
Kristian Høgsberge329f362013-05-06 22:19:57 -0400317struct weston_touch_grab {
318 const struct weston_touch_grab_interface *interface;
319 struct weston_touch *touch;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400320};
321
Kristian Høgsberg5e76a492013-07-25 16:09:37 -0700322struct weston_data_offer {
Jason Ekstrand8a4a9eb2013-06-14 10:07:55 -0500323 struct wl_resource *resource;
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700324 struct weston_data_source *source;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400325 struct wl_listener source_destroy_listener;
Carlos Garnacho9c931792016-01-18 23:52:12 +0100326 uint32_t dnd_actions;
327 enum wl_data_device_manager_dnd_action preferred_dnd_action;
328 bool in_ask;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400329};
330
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700331struct weston_data_source {
Jason Ekstrand8a4a9eb2013-06-14 10:07:55 -0500332 struct wl_resource *resource;
333 struct wl_signal destroy_signal;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400334 struct wl_array mime_types;
Carlos Garnacho78d4bf92016-01-15 21:14:23 +0100335 struct weston_data_offer *offer;
336 struct weston_seat *seat;
337 bool accepted;
Carlos Garnacho9c931792016-01-18 23:52:12 +0100338 bool actions_set;
339 uint32_t dnd_actions;
340 enum wl_data_device_manager_dnd_action current_dnd_action;
Carlos Garnachob2889882016-01-15 21:14:26 +0100341 enum wl_data_device_manager_dnd_action compositor_action;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400342
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700343 void (*accept)(struct weston_data_source *source,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400344 uint32_t serial, const char *mime_type);
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700345 void (*send)(struct weston_data_source *source,
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400346 const char *mime_type, int32_t fd);
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700347 void (*cancel)(struct weston_data_source *source);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400348};
349
Jonas Ådahl2cbf2932015-07-22 12:05:38 +0800350struct weston_pointer_client {
351 struct wl_list link;
352 struct wl_client *client;
353 struct wl_list pointer_resources;
354};
355
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400356struct weston_pointer {
Kristian Høgsberge3148752013-05-06 23:19:49 -0400357 struct weston_seat *seat;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400358
Jonas Ådahl2cbf2932015-07-22 12:05:38 +0800359 struct wl_list pointer_clients;
360
Jason Ekstranda7af7042013-10-12 22:38:11 -0500361 struct weston_view *focus;
Jonas Ådahl2cbf2932015-07-22 12:05:38 +0800362 struct weston_pointer_client *focus_client;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400363 uint32_t focus_serial;
Giulio Camuffo576fe2a2013-11-20 18:00:24 +0100364 struct wl_listener focus_view_listener;
365 struct wl_listener focus_resource_listener;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400366 struct wl_signal focus_signal;
Giulio Camuffo6fcb3782013-11-14 23:42:50 +0100367 struct wl_signal motion_signal;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400368
Jason Ekstranda7af7042013-10-12 22:38:11 -0500369 struct weston_view *sprite;
Kristian Høgsberg195b8692013-05-08 15:02:05 -0400370 struct wl_listener sprite_destroy_listener;
371 int32_t hotspot_x, hotspot_y;
372
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400373 struct weston_pointer_grab *grab;
374 struct weston_pointer_grab default_grab;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400375 wl_fixed_t grab_x, grab_y;
376 uint32_t grab_button;
377 uint32_t grab_serial;
378 uint32_t grab_time;
379
380 wl_fixed_t x, y;
Kristian Høgsbergdb1fccb2014-02-05 17:14:42 -0800381 wl_fixed_t sx, sy;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400382 uint32_t button_count;
Ander Conselvan de Oliveiraf84327a2014-01-29 18:47:51 +0200383
384 struct wl_listener output_destroy_listener;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400385};
386
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400387
Kristian Høgsberge329f362013-05-06 22:19:57 -0400388struct weston_touch {
Kristian Høgsberge3148752013-05-06 23:19:49 -0400389 struct weston_seat *seat;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400390
391 struct wl_list resource_list;
Neil Roberts96d790e2013-09-19 17:32:00 +0100392 struct wl_list focus_resource_list;
Jason Ekstranda7af7042013-10-12 22:38:11 -0500393 struct weston_view *focus;
Giulio Camuffo576fe2a2013-11-20 18:00:24 +0100394 struct wl_listener focus_view_listener;
395 struct wl_listener focus_resource_listener;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400396 uint32_t focus_serial;
397 struct wl_signal focus_signal;
398
Jonas Ådahl9484b692013-12-02 22:05:03 +0100399 uint32_t num_tp;
400
Kristian Høgsberge329f362013-05-06 22:19:57 -0400401 struct weston_touch_grab *grab;
402 struct weston_touch_grab default_grab;
Neil Roberts306fe082013-10-03 16:43:06 +0100403 int grab_touch_id;
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400404 wl_fixed_t grab_x, grab_y;
405 uint32_t grab_serial;
406 uint32_t grab_time;
407};
408
Jonas Ådahld2510102014-10-05 21:39:14 +0200409void
410weston_pointer_motion_to_abs(struct weston_pointer *pointer,
411 struct weston_pointer_motion_event *event,
412 wl_fixed_t *x, wl_fixed_t *y);
413
Kristian Høgsberga4036bb2013-05-07 23:52:07 -0400414struct weston_pointer *
Giulio Camuffocdb4d292013-11-14 23:42:53 +0100415weston_pointer_create(struct weston_seat *seat);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400416void
Kristian Høgsberga4036bb2013-05-07 23:52:07 -0400417weston_pointer_destroy(struct weston_pointer *pointer);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400418void
Jonas Ådahl0336ca02014-10-04 16:28:29 +0200419weston_pointer_send_axis(struct weston_pointer *pointer,
Peter Hutterer89b6a492016-01-18 15:58:17 +1000420 uint32_t time,
421 struct weston_pointer_axis_event *event);
Jonas Ådahl0336ca02014-10-04 16:28:29 +0200422void
Peter Hutterer87743e92016-01-18 16:38:22 +1000423weston_pointer_send_axis_source(struct weston_pointer *pointer,
424 uint32_t source);
425void
426weston_pointer_send_frame(struct weston_pointer *pointer);
427
428void
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400429weston_pointer_set_focus(struct weston_pointer *pointer,
Jason Ekstranda7af7042013-10-12 22:38:11 -0500430 struct weston_view *view,
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400431 wl_fixed_t sx, wl_fixed_t sy);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400432void
Derek Foremanf9318d12015-05-11 15:40:11 -0500433weston_pointer_clear_focus(struct weston_pointer *pointer);
434void
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400435weston_pointer_start_grab(struct weston_pointer *pointer,
436 struct weston_pointer_grab *grab);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400437void
Kristian Høgsberg02bbabb2013-05-06 22:15:05 -0400438weston_pointer_end_grab(struct weston_pointer *pointer);
Rob Bradford806d8c02013-06-25 18:56:41 +0100439void
440weston_pointer_clamp(struct weston_pointer *pointer,
441 wl_fixed_t *fx, wl_fixed_t *fy);
Giulio Camuffo1959ab82013-11-14 23:42:52 +0100442void
443weston_pointer_move(struct weston_pointer *pointer,
Jonas Ådahld2510102014-10-05 21:39:14 +0200444 struct weston_pointer_motion_event *event);
Giulio Camuffocdb4d292013-11-14 23:42:53 +0100445void
446weston_pointer_set_default_grab(struct weston_pointer *pointer,
447 const struct weston_pointer_grab_interface *interface);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400448
Kristian Høgsberga4036bb2013-05-07 23:52:07 -0400449struct weston_keyboard *
450weston_keyboard_create(void);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400451void
Kristian Høgsberga4036bb2013-05-07 23:52:07 -0400452weston_keyboard_destroy(struct weston_keyboard *keyboard);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400453void
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400454weston_keyboard_set_focus(struct weston_keyboard *keyboard,
Kristian Høgsbergfe7aa902013-05-08 09:54:37 -0400455 struct weston_surface *surface);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400456void
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400457weston_keyboard_start_grab(struct weston_keyboard *device,
458 struct weston_keyboard_grab *grab);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400459void
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400460weston_keyboard_end_grab(struct weston_keyboard *keyboard);
Giulio Camuffo6ef444d2014-08-28 19:44:09 +0300461int
462/*
463 * 'mask' and 'value' should be a bitwise mask of one or more
464 * valued of the weston_keyboard_locks enum.
465 */
466weston_keyboard_set_locks(struct weston_keyboard *keyboard,
467 uint32_t mask, uint32_t value);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400468
Kristian Høgsberga4036bb2013-05-07 23:52:07 -0400469struct weston_touch *
470weston_touch_create(void);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400471void
Kristian Høgsberga4036bb2013-05-07 23:52:07 -0400472weston_touch_destroy(struct weston_touch *touch);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400473void
Derek Foreman4c93c082015-04-30 16:45:41 -0500474weston_touch_set_focus(struct weston_touch *touch,
Jason Ekstranda7af7042013-10-12 22:38:11 -0500475 struct weston_view *view);
Michael Fua2bb7912013-07-23 15:51:06 +0800476void
Kristian Høgsberge329f362013-05-06 22:19:57 -0400477weston_touch_start_grab(struct weston_touch *device,
478 struct weston_touch_grab *grab);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400479void
Kristian Høgsberge329f362013-05-06 22:19:57 -0400480weston_touch_end_grab(struct weston_touch *touch);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400481
482void
Kristian Høgsberge3148752013-05-06 23:19:49 -0400483wl_data_device_set_keyboard_focus(struct weston_seat *seat);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400484
485int
486wl_data_device_manager_init(struct wl_display *display);
487
488
489void
Kristian Høgsberge3148752013-05-06 23:19:49 -0400490weston_seat_set_selection(struct weston_seat *seat,
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700491 struct weston_data_source *source, uint32_t serial);
Giulio Camuffodddf9e62015-05-01 12:59:35 +0300492void
493weston_seat_send_selection(struct weston_seat *seat, struct wl_client *client);
494
Kristian Høgsberg85de9c22013-09-04 20:44:26 -0700495int
Xiong Zhangfd51e7b2013-11-25 18:42:49 +0800496weston_pointer_start_drag(struct weston_pointer *pointer,
Kristian Høgsberg85de9c22013-09-04 20:44:26 -0700497 struct weston_data_source *source,
498 struct weston_surface *icon,
499 struct wl_client *client);
Xiong Zhangfd51e7b2013-11-25 18:42:49 +0800500int
501weston_touch_start_drag(struct weston_touch *touch,
502 struct weston_data_source *source,
503 struct weston_surface *icon,
504 struct wl_client *client);
Kristian Høgsberg2158a882013-04-18 15:07:39 -0400505
Daniel Stoned65b9092012-05-30 16:32:05 +0100506struct weston_xkb_info {
507 struct xkb_keymap *keymap;
Daniel Stoneb7452fe2012-06-01 12:14:06 +0100508 int keymap_fd;
509 size_t keymap_size;
510 char *keymap_area;
Andrew Wedgbury9a6f02a2013-09-05 13:31:40 +0000511 int32_t ref_count;
Daniel Stoneabb9dcd2012-06-22 13:21:33 +0100512 xkb_mod_index_t shift_mod;
513 xkb_mod_index_t caps_mod;
Daniel Stoned65b9092012-05-30 16:32:05 +0100514 xkb_mod_index_t ctrl_mod;
515 xkb_mod_index_t alt_mod;
Daniel Stoneabb9dcd2012-06-22 13:21:33 +0100516 xkb_mod_index_t mod2_mod;
517 xkb_mod_index_t mod3_mod;
Daniel Stoned65b9092012-05-30 16:32:05 +0100518 xkb_mod_index_t super_mod;
Daniel Stoneabb9dcd2012-06-22 13:21:33 +0100519 xkb_mod_index_t mod5_mod;
Daniel Stoned65b9092012-05-30 16:32:05 +0100520 xkb_led_index_t num_led;
521 xkb_led_index_t caps_led;
522 xkb_led_index_t scroll_led;
523};
524
Jan Arne Petersena75a7892013-01-16 21:26:50 +0100525struct weston_keyboard {
Kristian Høgsberge3148752013-05-06 23:19:49 -0400526 struct weston_seat *seat;
Jan Arne Petersena75a7892013-01-16 21:26:50 +0100527
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400528 struct wl_list resource_list;
Neil Roberts96d790e2013-09-19 17:32:00 +0100529 struct wl_list focus_resource_list;
Kristian Høgsbergfe7aa902013-05-08 09:54:37 -0400530 struct weston_surface *focus;
Giulio Camuffo576fe2a2013-11-20 18:00:24 +0100531 struct wl_listener focus_resource_listener;
Kristian Høgsberg29139d42013-04-18 15:25:39 -0400532 uint32_t focus_serial;
533 struct wl_signal focus_signal;
534
535 struct weston_keyboard_grab *grab;
536 struct weston_keyboard_grab default_grab;
537 uint32_t grab_key;
538 uint32_t grab_serial;
539 uint32_t grab_time;
540
541 struct wl_array keys;
542
543 struct {
544 uint32_t mods_depressed;
545 uint32_t mods_latched;
546 uint32_t mods_locked;
547 uint32_t group;
548 } modifiers;
549
550 struct weston_keyboard_grab input_method_grab;
Jan Arne Petersena75a7892013-01-16 21:26:50 +0100551 struct wl_resource *input_method_resource;
Jonas Ådahl7395ea02013-12-03 09:14:26 +0100552
553 struct weston_xkb_info *xkb_info;
554 struct {
555 struct xkb_state *state;
556 enum weston_led leds;
557 } xkb_state;
558 struct xkb_keymap *pending_keymap;
Jan Arne Petersena75a7892013-01-16 21:26:50 +0100559};
560
Daniel Stone37816df2012-05-16 18:45:18 +0100561struct weston_seat {
Kristian Høgsberge3148752013-05-06 23:19:49 -0400562 struct wl_list base_resource_list;
563
Kristian Høgsbergaaadc772013-07-08 16:20:31 -0400564 struct wl_global *global;
Derek Foreman1281a362015-07-31 16:55:32 -0500565 struct weston_pointer *pointer_state;
566 struct weston_keyboard *keyboard_state;
567 struct weston_touch *touch_state;
Jonas Ådahld6e1c342013-10-17 23:04:05 +0200568 int pointer_device_count;
569 int keyboard_device_count;
570 int touch_device_count;
Kristian Høgsberge3148752013-05-06 23:19:49 -0400571
Rob Bradford66bd9f52013-06-25 18:56:42 +0100572 struct weston_output *output; /* constraint */
573
Giulio Camuffo5085a752013-03-25 21:42:45 +0100574 struct wl_signal destroy_signal;
Jason Ekstranda4ab5422014-04-02 19:53:45 -0500575 struct wl_signal updated_caps_signal;
Daniel Stone74419a22012-05-30 16:32:02 +0100576
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500577 struct weston_compositor *compositor;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500578 struct wl_list link;
Daniel Stone496ca172012-05-30 16:31:42 +0100579 enum weston_keyboard_modifier modifier_state;
Kristian Høgsbergfe7aa902013-05-08 09:54:37 -0400580 struct weston_surface *saved_kbd_focus;
Ander Conselvan de Oliveira71b1d0c2012-03-16 17:25:11 +0200581 struct wl_listener saved_kbd_focus_listener;
Kristian Høgsberg054c50a2013-05-08 15:27:47 -0400582 struct wl_list drag_resource_list;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500583
Kristian Høgsberge3148752013-05-06 23:19:49 -0400584 uint32_t selection_serial;
Kristian Høgsberg7ff3bdb2013-07-25 15:52:14 -0700585 struct weston_data_source *selection_data_source;
Kristian Høgsberge3148752013-05-06 23:19:49 -0400586 struct wl_listener selection_data_source_listener;
587 struct wl_signal selection_signal;
588
Daniel Stone8c8164f2012-05-30 16:31:45 +0100589 void (*led_update)(struct weston_seat *ws, enum weston_led leds);
590
Jan Arne Petersene829adc2012-08-10 16:47:22 +0200591 struct input_method *input_method;
Rob Bradford9af5f9e2013-05-31 18:09:50 +0100592 char *seat_name;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500593};
594
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500595enum {
Bryce Harringtonc2be8572015-12-11 13:11:37 -0800596 WESTON_COMPOSITOR_ACTIVE, /* normal rendering and events */
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500597 WESTON_COMPOSITOR_IDLE, /* shell->unlock called on activity */
Philipp Brüschweiler57edf7f2013-03-29 13:01:56 +0100598 WESTON_COMPOSITOR_OFFSCREEN, /* no rendering, no frame events */
Bryce Harringtonc2be8572015-12-11 13:11:37 -0800599 WESTON_COMPOSITOR_SLEEPING /* same as offscreen, but also set dpms
Philipp Brüschweiler57edf7f2013-03-29 13:01:56 +0100600 * to off */
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500601};
602
Giulio Camuffo412e6a52014-07-09 22:12:56 +0300603struct weston_layer_entry {
604 struct wl_list link;
605 struct weston_layer *layer;
606};
607
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -0500608struct weston_layer {
Giulio Camuffo412e6a52014-07-09 22:12:56 +0300609 struct weston_layer_entry view_list;
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -0500610 struct wl_list link;
Giulio Camuffo95ec0f92014-07-09 22:12:57 +0300611 pixman_box32_t mask;
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -0500612};
613
Kristian Høgsberg65a11e12012-08-03 11:30:18 -0400614struct weston_plane {
Xiong Zhang97116532013-10-23 13:58:31 +0800615 struct weston_compositor *compositor;
Pekka Paalanen502f5e02015-02-23 14:08:25 +0200616 pixman_region32_t damage; /**< in global coords */
Ander Conselvan de Oliveirae1bd5a02013-03-05 17:30:29 +0200617 pixman_region32_t clip;
Kristian Høgsberg65a11e12012-08-03 11:30:18 -0400618 int32_t x, y;
Ander Conselvan de Oliveira8ad19822013-03-05 17:30:27 +0200619 struct wl_list link;
Kristian Høgsberg65a11e12012-08-03 11:30:18 -0400620};
621
Kristian Høgsbergfa1be022012-09-05 22:49:55 -0400622struct weston_renderer {
John Kåre Alsakera95b2d62012-11-13 19:10:21 +0100623 int (*read_pixels)(struct weston_output *output,
624 pixman_format_code_t format, void *pixels,
625 uint32_t x, uint32_t y,
626 uint32_t width, uint32_t height);
Kristian Høgsbergfa1be022012-09-05 22:49:55 -0400627 void (*repaint_output)(struct weston_output *output,
628 pixman_region32_t *output_damage);
629 void (*flush_damage)(struct weston_surface *surface);
Jason Ekstrand6bd62942013-06-20 20:38:23 -0500630 void (*attach)(struct weston_surface *es, struct weston_buffer *buffer);
John Kåre Alsaker878f4492012-11-13 19:10:23 +0100631 void (*surface_set_color)(struct weston_surface *surface,
632 float red, float green,
633 float blue, float alpha);
Vasily Khoruzhick52cfd612013-01-08 19:09:01 +0300634 void (*destroy)(struct weston_compositor *ec);
Pekka Paalanenc647ed72015-02-09 13:16:57 +0200635
636
637 /** See weston_surface_get_content_size() */
638 void (*surface_get_content_size)(struct weston_surface *surface,
639 int *width, int *height);
640
641 /** See weston_surface_copy_content() */
642 int (*surface_copy_content)(struct weston_surface *surface,
643 void *target, size_t size,
644 int src_x, int src_y,
645 int width, int height);
Pekka Paalanen230f3b12014-09-29 14:18:40 -0400646
647 /** See weston_compositor_import_dmabuf() */
648 bool (*import_dmabuf)(struct weston_compositor *ec,
649 struct linux_dmabuf_buffer *buffer);
Kristian Høgsbergfa1be022012-09-05 22:49:55 -0400650};
651
Pekka Paalanen7bb65102013-05-22 18:03:04 +0300652enum weston_capability {
653 /* backend/renderer supports arbitrary rotation */
654 WESTON_CAP_ROTATION_ANY = 0x0001,
Pekka Paalanen4fc5dd02013-05-22 18:03:05 +0300655
656 /* screencaptures need to be y-flipped */
657 WESTON_CAP_CAPTURE_YFLIP = 0x0002,
Jason Ekstrand9fc71512014-04-02 19:53:46 -0500658
Bryce Harringtona86c3ee2015-03-18 18:42:00 -0700659 /* backend/renderer has a separate cursor plane */
Jason Ekstrand9fc71512014-04-02 19:53:46 -0500660 WESTON_CAP_CURSOR_PLANE = 0x0004,
661
662 /* backend supports setting arbitrary resolutions */
663 WESTON_CAP_ARBITRARY_MODES = 0x0008,
Pekka Paalanen380adf52015-02-16 14:39:11 +0200664
665 /* renderer supports weston_view_set_mask() clipping */
666 WESTON_CAP_VIEW_CLIP_MASK = 0x0010,
Pekka Paalanen7bb65102013-05-22 18:03:04 +0300667};
668
Giulio Camuffoe3c0d8a2015-10-17 19:24:13 +0300669/* Configuration struct for an output.
670 *
671 * This struct is used to pass the configuration for an output
672 * to the compositor backend when creating a new output.
673 * The backend can subclass this struct to handle backend
674 * specific data.
675 */
676struct weston_backend_output_config {
677 uint32_t transform;
Bryce Harrington32c32112015-10-23 15:29:23 -0700678 uint32_t width;
679 uint32_t height;
680 uint32_t scale;
Giulio Camuffoe3c0d8a2015-10-17 19:24:13 +0300681};
682
683/* Configuration struct for a backend.
684 *
685 * This struct carries the configuration for a backend, and it's
686 * passed to the backend's init entry point. The backend will
687 * likely want to subclass this in order to handle backend specific
688 * data.
Bryce Harrington20b66c32016-04-15 20:28:29 -0700689 *
690 * NOTE: Alternate designs were proposed (Feb 2016) for using opaque
691 * structures[1] and for section+key/value getter/setters[2]. The rationale
692 * for selecting the transparent structure design is based on several
693 * assumptions[3] which may require re-evaluating the design choice if they
694 * fail to hold.
695 *
696 * 1: https://lists.freedesktop.org/archives/wayland-devel/2016-February/026989.html
697 * 2: https://lists.freedesktop.org/archives/wayland-devel/2016-February/026929.html
698 * 3: https://lists.freedesktop.org/archives/wayland-devel/2016-February/027228.html
Giulio Camuffoe3c0d8a2015-10-17 19:24:13 +0300699 */
700struct weston_backend_config {
Bryce Harrington20b66c32016-04-15 20:28:29 -0700701 /** Major version for the backend-specific config struct
702 *
703 * This version must match exactly what the backend expects, otherwise
704 * the struct is incompatible.
705 */
706 uint32_t struct_version;
707
708 /** Minor version of the backend-specific config struct
709 *
710 * This must be set to sizeof(struct backend-specific config).
711 * If the value here is smaller than what the backend expects, the
712 * extra config members will assume their default values.
713 *
714 * A value greater than what the backend expects is incompatible.
715 */
716 size_t struct_size;
Giulio Camuffoe3c0d8a2015-10-17 19:24:13 +0300717};
718
Giulio Camuffo954f1832014-10-11 18:27:30 +0300719struct weston_backend {
Giulio Camuffoe3c0d8a2015-10-17 19:24:13 +0300720 void (*destroy)(struct weston_compositor *compositor);
721 void (*restore)(struct weston_compositor *compositor);
Giulio Camuffo954f1832014-10-11 18:27:30 +0300722};
723
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500724struct weston_compositor {
Kristian Høgsberg02e79dc2012-04-12 09:55:26 -0400725 struct wl_signal destroy_signal;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500726
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500727 struct wl_display *wl_display;
Tiago Vignattibc052c92012-04-19 16:18:18 +0300728 struct weston_shell_interface shell_interface;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500729
Tiago Vignattifb2adba2013-06-12 15:43:21 -0300730 /* surface signals */
Kristian Høgsbergf03a04a2014-04-06 22:04:50 -0700731 struct wl_signal create_surface_signal;
Kristian Høgsberg02e79dc2012-04-12 09:55:26 -0400732 struct wl_signal activate_signal;
Tiago Vignattifb2adba2013-06-12 15:43:21 -0300733 struct wl_signal transform_signal;
734
Tiago Vignatti1d01b012012-09-27 17:48:36 +0300735 struct wl_signal kill_signal;
Ander Conselvan de Oliveiraa4575632013-02-21 18:35:23 +0200736 struct wl_signal idle_signal;
737 struct wl_signal wake_signal;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500738
Jan Arne Petersen42feced2012-06-21 21:52:17 +0200739 struct wl_signal show_input_panel_signal;
740 struct wl_signal hide_input_panel_signal;
Jan Arne Petersen14da96b2013-04-18 16:47:28 +0200741 struct wl_signal update_input_panel_signal;
Jan Arne Petersen42feced2012-06-21 21:52:17 +0200742
Jan Arne Petersen674fd1d2012-11-18 19:06:42 +0100743 struct wl_signal seat_created_signal;
Richard Hughes59d5da72013-05-01 21:52:11 +0100744 struct wl_signal output_created_signal;
Ander Conselvan de Oliveiraf84327a2014-01-29 18:47:51 +0200745 struct wl_signal output_destroyed_signal;
Ander Conselvan de Oliveiraa8a9baf2014-01-29 18:47:52 +0200746 struct wl_signal output_moved_signal;
David Fort0de859e2016-05-27 23:22:57 +0200747 struct wl_signal output_resized_signal; /* callback argument: resized output */
Jan Arne Petersen674fd1d2012-11-18 19:06:42 +0100748
Kristian Høgsberg61741a22013-09-17 16:02:57 -0700749 struct wl_signal session_signal;
750 int session_active;
751
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -0500752 struct weston_layer fade_layer;
753 struct weston_layer cursor_layer;
754
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500755 struct wl_list output_list;
Daniel Stone37816df2012-05-16 18:45:18 +0100756 struct wl_list seat_list;
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -0500757 struct wl_list layer_list;
Pekka Paalanen20c7e552016-03-30 14:08:24 +0300758 struct wl_list view_list; /* struct weston_view::link */
Ander Conselvan de Oliveira8ad19822013-03-05 17:30:27 +0200759 struct wl_list plane_list;
Daniel Stone325fc2d2012-05-30 16:31:58 +0100760 struct wl_list key_binding_list;
Daniel Stone96d47c02013-11-19 11:37:12 +0100761 struct wl_list modifier_binding_list;
Daniel Stone325fc2d2012-05-30 16:31:58 +0100762 struct wl_list button_binding_list;
Neil Robertsa28c6932013-10-03 16:43:04 +0100763 struct wl_list touch_binding_list;
Daniel Stone325fc2d2012-05-30 16:31:58 +0100764 struct wl_list axis_binding_list;
Ander Conselvan de Oliveirac509d2b2012-11-08 17:20:45 +0200765 struct wl_list debug_binding_list;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500766
767 uint32_t state;
768 struct wl_event_source *idle_source;
769 uint32_t idle_inhibit;
Philipp Brüschweiler4b409c32013-03-10 14:37:04 +0100770 int idle_time; /* timeout, s */
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500771
Giulio Camuffocdb4d292013-11-14 23:42:53 +0100772 const struct weston_pointer_grab_interface *default_pointer_grab;
773
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500774 /* Repaint state. */
Kristian Høgsberg65a11e12012-08-03 11:30:18 -0400775 struct weston_plane primary_plane;
Pekka Paalanen7bb65102013-05-22 18:03:04 +0300776 uint32_t capabilities; /* combination of enum weston_capability */
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500777
Kristian Høgsbergfa1be022012-09-05 22:49:55 -0400778 struct weston_renderer *renderer;
779
John Kåre Alsakerf9e710b2012-11-13 19:10:22 +0100780 pixman_format_code_t read_format;
Pekka Paalanen52bfbaa2012-04-11 16:19:37 +0300781
Giulio Camuffo954f1832014-10-11 18:27:30 +0300782 struct weston_backend *backend;
Kristian Høgsberg3466bc82012-01-03 11:29:15 -0500783
Kristian Høgsberg05ad1e42013-09-17 14:41:03 -0700784 struct weston_launcher *launcher;
Casey Dahlin58ba1372012-04-19 22:50:08 -0400785
786 uint32_t output_id_pool;
Daniel Stone855028f2012-05-01 20:37:10 +0100787
Daniel Stonee379da92012-05-30 16:32:04 +0100788 struct xkb_rule_names xkb_names;
789 struct xkb_context *xkb_context;
Andrew Wedgbury9a6f02a2013-09-05 13:31:40 +0000790 struct weston_xkb_info *xkb_info;
Matt Roper01a92732013-06-24 16:52:44 +0100791
792 /* Raw keyboard processing (no libxkbcommon initialization or handling) */
793 int use_xkbcommon;
Jonny Lamb66a41a02014-08-12 14:58:25 +0200794
795 int32_t kb_repeat_rate;
796 int32_t kb_repeat_delay;
Pekka Paalanenb5eedad2014-09-23 22:08:45 -0400797
Bob Ham91880f12016-01-12 10:21:47 +0000798 bool vt_switching;
799
Pekka Paalanenb5eedad2014-09-23 22:08:45 -0400800 clockid_t presentation_clock;
Pekka Paalanen0513a952014-05-21 16:17:27 +0300801 int32_t repaint_msec;
Frederic Plourdec336f062014-10-29 14:44:33 -0400802
803 int exit_code;
Giulio Camuffo459137b2014-10-11 23:56:24 +0300804
805 void *user_data;
806 void (*exit)(struct weston_compositor *c);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500807};
808
Jason Ekstrand6bd62942013-06-20 20:38:23 -0500809struct weston_buffer {
810 struct wl_resource *resource;
811 struct wl_signal destroy_signal;
812 struct wl_listener destroy_listener;
813
814 union {
815 struct wl_shm_buffer *shm_buffer;
Jason Ekstranda85118c2013-06-27 20:17:02 -0500816 void *legacy_buffer;
Jason Ekstrand6bd62942013-06-20 20:38:23 -0500817 };
818 int32_t width, height;
819 uint32_t busy_count;
Stanislav Vorobiovbfbb8e52013-08-29 11:36:44 +0400820 int y_inverted;
Jason Ekstrand6bd62942013-06-20 20:38:23 -0500821};
822
Pekka Paalanende685b82012-12-04 15:58:12 +0200823struct weston_buffer_reference {
Jason Ekstrand6bd62942013-06-20 20:38:23 -0500824 struct weston_buffer *buffer;
Pekka Paalanende685b82012-12-04 15:58:12 +0200825 struct wl_listener destroy_listener;
826};
827
Pekka Paalanen1fd9c0f2013-11-26 18:19:41 +0100828struct weston_buffer_viewport {
Pekka Paalanen952b6c82014-03-14 14:38:15 +0200829 struct {
830 /* wl_surface.set_buffer_transform */
831 uint32_t transform;
Pekka Paalanen1fd9c0f2013-11-26 18:19:41 +0100832
Pekka Paalanen952b6c82014-03-14 14:38:15 +0200833 /* wl_surface.set_scaling_factor */
834 int32_t scale;
Jonny Lamb74130762013-11-26 18:19:46 +0100835
Pekka Paalanenf0cad482014-03-14 14:38:16 +0200836 /*
837 * If src_width != wl_fixed_from_int(-1),
838 * then and only then src_* are used.
839 */
Pekka Paalanen952b6c82014-03-14 14:38:15 +0200840 wl_fixed_t src_x, src_y;
841 wl_fixed_t src_width, src_height;
842 } buffer;
843
844 struct {
Pekka Paalanenf0cad482014-03-14 14:38:16 +0200845 /*
846 * If width == -1, the size is inferred from the buffer.
847 */
Pekka Paalanen952b6c82014-03-14 14:38:15 +0200848 int32_t width, height;
849 } surface;
George Kiagiadakis8f9e87f2014-06-13 18:14:20 +0200850
851 int changed;
Pekka Paalanen1fd9c0f2013-11-26 18:19:41 +0100852};
853
Kristian Høgsberg5e7e6f22012-02-23 16:11:59 -0500854struct weston_region {
Jason Ekstrand8895efc2013-06-14 10:07:56 -0500855 struct wl_resource *resource;
Kristian Høgsberg5e7e6f22012-02-23 16:11:59 -0500856 pixman_region32_t region;
857};
858
Jason Ekstranda7af7042013-10-12 22:38:11 -0500859/* Using weston_view transformations
Pekka Paalanen44ab69c2012-02-07 13:18:00 +0200860 *
Jason Ekstranda7af7042013-10-12 22:38:11 -0500861 * To add a transformation to a view, create a struct weston_transform, and
862 * add it to the list view->geometry.transformation_list. Whenever you
863 * change the list, anything under view->geometry, or anything in the
Pekka Paalanenc3ce7382013-03-08 14:56:49 +0200864 * weston_transforms linked into the list, you must call
Jason Ekstranda7af7042013-10-12 22:38:11 -0500865 * weston_view_geometry_dirty().
Pekka Paalanen44ab69c2012-02-07 13:18:00 +0200866 *
867 * The order in the list defines the order of transformations. Let the list
868 * contain the transformation matrices M1, ..., Mn as head to tail. The
Jason Ekstranda7af7042013-10-12 22:38:11 -0500869 * transformation is applied to view-local coordinate vector p as
Pekka Paalanen44ab69c2012-02-07 13:18:00 +0200870 * P = Mn * ... * M2 * M1 * p
871 * to produce the global coordinate vector P. The total transform
872 * Mn * ... * M2 * M1
Jason Ekstranda7af7042013-10-12 22:38:11 -0500873 * is cached in view->transform.matrix, and the inverse of it in
874 * view->transform.inverse.
Pekka Paalanen44ab69c2012-02-07 13:18:00 +0200875 *
Jason Ekstranda7af7042013-10-12 22:38:11 -0500876 * The list always contains view->transform.position transformation, which
877 * is the translation by view->geometry.x and y.
Pekka Paalanen44ab69c2012-02-07 13:18:00 +0200878 *
879 * If you want to apply a transformation in local coordinates, add your
880 * weston_transform to the head of the list. If you want to apply a
881 * transformation in global coordinates, add it to the tail of the list.
Pekka Paalanen483243f2013-03-08 14:56:50 +0200882 *
Jason Ekstranda7af7042013-10-12 22:38:11 -0500883 * If view->geometry.parent is set, the total transformation of this
884 * view will be the parent's total transformation and this transformation
Pekka Paalanen483243f2013-03-08 14:56:50 +0200885 * combined:
886 * Mparent * Mn * ... * M2 * M1
Pekka Paalanen44ab69c2012-02-07 13:18:00 +0200887 */
888
Jason Ekstranda7af7042013-10-12 22:38:11 -0500889struct weston_view {
890 struct weston_surface *surface;
891 struct wl_list surface_link;
Jason Ekstrand26ed73c2013-06-06 22:34:41 -0500892 struct wl_signal destroy_signal;
Jason Ekstranda7af7042013-10-12 22:38:11 -0500893
Pekka Paalanen20c7e552016-03-30 14:08:24 +0300894 struct wl_list link; /* weston_compositor::view_list */
Pekka Paalanen8844bf22015-02-18 16:30:47 +0200895 struct weston_layer_entry layer_link; /* part of geometry */
Kristian Høgsberg65a11e12012-08-03 11:30:18 -0400896 struct weston_plane *plane;
Pekka Paalanen2d6e5512015-02-18 16:06:46 +0200897
898 /* For weston_layer inheritance from another view */
Giulio Camuffo95ec0f92014-07-09 22:12:57 +0300899 struct weston_view *parent_view;
Jason Ekstranda7af7042013-10-12 22:38:11 -0500900
Pekka Paalanen51723d52015-02-17 13:10:01 +0200901 pixman_region32_t clip; /* See weston_view_damage_below() */
Jason Ekstranda7af7042013-10-12 22:38:11 -0500902 float alpha; /* part of geometry, see below */
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500903
John Kåre Alsaker878f4492012-11-13 19:10:23 +0100904 void *renderer_state;
905
Pekka Paalanenbc0b7e72012-01-24 09:53:37 +0200906 /* Surface geometry state, mutable.
Pekka Paalanenc3ce7382013-03-08 14:56:49 +0200907 * If you change anything, call weston_surface_geometry_dirty().
Pekka Paalanenbc0b7e72012-01-24 09:53:37 +0200908 * That includes the transformations referenced from the list.
909 */
Pekka Paalanenc61eca62012-01-06 14:10:06 +0200910 struct {
John Kåre Alsaker490d02a2012-09-30 02:57:21 +0200911 float x, y; /* surface translation on display */
Pekka Paalanenba3cf952012-01-25 16:22:05 +0200912
Pekka Paalanenbc0b7e72012-01-24 09:53:37 +0200913 /* struct weston_transform */
914 struct wl_list transformation_list;
Pekka Paalanen483243f2013-03-08 14:56:50 +0200915
916 /* managed by weston_surface_set_transform_parent() */
Jason Ekstranda7af7042013-10-12 22:38:11 -0500917 struct weston_view *parent;
Pekka Paalanen483243f2013-03-08 14:56:50 +0200918 struct wl_listener parent_destroy_listener;
919 struct wl_list child_list; /* geometry.parent_link */
920 struct wl_list parent_link;
Pekka Paalanen380adf52015-02-16 14:39:11 +0200921
922 /* managed by weston_view_set_mask() */
923 bool scissor_enabled;
924 pixman_region32_t scissor; /* always a simple rect */
Pekka Paalanenbc0b7e72012-01-24 09:53:37 +0200925 } geometry;
926
927 /* State derived from geometry state, read-only.
Jason Ekstranda7af7042013-10-12 22:38:11 -0500928 * This is updated by weston_view_update_transform().
Pekka Paalanenbc0b7e72012-01-24 09:53:37 +0200929 */
930 struct {
Pekka Paalanenc3ce7382013-03-08 14:56:49 +0200931 int dirty;
932
Pekka Paalanenfbd00f12015-02-19 11:49:18 +0200933 /* Approximations in global coordinates:
934 * - boundingbox is guaranteed to include the whole view in
935 * the smallest possible single rectangle.
936 * - opaque is guaranteed to be fully opaque, though not
937 * necessarily include all opaque areas.
938 */
Pekka Paalanen6720d8f2012-01-25 15:17:40 +0200939 pixman_region32_t boundingbox;
Pekka Paalanen730d87e2012-02-09 16:39:38 +0200940 pixman_region32_t opaque;
Pekka Paalanen6720d8f2012-01-25 15:17:40 +0200941
Pekka Paalanenbc0b7e72012-01-24 09:53:37 +0200942 /* matrix and inverse are used only if enabled = 1.
943 * If enabled = 0, use x, y, width, height directly.
944 */
945 int enabled;
Pekka Paalanen061b7472012-01-12 15:00:57 +0200946 struct weston_matrix matrix;
Pekka Paalanend1f0ab62012-01-20 10:47:57 +0200947 struct weston_matrix inverse;
Pekka Paalanencd403622012-01-25 13:37:39 +0200948
949 struct weston_transform position; /* matrix from x, y */
Pekka Paalanenc61eca62012-01-06 14:10:06 +0200950 } transform;
951
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500952 /*
Pekka Paalanen130ae6e2016-03-30 14:33:33 +0300953 * The primary output for this view.
954 * Used for picking the output for driving internal animations on the
955 * view, inheriting the primary output for related views in shells, etc.
Kristian Høgsberg8334bc12012-01-03 10:29:47 -0500956 */
957 struct weston_output *output;
958
Casey Dahlin9074db52012-04-19 22:50:09 -0400959 /*
960 * A more complete representation of all outputs this surface is
961 * displayed on.
962 */
963 uint32_t output_mask;
Pekka Paalanenbf0e0312014-12-17 16:20:41 +0200964
965 /* Per-surface Presentation feedback flags, controlled by backend. */
966 uint32_t psf_flags;
Jason Ekstranda7af7042013-10-12 22:38:11 -0500967};
968
Jason Ekstrand7b982072014-05-20 14:33:03 -0500969struct weston_surface_state {
970 /* wl_surface.attach */
971 int newly_attached;
972 struct weston_buffer *buffer;
973 struct wl_listener buffer_destroy_listener;
974 int32_t sx;
975 int32_t sy;
976
977 /* wl_surface.damage */
Derek Foreman152254b2015-11-26 14:17:48 -0600978 pixman_region32_t damage_surface;
979 /* wl_surface.damage_buffer */
980 pixman_region32_t damage_buffer;
Jason Ekstrand7b982072014-05-20 14:33:03 -0500981
982 /* wl_surface.set_opaque_region */
983 pixman_region32_t opaque;
984
985 /* wl_surface.set_input_region */
986 pixman_region32_t input;
987
988 /* wl_surface.frame */
989 struct wl_list frame_callback_list;
990
Pekka Paalanen133e4392014-09-23 22:08:46 -0400991 /* presentation.feedback */
992 struct wl_list feedback_list;
993
Jason Ekstrand7b982072014-05-20 14:33:03 -0500994 /* wl_surface.set_buffer_transform */
995 /* wl_surface.set_scaling_factor */
996 /* wl_viewport.set */
997 struct weston_buffer_viewport buffer_viewport;
998};
999
Jason Ekstranda7af7042013-10-12 22:38:11 -05001000struct weston_surface {
1001 struct wl_resource *resource;
Pekka Paalanenca790762015-04-17 14:23:38 +03001002 struct wl_signal destroy_signal; /* callback argument: this surface */
Jason Ekstranda7af7042013-10-12 22:38:11 -05001003 struct weston_compositor *compositor;
Pekka Paalanene508ce62015-02-19 13:59:55 +02001004
1005 /** Damage in local coordinates from the client, for tex upload. */
Jason Ekstranda7af7042013-10-12 22:38:11 -05001006 pixman_region32_t damage;
Pekka Paalanene508ce62015-02-19 13:59:55 +02001007
Jason Ekstranda7af7042013-10-12 22:38:11 -05001008 pixman_region32_t opaque; /* part of geometry, see below */
1009 pixman_region32_t input;
1010 int32_t width, height;
1011 int32_t ref_count;
1012
1013 /* Not for long-term storage. This exists for book-keeping while
1014 * iterating over surfaces and views
1015 */
Derek Foreman060cf112015-11-18 16:32:26 -06001016 bool touched;
Jason Ekstranda7af7042013-10-12 22:38:11 -05001017
1018 void *renderer_state;
1019
1020 struct wl_list views;
1021
1022 /*
1023 * Which output to vsync this surface to.
Pekka Paalanen130ae6e2016-03-30 14:33:33 +03001024 * Used to determine whether to send or queue frame events, and for
1025 * other client-visible syncing/throttling tied to the output
1026 * repaint cycle.
Jason Ekstranda7af7042013-10-12 22:38:11 -05001027 */
1028 struct weston_output *output;
1029
1030 /*
1031 * A more complete representation of all outputs this surface is
1032 * displayed on.
1033 */
1034 uint32_t output_mask;
Casey Dahlin9074db52012-04-19 22:50:09 -04001035
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001036 struct wl_list frame_callback_list;
Pekka Paalanen133e4392014-09-23 22:08:46 -04001037 struct wl_list feedback_list;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001038
Pekka Paalanende685b82012-12-04 15:58:12 +02001039 struct weston_buffer_reference buffer_ref;
Pekka Paalanen1fd9c0f2013-11-26 18:19:41 +01001040 struct weston_buffer_viewport buffer_viewport;
Pekka Paalanen0b4c5352014-03-14 14:38:17 +02001041 int32_t width_from_buffer; /* before applying viewport */
1042 int32_t height_from_buffer;
Derek Foreman0fd6d4e2014-10-10 09:36:45 -05001043 bool keep_buffer; /* for backends to prevent early release */
Alex Wu8811bf92012-02-28 18:07:54 +08001044
Pekka Paalanenb0420ae2014-01-08 15:39:17 +02001045 /* wl_viewport resource for this surface */
1046 struct wl_resource *viewport_resource;
Jonny Lamb74130762013-11-26 18:19:46 +01001047
Pekka Paalanen5df44de2012-10-10 12:49:23 +03001048 /* All the pending state, that wl_surface.commit will apply. */
Jason Ekstrand7b982072014-05-20 14:33:03 -05001049 struct weston_surface_state pending;
Pekka Paalanen5df44de2012-10-10 12:49:23 +03001050
Jason Ekstrand1e059042014-10-16 10:55:19 -05001051 /* Matrices representating of the full transformation between
1052 * buffer and surface coordinates. These matrices are updated
1053 * using the weston_surface_build_buffer_matrix function. */
1054 struct weston_matrix buffer_to_surface_matrix;
1055 struct weston_matrix surface_to_buffer_matrix;
1056
Ander Conselvan de Oliveira093bfa32012-03-27 17:36:41 +03001057 /*
Jasper St. Pierred67b52a2014-04-28 11:19:27 -04001058 * If non-NULL, this function will be called on
1059 * wl_surface::commit after a new buffer has been set up for
1060 * this surface. The integer params are the sx and sy
1061 * parameters supplied to wl_surface::attach.
Ander Conselvan de Oliveira093bfa32012-03-27 17:36:41 +03001062 */
Jason Ekstrand918f2dd2013-12-02 21:01:53 -06001063 void (*configure)(struct weston_surface *es, int32_t sx, int32_t sy);
Giulio Camuffo7fe01b12013-03-28 18:02:42 +01001064 void *configure_private;
Pekka Paalanen8274d902014-08-06 19:36:51 +03001065 int (*get_label)(struct weston_surface *surface, char *buf, size_t len);
Pekka Paalanene67858b2013-04-25 13:57:42 +03001066
1067 /* Parent's list of its sub-surfaces, weston_subsurface:parent_link.
1068 * Contains also the parent itself as a dummy weston_subsurface,
1069 * if the list is not empty.
1070 */
1071 struct wl_list subsurface_list; /* weston_subsurface::parent_link */
1072 struct wl_list subsurface_list_pending; /* ...::parent_link_pending */
Pekka Paalanen50b67472014-10-01 15:02:41 +03001073
1074 /*
1075 * For tracking protocol role assignments. Different roles may
1076 * have the same configure hook, e.g. in shell.c. Configure hook
1077 * may get reset, this will not.
1078 * XXX: map configure functions 1:1 to roles, and never reset it,
1079 * and replace role_name with configure.
1080 */
1081 const char *role_name;
Pekka Paalanenb5026542014-11-12 15:09:24 +02001082
1083 struct weston_timeline_object timeline;
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001084};
1085
Jason Ekstrande9d40e32014-05-20 11:23:53 -05001086struct weston_subsurface {
1087 struct wl_resource *resource;
1088
1089 /* guaranteed to be valid and non-NULL */
1090 struct weston_surface *surface;
1091 struct wl_listener surface_destroy_listener;
1092
1093 /* can be NULL */
1094 struct weston_surface *parent;
1095 struct wl_listener parent_destroy_listener;
1096 struct wl_list parent_link;
1097 struct wl_list parent_link_pending;
1098
1099 struct {
1100 int32_t x;
1101 int32_t y;
1102 int set;
1103 } position;
1104
Jason Ekstrand7b982072014-05-20 14:33:03 -05001105 int has_cached_data;
1106 struct weston_surface_state cached;
1107 struct weston_buffer_reference cached_buffer_ref;
Jason Ekstrande9d40e32014-05-20 11:23:53 -05001108
1109 int synchronized;
1110
1111 /* Used for constructing the view tree */
1112 struct wl_list unused_views;
1113};
1114
Daniel Stoned6da09e2012-06-22 13:21:29 +01001115enum weston_key_state_update {
1116 STATE_UPDATE_AUTOMATIC,
1117 STATE_UPDATE_NONE,
1118};
1119
Kristian Høgsberg9ddb8262012-01-04 21:30:29 -05001120void
Kristian Høgsbergaf4f2aa2013-02-15 20:53:20 -05001121weston_version(int *major, int *minor, int *micro);
1122
1123void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001124weston_view_update_transform(struct weston_view *view);
Pekka Paalanen460099f2012-01-20 16:48:25 +02001125
1126void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001127weston_view_geometry_dirty(struct weston_view *view);
Pekka Paalanenc3ce7382013-03-08 14:56:49 +02001128
1129void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001130weston_view_to_global_fixed(struct weston_view *view,
1131 wl_fixed_t sx, wl_fixed_t sy,
1132 wl_fixed_t *x, wl_fixed_t *y);
Daniel Stonebd3489b2012-05-08 17:17:53 +01001133void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001134weston_view_to_global_float(struct weston_view *view,
1135 float sx, float sy, float *x, float *y);
Pekka Paalanene0f3cb22012-01-24 09:59:29 +02001136
1137void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001138weston_view_from_global_float(struct weston_view *view,
1139 float x, float y, float *vx, float *vy);
Kristian Høgsbergecf6ede2012-09-05 21:59:35 -04001140void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001141weston_view_from_global(struct weston_view *view,
1142 int32_t x, int32_t y, int32_t *vx, int32_t *vy);
Daniel Stonebd3489b2012-05-08 17:17:53 +01001143void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001144weston_view_from_global_fixed(struct weston_view *view,
1145 wl_fixed_t x, wl_fixed_t y,
1146 wl_fixed_t *vx, wl_fixed_t *vy);
Pekka Paalanene0f3cb22012-01-24 09:59:29 +02001147
Derek Foremand1be3122014-09-18 16:46:49 -05001148void
Ander Conselvan de Oliveira0396ba22012-11-28 17:10:26 +02001149weston_surface_to_buffer_float(struct weston_surface *surface,
1150 float x, float y, float *bx, float *by);
1151pixman_box32_t
1152weston_surface_to_buffer_rect(struct weston_surface *surface,
1153 pixman_box32_t rect);
1154
Pekka Paalanene0f3cb22012-01-24 09:59:29 +02001155void
Pekka Paalanene54e31c2015-03-04 14:23:28 +02001156weston_surface_to_buffer_region(struct weston_surface *surface,
1157 pixman_region32_t *surface_region,
1158 pixman_region32_t *buffer_region);
1159
1160void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001161weston_spring_init(struct weston_spring *spring,
1162 double k, double current, double target);
1163void
1164weston_spring_update(struct weston_spring *spring, uint32_t msec);
1165int
1166weston_spring_done(struct weston_spring *spring);
1167
1168void
1169weston_surface_activate(struct weston_surface *surface,
Daniel Stone37816df2012-05-16 18:45:18 +01001170 struct weston_seat *seat);
Kristian Høgsberg68c479a2012-01-25 23:32:28 -05001171void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001172notify_motion(struct weston_seat *seat, uint32_t time,
Jonas Ådahld2510102014-10-05 21:39:14 +02001173 struct weston_pointer_motion_event *event);
Rob Bradfordc088e2c2013-03-27 15:59:43 +00001174void
1175notify_motion_absolute(struct weston_seat *seat, uint32_t time,
Giulio Camuffo90a6fc62016-03-22 17:44:54 +02001176 double x, double y);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001177void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001178notify_button(struct weston_seat *seat, uint32_t time, int32_t button,
Daniel Stone4dbadb12012-05-30 16:31:51 +01001179 enum wl_pointer_button_state state);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001180void
Peter Hutterer89b6a492016-01-18 15:58:17 +10001181notify_axis(struct weston_seat *seat, uint32_t time,
1182 struct weston_pointer_axis_event *event);
Scott Moreau210d0792012-03-22 10:47:01 -06001183void
Peter Hutterer87743e92016-01-18 16:38:22 +10001184notify_axis_source(struct weston_seat *seat, uint32_t source);
1185
1186void
1187notify_pointer_frame(struct weston_seat *seat);
1188
1189void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001190notify_key(struct weston_seat *seat, uint32_t time, uint32_t key,
Daniel Stone1b4e11f2012-06-22 13:21:37 +01001191 enum wl_keyboard_key_state state,
1192 enum weston_key_state_update update_state);
Daniel Stone05d58682012-06-22 13:21:38 +01001193void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001194notify_modifiers(struct weston_seat *seat, uint32_t serial);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001195
1196void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001197notify_pointer_focus(struct weston_seat *seat, struct weston_output *output,
Giulio Camuffo90a6fc62016-03-22 17:44:54 +02001198 double x, double y);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001199
1200void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001201notify_keyboard_focus_in(struct weston_seat *seat, struct wl_array *keys,
Daniel Stoned6da09e2012-06-22 13:21:29 +01001202 enum weston_key_state_update update_state);
1203void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001204notify_keyboard_focus_out(struct weston_seat *seat);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001205
1206void
Kristian Høgsbergcb3eaae2012-08-10 09:50:11 -04001207notify_touch(struct weston_seat *seat, uint32_t time, int touch_id,
Giulio Camuffo90a6fc62016-03-22 17:44:54 +02001208 double x, double y, int touch_type);
Jonas Ådahl1679f232014-04-12 09:39:51 +02001209void
1210notify_touch_frame(struct weston_seat *seat);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001211
1212void
Derek Foreman3cc004a2015-11-06 15:56:09 -06001213notify_touch_cancel(struct weston_seat *seat);
1214
1215void
Giulio Camuffo412e6a52014-07-09 22:12:56 +03001216weston_layer_entry_insert(struct weston_layer_entry *list,
1217 struct weston_layer_entry *entry);
1218void
1219weston_layer_entry_remove(struct weston_layer_entry *entry);
1220void
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -05001221weston_layer_init(struct weston_layer *layer, struct wl_list *below);
1222
1223void
Giulio Camuffo95ec0f92014-07-09 22:12:57 +03001224weston_layer_set_mask(struct weston_layer *layer, int x, int y, int width, int height);
1225
1226void
1227weston_layer_set_mask_infinite(struct weston_layer *layer);
1228
1229void
Xiong Zhang97116532013-10-23 13:58:31 +08001230weston_plane_init(struct weston_plane *plane,
1231 struct weston_compositor *ec,
1232 int32_t x, int32_t y);
Kristian Høgsberg65a11e12012-08-03 11:30:18 -04001233void
1234weston_plane_release(struct weston_plane *plane);
1235
1236void
Ander Conselvan de Oliveira8ad19822013-03-05 17:30:27 +02001237weston_compositor_stack_plane(struct weston_compositor *ec,
1238 struct weston_plane *plane,
1239 struct weston_plane *above);
1240
Pekka Paalanen363aa7b2014-12-17 16:20:40 +02001241/* An invalid flag in presented_flags to catch logic errors. */
Pekka Paalanenb00c79b2016-02-18 16:53:27 +02001242#define WP_PRESENTATION_FEEDBACK_INVALID (1U << 31)
Pekka Paalanen363aa7b2014-12-17 16:20:40 +02001243
Ander Conselvan de Oliveira8ad19822013-03-05 17:30:27 +02001244void
Pekka Paalanenb5eedad2014-09-23 22:08:45 -04001245weston_output_finish_frame(struct weston_output *output,
Pekka Paalanen363aa7b2014-12-17 16:20:40 +02001246 const struct timespec *stamp,
1247 uint32_t presented_flags);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001248void
Kristian Høgsberg49952d12012-06-20 00:35:59 -04001249weston_output_schedule_repaint(struct weston_output *output);
1250void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001251weston_output_damage(struct weston_output *output);
1252void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001253weston_compositor_schedule_repaint(struct weston_compositor *compositor);
1254void
1255weston_compositor_fade(struct weston_compositor *compositor, float tint);
1256void
1257weston_compositor_damage_all(struct weston_compositor *compositor);
1258void
1259weston_compositor_unlock(struct weston_compositor *compositor);
1260void
1261weston_compositor_wake(struct weston_compositor *compositor);
1262void
Philipp Brüschweiler57edf7f2013-03-29 13:01:56 +01001263weston_compositor_offscreen(struct weston_compositor *compositor);
1264void
Ander Conselvan de Oliveira87524b62013-02-21 18:35:22 +02001265weston_compositor_sleep(struct weston_compositor *compositor);
Jason Ekstranda7af7042013-10-12 22:38:11 -05001266struct weston_view *
1267weston_compositor_pick_view(struct weston_compositor *compositor,
1268 wl_fixed_t x, wl_fixed_t y,
1269 wl_fixed_t *sx, wl_fixed_t *sy);
Ander Conselvan de Oliveira30eebc72012-02-15 17:02:57 +02001270
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001271
1272struct weston_binding;
Derek Foreman8ae2db52015-07-15 13:00:36 -05001273typedef void (*weston_key_binding_handler_t)(struct weston_keyboard *keyboard,
Daniel Stone325fc2d2012-05-30 16:31:58 +01001274 uint32_t time, uint32_t key,
1275 void *data);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001276struct weston_binding *
Daniel Stone325fc2d2012-05-30 16:31:58 +01001277weston_compositor_add_key_binding(struct weston_compositor *compositor,
1278 uint32_t key,
1279 enum weston_keyboard_modifier modifier,
1280 weston_key_binding_handler_t binding,
1281 void *data);
1282
Derek Foreman8ae2db52015-07-15 13:00:36 -05001283typedef void (*weston_modifier_binding_handler_t)(struct weston_keyboard *keyboard,
Daniel Stone96d47c02013-11-19 11:37:12 +01001284 enum weston_keyboard_modifier modifier,
1285 void *data);
1286struct weston_binding *
1287weston_compositor_add_modifier_binding(struct weston_compositor *compositor,
1288 enum weston_keyboard_modifier modifier,
1289 weston_modifier_binding_handler_t binding,
1290 void *data);
1291
Derek Foreman8ae2db52015-07-15 13:00:36 -05001292typedef void (*weston_button_binding_handler_t)(struct weston_pointer *pointer,
Daniel Stone325fc2d2012-05-30 16:31:58 +01001293 uint32_t time, uint32_t button,
1294 void *data);
1295struct weston_binding *
1296weston_compositor_add_button_binding(struct weston_compositor *compositor,
1297 uint32_t button,
1298 enum weston_keyboard_modifier modifier,
1299 weston_button_binding_handler_t binding,
1300 void *data);
1301
Derek Foreman8ae2db52015-07-15 13:00:36 -05001302typedef void (*weston_touch_binding_handler_t)(struct weston_touch *touch,
Neil Robertsa28c6932013-10-03 16:43:04 +01001303 uint32_t time,
1304 void *data);
1305struct weston_binding *
1306weston_compositor_add_touch_binding(struct weston_compositor *compositor,
1307 enum weston_keyboard_modifier modifier,
1308 weston_touch_binding_handler_t binding,
1309 void *data);
1310
Derek Foreman8ae2db52015-07-15 13:00:36 -05001311typedef void (*weston_axis_binding_handler_t)(struct weston_pointer *pointer,
Peter Hutterer89b6a492016-01-18 15:58:17 +10001312 uint32_t time,
1313 struct weston_pointer_axis_event *event,
1314 void *data);
Daniel Stone325fc2d2012-05-30 16:31:58 +01001315struct weston_binding *
1316weston_compositor_add_axis_binding(struct weston_compositor *compositor,
1317 uint32_t axis,
1318 enum weston_keyboard_modifier modifier,
1319 weston_axis_binding_handler_t binding,
1320 void *data);
Ander Conselvan de Oliveirac509d2b2012-11-08 17:20:45 +02001321struct weston_binding *
1322weston_compositor_add_debug_binding(struct weston_compositor *compositor,
1323 uint32_t key,
1324 weston_key_binding_handler_t binding,
1325 void *data);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001326void
1327weston_binding_destroy(struct weston_binding *binding);
1328
1329void
Pekka Paalanen2829f7c2015-02-19 17:02:13 +02001330weston_install_debug_key_binding(struct weston_compositor *compositor,
1331 uint32_t mod);
1332
1333void
Kristian Høgsberg3466bc82012-01-03 11:29:15 -05001334weston_binding_list_destroy_all(struct wl_list *list);
1335
Pekka Paalanen86b53962014-11-19 13:43:32 +02001336void
Daniel Stone325fc2d2012-05-30 16:31:58 +01001337weston_compositor_run_key_binding(struct weston_compositor *compositor,
Derek Foreman99a6a2d2015-07-15 13:00:43 -05001338 struct weston_keyboard *keyboard,
1339 uint32_t time,
Daniel Stone325fc2d2012-05-30 16:31:58 +01001340 uint32_t key,
1341 enum wl_keyboard_key_state state);
Daniel Stone96d47c02013-11-19 11:37:12 +01001342
1343void
1344weston_compositor_run_modifier_binding(struct weston_compositor *compositor,
Derek Foreman99a6a2d2015-07-15 13:00:43 -05001345 struct weston_keyboard *keyboard,
Daniel Stone96d47c02013-11-19 11:37:12 +01001346 enum weston_keyboard_modifier modifier,
1347 enum wl_keyboard_key_state state);
Daniel Stone325fc2d2012-05-30 16:31:58 +01001348void
1349weston_compositor_run_button_binding(struct weston_compositor *compositor,
Derek Foreman99a6a2d2015-07-15 13:00:43 -05001350 struct weston_pointer *pointer, uint32_t time,
Daniel Stone325fc2d2012-05-30 16:31:58 +01001351 uint32_t button,
1352 enum wl_pointer_button_state value);
Neil Robertsa28c6932013-10-03 16:43:04 +01001353void
1354weston_compositor_run_touch_binding(struct weston_compositor *compositor,
Derek Foreman99a6a2d2015-07-15 13:00:43 -05001355 struct weston_touch *touch, uint32_t time,
Neil Robertsa28c6932013-10-03 16:43:04 +01001356 int touch_type);
Rune K. Svendsen14b2fe72013-03-07 21:50:00 +01001357int
Daniel Stone325fc2d2012-05-30 16:31:58 +01001358weston_compositor_run_axis_binding(struct weston_compositor *compositor,
Derek Foreman99a6a2d2015-07-15 13:00:43 -05001359 struct weston_pointer *pointer, uint32_t time,
Peter Hutterer89b6a492016-01-18 15:58:17 +10001360 struct weston_pointer_axis_event *event);
Ander Conselvan de Oliveirac509d2b2012-11-08 17:20:45 +02001361int
1362weston_compositor_run_debug_binding(struct weston_compositor *compositor,
Derek Foreman99a6a2d2015-07-15 13:00:43 -05001363 struct weston_keyboard *keyboard, uint32_t time,
Ander Conselvan de Oliveirac509d2b2012-11-08 17:20:45 +02001364 uint32_t key,
1365 enum wl_keyboard_key_state state);
Daniel Stone325fc2d2012-05-30 16:31:58 +01001366
Giulio Camuffocdb4d292013-11-14 23:42:53 +01001367void
1368weston_compositor_set_default_pointer_grab(struct weston_compositor *compositor,
1369 const struct weston_pointer_grab_interface *interface);
1370
Benjamin Franzkebfeda132012-01-30 14:04:04 +01001371int
1372weston_environment_get_fd(const char *env);
1373
Kristian Høgsberga82c4862012-01-26 01:03:58 -05001374struct wl_list *
1375weston_compositor_top(struct weston_compositor *compositor);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001376
1377struct weston_surface *
Kristian Høgsberg18c93002012-01-27 11:58:31 -05001378weston_surface_create(struct weston_compositor *compositor);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001379
Jason Ekstranda7af7042013-10-12 22:38:11 -05001380struct weston_view *
1381weston_view_create(struct weston_surface *surface);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001382
1383void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001384weston_view_destroy(struct weston_view *view);
Kristian Høgsberg3be2ce92012-02-29 12:42:35 -05001385
1386void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001387weston_view_set_position(struct weston_view *view,
1388 float x, float y);
1389
1390void
1391weston_view_set_transform_parent(struct weston_view *view,
1392 struct weston_view *parent);
1393
Pekka Paalanen380adf52015-02-16 14:39:11 +02001394void
1395weston_view_set_mask(struct weston_view *view,
1396 int x, int y, int width, int height);
1397
1398void
1399weston_view_set_mask_infinite(struct weston_view *view);
1400
Derek Foreman280e7dd2014-10-03 13:13:42 -05001401bool
Jason Ekstranda7af7042013-10-12 22:38:11 -05001402weston_view_is_mapped(struct weston_view *view);
1403
1404void
1405weston_view_schedule_repaint(struct weston_view *view);
Pekka Paalanen483243f2013-03-08 14:56:50 +02001406
Derek Foreman280e7dd2014-10-03 13:13:42 -05001407bool
Ander Conselvan de Oliveirab8ab14f2012-03-27 17:36:36 +03001408weston_surface_is_mapped(struct weston_surface *surface);
1409
Derek Foremand1be3122014-09-18 16:46:49 -05001410void
Jason Ekstrand5c11a332013-12-04 20:32:03 -06001411weston_surface_set_size(struct weston_surface *surface,
1412 int32_t width, int32_t height);
1413
Pekka Paalanen8fb8d3b2012-02-13 13:03:59 +02001414void
Kristian Høgsberg98238702012-08-03 16:29:12 -04001415weston_surface_schedule_repaint(struct weston_surface *surface);
1416
1417void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001418weston_surface_damage(struct weston_surface *surface);
1419
1420void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001421weston_view_damage_below(struct weston_view *view);
Kristian Høgsbergd8bf90c2012-02-23 23:03:14 -05001422
1423void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001424weston_view_move_to_plane(struct weston_view *view,
1425 struct weston_plane *plane);
1426void
1427weston_view_unmap(struct weston_view *view);
1428
Kristian Høgsberg65a11e12012-08-03 11:30:18 -04001429void
Kristian Høgsbergaf7b1ff2012-06-26 21:19:23 -04001430weston_surface_unmap(struct weston_surface *surface);
1431
Pekka Paalanen01388e22013-04-25 13:57:44 +03001432struct weston_surface *
1433weston_surface_get_main_surface(struct weston_surface *surface);
1434
Pekka Paalanen50b67472014-10-01 15:02:41 +03001435int
1436weston_surface_set_role(struct weston_surface *surface,
1437 const char *role_name,
1438 struct wl_resource *error_resource,
1439 uint32_t error_code);
1440
Pekka Paalanen8274d902014-08-06 19:36:51 +03001441void
1442weston_surface_set_label_func(struct weston_surface *surface,
1443 int (*desc)(struct weston_surface *,
1444 char *, size_t));
1445
Pekka Paalanenc647ed72015-02-09 13:16:57 +02001446void
1447weston_surface_get_content_size(struct weston_surface *surface,
1448 int *width, int *height);
1449
1450int
1451weston_surface_copy_content(struct weston_surface *surface,
1452 void *target, size_t size,
1453 int src_x, int src_y,
1454 int width, int height);
1455
Jason Ekstrand6bd62942013-06-20 20:38:23 -05001456struct weston_buffer *
1457weston_buffer_from_resource(struct wl_resource *resource);
1458
Kristian Høgsbergaf7b1ff2012-06-26 21:19:23 -04001459void
Pekka Paalanende685b82012-12-04 15:58:12 +02001460weston_buffer_reference(struct weston_buffer_reference *ref,
Jason Ekstrand6bd62942013-06-20 20:38:23 -05001461 struct weston_buffer *buffer);
Pekka Paalanende685b82012-12-04 15:58:12 +02001462
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001463uint32_t
1464weston_compositor_get_time(void);
1465
Giulio Camuffo459137b2014-10-11 23:56:24 +03001466void
1467weston_compositor_destroy(struct weston_compositor *ec);
1468struct weston_compositor *
1469weston_compositor_create(struct wl_display *display, void *user_data);
Pekka Paalanen50dbf382016-06-03 15:23:46 +03001470
1471enum weston_compositor_backend {
1472 WESTON_BACKEND_DRM,
1473 WESTON_BACKEND_FBDEV,
1474 WESTON_BACKEND_HEADLESS,
1475 WESTON_BACKEND_RDP,
1476 WESTON_BACKEND_WAYLAND,
1477 WESTON_BACKEND_X11,
1478};
1479
Pekka Paalanendd186732016-06-03 14:49:54 +03001480int
1481weston_compositor_load_backend(struct weston_compositor *compositor,
Pekka Paalanen50dbf382016-06-03 15:23:46 +03001482 enum weston_compositor_backend backend,
Pekka Paalanendd186732016-06-03 14:49:54 +03001483 struct weston_backend_config *config_base);
Giulio Camuffo459137b2014-10-11 23:56:24 +03001484void
1485weston_compositor_exit(struct weston_compositor *ec);
1486void *
1487weston_compositor_get_user_data(struct weston_compositor *compositor);
Pekka Paalanenb5eedad2014-09-23 22:08:45 -04001488int
1489weston_compositor_set_presentation_clock(struct weston_compositor *compositor,
1490 clockid_t clk_id);
1491int
1492weston_compositor_set_presentation_clock_software(
1493 struct weston_compositor *compositor);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001494void
Pekka Paalanen662f3842015-03-18 12:17:26 +02001495weston_compositor_read_presentation_clock(
1496 const struct weston_compositor *compositor,
1497 struct timespec *ts);
1498
Pekka Paalanen230f3b12014-09-29 14:18:40 -04001499bool
1500weston_compositor_import_dmabuf(struct weston_compositor *compositor,
1501 struct linux_dmabuf_buffer *buffer);
1502
Pekka Paalanen662f3842015-03-18 12:17:26 +02001503void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001504weston_compositor_shutdown(struct weston_compositor *ec);
1505void
Frederic Plourdec336f062014-10-29 14:44:33 -04001506weston_compositor_exit_with_code(struct weston_compositor *compositor,
1507 int exit_code);
1508void
Scott Moreau429490d2012-06-17 18:10:59 -06001509weston_output_init_zoom(struct weston_output *output);
1510void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001511weston_output_update_zoom(struct weston_output *output);
Scott Moreauccbf29d2012-02-22 14:21:41 -07001512void
Derek Foreman22276a52015-07-23 14:55:15 -05001513weston_output_activate_zoom(struct weston_output *output,
1514 struct weston_seat *seat);
Giulio Camuffo412b0242013-11-14 23:42:51 +01001515void
Scott Moreauccbf29d2012-02-22 14:21:41 -07001516weston_output_update_matrix(struct weston_output *output);
1517void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001518weston_output_move(struct weston_output *output, int x, int y);
1519void
1520weston_output_init(struct weston_output *output, struct weston_compositor *c,
Alexander Larssonedddbd12013-05-24 13:09:43 +02001521 int x, int y, int width, int height, uint32_t transform, int32_t scale);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001522void
Giulio Camuffob1147152015-05-06 21:41:57 +03001523weston_compositor_add_output(struct weston_compositor *compositor,
1524 struct weston_output *output);
1525void
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001526weston_output_destroy(struct weston_output *output);
Kristian Høgsberg98c774f2013-07-22 14:33:42 -07001527void
Jason Ekstrandb6a3cc72013-10-27 22:25:00 -05001528weston_output_transform_coordinate(struct weston_output *output,
Giulio Camuffo90a6fc62016-03-22 17:44:54 +02001529 double device_x, double device_y,
1530 double *x, double *y);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001531
1532void
Rob Bradford9af5f9e2013-05-31 18:09:50 +01001533weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec,
1534 const char *seat_name);
Daniel Stone74419a22012-05-30 16:32:02 +01001535void
1536weston_seat_init_pointer(struct weston_seat *seat);
Jonas Ådahld6e1c342013-10-17 23:04:05 +02001537void
1538weston_seat_release_pointer(struct weston_seat *seat);
Kristian Høgsberg2f07ef62013-02-16 14:29:24 -05001539int
Daniel Stonebb1df6a2012-05-30 16:32:06 +01001540weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
Daniel Stone74419a22012-05-30 16:32:02 +01001541void
Jonas Ådahld6e1c342013-10-17 23:04:05 +02001542weston_seat_release_keyboard(struct weston_seat *seat);
1543void
Daniel Stone74419a22012-05-30 16:32:02 +01001544weston_seat_init_touch(struct weston_seat *seat);
Kristian Høgsbergb5e26102013-04-18 15:40:10 -04001545void
Jonas Ådahld6e1c342013-10-17 23:04:05 +02001546weston_seat_release_touch(struct weston_seat *seat);
1547void
Kristian Høgsberga71e8b22013-05-06 21:51:21 -04001548weston_seat_repick(struct weston_seat *seat);
Rui Matos65196bc2013-10-10 19:44:19 +02001549void
1550weston_seat_update_keymap(struct weston_seat *seat, struct xkb_keymap *keymap);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001551
1552void
Daniel Stone37816df2012-05-16 18:45:18 +01001553weston_seat_release(struct weston_seat *seat);
Kristian Høgsbergb5e26102013-04-18 15:40:10 -04001554int
Giulio Camuffo0358af42016-06-02 21:48:08 +03001555weston_compositor_set_xkb_rule_names(struct weston_compositor *ec,
1556 struct xkb_rule_names *names);
Kristian Høgsbergb5e26102013-04-18 15:40:10 -04001557void
1558weston_compositor_xkb_destroy(struct weston_compositor *ec);
Kristian Høgsberg3466bc82012-01-03 11:29:15 -05001559
Kristian Høgsberg64eca892012-08-01 00:00:57 -04001560/* String literal of spaces, the same width as the timestamp. */
1561#define STAMP_SPACE " "
1562
Giulio Camuffobe2b11a2016-06-02 21:48:13 +03001563typedef int (*log_func_t)(const char *fmt, va_list ap);
Kristian Høgsberg64eca892012-08-01 00:00:57 -04001564void
Giulio Camuffobe2b11a2016-06-02 21:48:13 +03001565weston_log_set_handler(log_func_t log, log_func_t cont);
Kristian Høgsberg64eca892012-08-01 00:00:57 -04001566int
Kristian Høgsberg082d58c2013-06-18 01:00:27 -04001567weston_vlog(const char *fmt, va_list ap);
1568int
1569weston_vlog_continue(const char *fmt, va_list ap);
1570int
Pekka Paalanend525b562012-08-06 14:57:04 +03001571weston_log(const char *fmt, ...)
1572 __attribute__ ((format (printf, 1, 2)));
Kristian Høgsberg64eca892012-08-01 00:00:57 -04001573int
Pekka Paalanend525b562012-08-06 14:57:04 +03001574weston_log_continue(const char *fmt, ...)
1575 __attribute__ ((format (printf, 1, 2)));
Kristian Høgsberg64eca892012-08-01 00:00:57 -04001576
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001577enum {
1578 TTY_ENTER_VT,
1579 TTY_LEAVE_VT
1580};
1581
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001582struct tty *
Kristian Høgsberg61741a22013-09-17 16:02:57 -07001583tty_create(struct weston_compositor *compositor, int tty_nr);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001584
1585void
1586tty_destroy(struct tty *tty);
1587
Kristian Høgsberg7b884bc2012-07-31 14:32:01 -04001588void
1589tty_reset(struct tty *tty);
1590
Kristian Høgsberg5d1c0c52012-04-10 00:11:50 -04001591int
1592tty_activate_vt(struct tty *tty, int vt);
1593
Giulio Camuffoe9022e72013-12-11 23:45:11 +01001594enum weston_screenshooter_outcome {
1595 WESTON_SCREENSHOOTER_SUCCESS,
1596 WESTON_SCREENSHOOTER_NO_MEMORY,
1597 WESTON_SCREENSHOOTER_BAD_BUFFER
1598};
1599
1600typedef void (*weston_screenshooter_done_func_t)(void *data,
1601 enum weston_screenshooter_outcome outcome);
1602int
1603weston_screenshooter_shoot(struct weston_output *output, struct weston_buffer *buffer,
1604 weston_screenshooter_done_func_t done, void *data);
Giulio Camuffo26f62d42016-06-02 21:48:09 +03001605struct weston_recorder *
1606weston_recorder_start(struct weston_output *output, const char *filename);
1607void
1608weston_recorder_stop(struct weston_recorder *recorder);
Giulio Camuffoe9022e72013-12-11 23:45:11 +01001609
Kristian Høgsberga7ceaff2012-06-03 10:20:13 -04001610struct clipboard *
1611clipboard_create(struct weston_seat *seat);
1612
Pekka Paalanenaa9536a2015-06-24 16:09:17 +03001613struct text_backend;
1614
1615struct text_backend *
Jan Arne Petersen674fd1d2012-11-18 19:06:42 +01001616text_backend_init(struct weston_compositor *ec);
Jan Arne Petersen1f17be42012-06-21 21:52:18 +02001617
Pekka Paalanenaa9536a2015-06-24 16:09:17 +03001618void
1619text_backend_destroy(struct text_backend *text_backend);
1620
Jason Ekstranda7af7042013-10-12 22:38:11 -05001621struct weston_view_animation;
1622typedef void (*weston_view_animation_done_func_t)(struct weston_view_animation *animation, void *data);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001623
Louis-Francis Ratté-Boulianneb482dbd2013-11-19 11:37:11 +01001624void
1625weston_view_animation_destroy(struct weston_view_animation *animation);
1626
Jason Ekstranda7af7042013-10-12 22:38:11 -05001627struct weston_view_animation *
1628weston_zoom_run(struct weston_view *view, float start, float stop,
1629 weston_view_animation_done_func_t done, void *data);
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001630
Jason Ekstranda7af7042013-10-12 22:38:11 -05001631struct weston_view_animation *
1632weston_fade_run(struct weston_view *view,
Ander Conselvan de Oliveiraee416052013-02-21 18:35:17 +02001633 float start, float end, float k,
Jason Ekstranda7af7042013-10-12 22:38:11 -05001634 weston_view_animation_done_func_t done, void *data);
Daniel Stonea67e6b92013-11-19 11:37:13 +01001635
1636struct weston_view_animation *
1637weston_move_scale_run(struct weston_view *view, int dx, int dy,
1638 float start, float end, int reverse,
1639 weston_view_animation_done_func_t done, void *data);
1640
Ander Conselvan de Oliveiraee416052013-02-21 18:35:17 +02001641void
Jason Ekstranda7af7042013-10-12 22:38:11 -05001642weston_fade_update(struct weston_view_animation *fade, float target);
Ander Conselvan de Oliveiraee416052013-02-21 18:35:17 +02001643
Jason Ekstranda7af7042013-10-12 22:38:11 -05001644struct weston_view_animation *
Louis-Francis Ratté-Boulianneb482dbd2013-11-19 11:37:11 +01001645weston_stable_fade_run(struct weston_view *front_view, float start,
1646 struct weston_view *back_view, float end,
1647 weston_view_animation_done_func_t done, void *data);
1648
1649struct weston_view_animation *
Jason Ekstranda7af7042013-10-12 22:38:11 -05001650weston_slide_run(struct weston_view *view, float start, float stop,
1651 weston_view_animation_done_func_t done, void *data);
Juan Zhaoe10d2792012-04-25 19:09:52 +08001652
Alex Wu8811bf92012-02-28 18:07:54 +08001653void
1654weston_surface_set_color(struct weston_surface *surface,
John Kåre Alsaker490d02a2012-09-30 02:57:21 +02001655 float red, float green, float blue, float alpha);
Alex Wu8811bf92012-02-28 18:07:54 +08001656
1657void
1658weston_surface_destroy(struct weston_surface *surface);
1659
Alex Wu2dda6042012-04-17 17:20:47 +08001660int
Derek Foreman6ae7bc92014-11-04 10:47:33 -06001661weston_output_mode_set_native(struct weston_output *output,
1662 struct weston_mode *mode,
1663 int32_t scale);
1664int
1665weston_output_mode_switch_to_temporary(struct weston_output *output,
1666 struct weston_mode *mode,
1667 int32_t scale);
1668int
1669weston_output_mode_switch_to_native(struct weston_output *output);
Alex Wu2dda6042012-04-17 17:20:47 +08001670
Ander Conselvan de Oliveira11f8d402012-10-29 18:19:24 +02001671int
1672noop_renderer_init(struct weston_compositor *ec);
Ander Conselvan de Oliveira11f8d402012-10-29 18:19:24 +02001673
Giulio Camuffo954f1832014-10-11 18:27:30 +03001674int
1675backend_init(struct weston_compositor *c,
Giulio Camuffo93daabb2015-10-17 19:24:14 +03001676 struct weston_backend_config *config_base);
Kristian Høgsbergb00a9d32012-09-11 14:06:27 -04001677int
Kristian Høgsbergcb4685b2013-02-20 15:37:49 -05001678module_init(struct weston_compositor *compositor,
Ossama Othmana50e6e42013-05-14 09:48:26 -07001679 int *argc, char *argv[]);
Kristian Høgsbergb00a9d32012-09-11 14:06:27 -04001680
Ander Conselvan de Oliveira409eebf2012-12-05 15:14:04 +02001681void
1682weston_transformed_coord(int width, int height,
1683 enum wl_output_transform transform,
Alexander Larssonedddbd12013-05-24 13:09:43 +02001684 int32_t scale,
Ander Conselvan de Oliveira409eebf2012-12-05 15:14:04 +02001685 float sx, float sy, float *bx, float *by);
1686pixman_box32_t
1687weston_transformed_rect(int width, int height,
1688 enum wl_output_transform transform,
Alexander Larssonedddbd12013-05-24 13:09:43 +02001689 int32_t scale,
Ander Conselvan de Oliveira409eebf2012-12-05 15:14:04 +02001690 pixman_box32_t rect);
Jason Ekstrand33ff6362013-10-27 22:25:01 -05001691void
Derek Foremanbc9a61c2015-11-18 16:32:30 -06001692weston_matrix_transform_region(pixman_region32_t *dest,
1693 struct weston_matrix *matrix,
1694 pixman_region32_t *src);
1695void
Jason Ekstrand33ff6362013-10-27 22:25:01 -05001696weston_transformed_region(int width, int height,
1697 enum wl_output_transform transform,
1698 int32_t scale,
1699 pixman_region32_t *src, pixman_region32_t *dest);
Ander Conselvan de Oliveira409eebf2012-12-05 15:14:04 +02001700
Ander Conselvan de Oliveira97f29522013-10-14 15:57:11 +03001701void *
1702weston_load_module(const char *name, const char *entrypoint);
1703
Derek Foreman64a3df02014-10-23 12:24:18 -05001704int
1705weston_parse_transform(const char *transform, uint32_t *out);
1706
1707const char *
1708weston_transform_to_string(uint32_t output_transform);
1709
Derek Foreman1281a362015-07-31 16:55:32 -05001710struct weston_keyboard *
1711weston_seat_get_keyboard(struct weston_seat *seat);
1712
1713struct weston_pointer *
1714weston_seat_get_pointer(struct weston_seat *seat);
1715
1716struct weston_touch *
1717weston_seat_get_touch(struct weston_seat *seat);
1718
Giulio Camuffo7fe01b12013-03-28 18:02:42 +01001719#ifdef __cplusplus
1720}
1721#endif
1722
Kristian Høgsberg8334bc12012-01-03 10:29:47 -05001723#endif