libweston/compositor.h

   1 /*
   2  * Copyright © 2008-2011 Kristian Høgsberg
   3  * Copyright © 2012 Collabora, Ltd.
   4  *
   5  * 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:
  12  *
  13  * 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.
  25  */
  26
  27 #ifndef _WAYLAND_SYSTEM_COMPOSITOR_H_
  28 #define _WAYLAND_SYSTEM_COMPOSITOR_H_
  29
  30 #ifdef  __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 #include <stdbool.h>
  35 #include <stdint.h>
  36 #include <time.h>
  37 #include <pixman.h>
  38 #include <xkbcommon/xkbcommon.h>
  39
  40 #define WL_HIDE_DEPRECATED
  41 #include <wayland-server.h>
  42
  43 #include "matrix.h"
  44 #include "config-parser.h"
  45 #include "zalloc.h"
  46 #include "timeline-object.h"
  47
  48 struct weston_geometry {
  49         int32_t x, y;
  50         int32_t width, height;
  51 };
  52
  53 struct weston_position {
  54         int32_t x, y;
  55 };
  56
  57 struct weston_size {
  58         int32_t width, height;
  59 };
  60
  61 struct weston_transform {
  62         struct weston_matrix matrix;
  63         struct wl_list link;
  64 };
  65
  66 struct weston_surface;
  67 struct weston_buffer;
  68 struct shell_surface;
  69 struct weston_seat;
  70 struct weston_output;
  71 struct input_method;
  72 struct weston_pointer;
  73 struct linux_dmabuf_buffer;
  74 struct weston_recorder;
  75 struct weston_pointer_constraint;
  76
  77 enum weston_keyboard_modifier {
  78         MODIFIER_CTRL = (1 << 0),
  79         MODIFIER_ALT = (1 << 1),
  80         MODIFIER_SUPER = (1 << 2),
  81         MODIFIER_SHIFT = (1 << 3),
  82 };
  83
  84 enum weston_keyboard_locks {
  85         WESTON_NUM_LOCK = (1 << 0),
  86         WESTON_CAPS_LOCK = (1 << 1),
  87 };
  88
  89 enum weston_led {
  90         LED_NUM_LOCK = (1 << 0),
  91         LED_CAPS_LOCK = (1 << 1),
  92         LED_SCROLL_LOCK = (1 << 2),
  93 };
  94
  95 struct weston_mode {
  96         uint32_t flags;
  97         int32_t width, height;
  98         uint32_t refresh;
  99         struct wl_list link;
 100 };
 101
 102 struct weston_animation {
 103         void (*frame)(struct weston_animation *animation,
 104                       struct weston_output *output, uint32_t msecs);
 105         int frame_counter;
 106         struct wl_list link;
 107 };
 108
 109 enum {
 110         WESTON_SPRING_OVERSHOOT,
 111         WESTON_SPRING_CLAMP,
 112         WESTON_SPRING_BOUNCE
 113 };
 114
 115 struct weston_spring {
 116         double k;
 117         double friction;
 118         double current;
 119         double target;
 120         double previous;
 121         double min, max;
 122         uint32_t timestamp;
 123         uint32_t clip;
 124 };
 125
 126 struct weston_output_zoom {
 127         bool active;
 128         float increment;
 129         float level;
 130         float max_level;
 131         float trans_x, trans_y;
 132         struct {
 133                 double x, y;
 134         } current;
 135         struct weston_seat *seat;
 136         struct weston_animation animation_z;
 137         struct weston_spring spring_z;
 138         struct wl_listener motion_listener;
 139 };
 140
 141 /* bit compatible with drm definitions. */
 142 enum dpms_enum {
 143         WESTON_DPMS_ON,
 144         WESTON_DPMS_STANDBY,
 145         WESTON_DPMS_SUSPEND,
 146         WESTON_DPMS_OFF
 147 };
 148
 149 struct weston_output {
 150         uint32_t id;
 151         char *name;
 152
 153         void *renderer_state;
 154
 155         struct wl_list link;
 156         struct wl_list resource_list;
 157         struct wl_global *global;
 158         struct weston_compositor *compositor;
 159
 160         /** From global to output buffer coordinates. */
 161         struct weston_matrix matrix;
 162         /** From output buffer to global coordinates. */
 163         struct weston_matrix inverse_matrix;
 164
 165         struct wl_list animation_list;
 166         int32_t x, y, width, height;
 167         int32_t mm_width, mm_height;
 168
 169         /** Output area in global coordinates, simple rect */
 170         pixman_region32_t region;
 171
 172         pixman_region32_t previous_damage;
 173
 174         /** True if damage has occurred since the last repaint for this output;
 175          *  if set, a repaint will eventually occur. */
 176         bool repaint_needed;
 177
 178         /** State of the repaint loop */
 179         enum {
 180                 REPAINT_NOT_SCHEDULED = 0, /**< idle; no repaint will occur */
 181                 REPAINT_BEGIN_FROM_IDLE, /**< start_repaint_loop scheduled */
 182                 REPAINT_SCHEDULED, /**< repaint is scheduled to occur */
 183                 REPAINT_AWAITING_COMPLETION, /**< last repaint not yet finished */
 184         } repaint_status;
 185
 186         struct wl_event_source *repaint_timer;
 187         struct weston_output_zoom zoom;
 188         int dirty;
 189         struct wl_signal frame_signal;
 190         struct wl_signal destroy_signal;
 191         int move_x, move_y;
 192         uint32_t frame_time; /* presentation timestamp in milliseconds */
 193         uint64_t msc;        /* media stream counter */
 194         int disable_planes;
 195         int destroying;
 196         struct wl_list feedback_list;
 197
 198         char *make, *model, *serial_number;
 199         uint32_t subpixel;
 200         uint32_t transform;
 201         int32_t native_scale;
 202         int32_t current_scale;
 203         int32_t original_scale;
 204
 205         struct weston_mode *native_mode;
 206         struct weston_mode *current_mode;
 207         struct weston_mode *original_mode;
 208         struct wl_list mode_list;
 209
 210         void (*start_repaint_loop)(struct weston_output *output);
 211         int (*repaint)(struct weston_output *output,
 212                         pixman_region32_t *damage);
 213         void (*destroy)(struct weston_output *output);
 214         void (*assign_planes)(struct weston_output *output);
 215         int (*switch_mode)(struct weston_output *output, struct weston_mode *mode);
 216
 217         /* backlight values are on 0-255 range, where higher is brighter */
 218         int32_t backlight_current;
 219         void (*set_backlight)(struct weston_output *output, uint32_t value);
 220         void (*set_dpms)(struct weston_output *output, enum dpms_enum level);
 221
 222         int connection_internal;
 223         uint16_t gamma_size;
 224         void (*set_gamma)(struct weston_output *output,
 225                           uint16_t size,
 226                           uint16_t *r,
 227                           uint16_t *g,
 228                           uint16_t *b);
 229
 230         struct weston_timeline_object timeline;
 231
 232         bool enabled;
 233         int scale;
 234
 235         int (*enable)(struct weston_output *output);
 236         int (*disable)(struct weston_output *output);
 237 };
 238
 239 enum weston_pointer_motion_mask {
 240         WESTON_POINTER_MOTION_ABS = 1 << 0,
 241         WESTON_POINTER_MOTION_REL = 1 << 1,
 242         WESTON_POINTER_MOTION_REL_UNACCEL = 1 << 2,
 243 };
 244
 245 struct weston_pointer_motion_event {
 246         uint32_t mask;
 247         uint64_t time_usec;
 248         double x;
 249         double y;
 250         double dx;
 251         double dy;
 252         double dx_unaccel;
 253         double dy_unaccel;
 254 };
 255
 256 struct weston_pointer_axis_event {
 257         uint32_t axis;
 258         double value;
 259         bool has_discrete;
 260         int32_t discrete;
 261 };
 262
 263 struct weston_pointer_grab;
 264 struct weston_pointer_grab_interface {
 265         void (*focus)(struct weston_pointer_grab *grab);
 266         void (*motion)(struct weston_pointer_grab *grab, uint32_t time,
 267                        struct weston_pointer_motion_event *event);
 268         void (*button)(struct weston_pointer_grab *grab,
 269                        uint32_t time, uint32_t button, uint32_t state);
 270         void (*axis)(struct weston_pointer_grab *grab,
 271                      uint32_t time,
 272                      struct weston_pointer_axis_event *event);
 273         void (*axis_source)(struct weston_pointer_grab *grab, uint32_t source);
 274         void (*frame)(struct weston_pointer_grab *grab);
 275         void (*cancel)(struct weston_pointer_grab *grab);
 276 };
 277
 278 struct weston_pointer_grab {
 279         const struct weston_pointer_grab_interface *interface;
 280         struct weston_pointer *pointer;
 281 };
 282
 283 struct weston_keyboard_grab;
 284 struct weston_keyboard_grab_interface {
 285         void (*key)(struct weston_keyboard_grab *grab, uint32_t time,
 286                     uint32_t key, uint32_t state);
 287         void (*modifiers)(struct weston_keyboard_grab *grab, uint32_t serial,
 288                           uint32_t mods_depressed, uint32_t mods_latched,
 289                           uint32_t mods_locked, uint32_t group);
 290         void (*cancel)(struct weston_keyboard_grab *grab);
 291 };
 292
 293 struct weston_keyboard_grab {
 294         const struct weston_keyboard_grab_interface *interface;
 295         struct weston_keyboard *keyboard;
 296 };
 297
 298 struct weston_touch_grab;
 299 struct weston_touch_grab_interface {
 300         void (*down)(struct weston_touch_grab *grab,
 301                         uint32_t time,
 302                         int touch_id,
 303                         wl_fixed_t sx,
 304                         wl_fixed_t sy);
 305         void (*up)(struct weston_touch_grab *grab,
 306                         uint32_t time,
 307                         int touch_id);
 308         void (*motion)(struct weston_touch_grab *grab,
 309                         uint32_t time,
 310                         int touch_id,
 311                         wl_fixed_t sx,
 312                         wl_fixed_t sy);
 313         void (*frame)(struct weston_touch_grab *grab);
 314         void (*cancel)(struct weston_touch_grab *grab);
 315 };
 316
 317 struct weston_touch_grab {
 318         const struct weston_touch_grab_interface *interface;
 319         struct weston_touch *touch;
 320 };
 321
 322 struct weston_data_offer {
 323         struct wl_resource *resource;
 324         struct weston_data_source *source;
 325         struct wl_listener source_destroy_listener;
 326         uint32_t dnd_actions;
 327         enum wl_data_device_manager_dnd_action preferred_dnd_action;
 328         bool in_ask;
 329 };
 330
 331 struct weston_data_source {
 332         struct wl_resource *resource;
 333         struct wl_signal destroy_signal;
 334         struct wl_array mime_types;
 335         struct weston_data_offer *offer;
 336         struct weston_seat *seat;
 337         bool accepted;
 338         bool actions_set;
 339         uint32_t dnd_actions;
 340         enum wl_data_device_manager_dnd_action current_dnd_action;
 341         enum wl_data_device_manager_dnd_action compositor_action;
 342
 343         void (*accept)(struct weston_data_source *source,
 344                        uint32_t serial, const char *mime_type);
 345         void (*send)(struct weston_data_source *source,
 346                      const char *mime_type, int32_t fd);
 347         void (*cancel)(struct weston_data_source *source);
 348 };
 349
 350 struct weston_pointer_client {
 351         struct wl_list link;
 352         struct wl_client *client;
 353         struct wl_list pointer_resources;
 354         struct wl_list relative_pointer_resources;
 355 };
 356
 357 struct weston_pointer {
 358         struct weston_seat *seat;
 359
 360         struct wl_list pointer_clients;
 361
 362         struct weston_view *focus;
 363         struct weston_pointer_client *focus_client;
 364         uint32_t focus_serial;
 365         struct wl_listener focus_view_listener;
 366         struct wl_listener focus_resource_listener;
 367         struct wl_signal focus_signal;
 368         struct wl_signal motion_signal;
 369         struct wl_signal destroy_signal;
 370
 371         struct weston_view *sprite;
 372         struct wl_listener sprite_destroy_listener;
 373         int32_t hotspot_x, hotspot_y;
 374
 375         struct weston_pointer_grab *grab;
 376         struct weston_pointer_grab default_grab;
 377         wl_fixed_t grab_x, grab_y;
 378         uint32_t grab_button;
 379         uint32_t grab_serial;
 380         uint32_t grab_time;
 381
 382         wl_fixed_t x, y;
 383         wl_fixed_t sx, sy;
 384         uint32_t button_count;
 385
 386         struct wl_listener output_destroy_listener;
 387 };
 388
 389
 390 struct weston_touch {
 391         struct weston_seat *seat;
 392
 393         struct wl_list resource_list;
 394         struct wl_list focus_resource_list;
 395         struct weston_view *focus;
 396         struct wl_listener focus_view_listener;
 397         struct wl_listener focus_resource_listener;
 398         uint32_t focus_serial;
 399         struct wl_signal focus_signal;
 400
 401         uint32_t num_tp;
 402
 403         struct weston_touch_grab *grab;
 404         struct weston_touch_grab default_grab;
 405         int grab_touch_id;
 406         wl_fixed_t grab_x, grab_y;
 407         uint32_t grab_serial;
 408         uint32_t grab_time;
 409 };
 410
 411 void
 412 weston_pointer_motion_to_abs(struct weston_pointer *pointer,
 413                              struct weston_pointer_motion_event *event,
 414                              wl_fixed_t *x, wl_fixed_t *y);
 415
 416 struct weston_pointer *
 417 weston_pointer_create(struct weston_seat *seat);
 418 void
 419 weston_pointer_destroy(struct weston_pointer *pointer);
 420 void
 421 weston_pointer_send_motion(struct weston_pointer *pointer, uint32_t time,
 422                            struct weston_pointer_motion_event *event);
 423 bool
 424 weston_pointer_has_focus_resource(struct weston_pointer *pointer);
 425 void
 426 weston_pointer_send_button(struct weston_pointer *pointer,
 427                            uint32_t time, uint32_t button, uint32_t state_w);
 428 void
 429 weston_pointer_send_axis(struct weston_pointer *pointer,
 430                          uint32_t time,
 431                          struct weston_pointer_axis_event *event);
 432 void
 433 weston_pointer_send_axis_source(struct weston_pointer *pointer,
 434                                 uint32_t source);
 435 void
 436 weston_pointer_send_frame(struct weston_pointer *pointer);
 437
 438 void
 439 weston_pointer_set_focus(struct weston_pointer *pointer,
 440                          struct weston_view *view,
 441                          wl_fixed_t sx, wl_fixed_t sy);
 442 void
 443 weston_pointer_clear_focus(struct weston_pointer *pointer);
 444 void
 445 weston_pointer_start_grab(struct weston_pointer *pointer,
 446                           struct weston_pointer_grab *grab);
 447 void
 448 weston_pointer_end_grab(struct weston_pointer *pointer);
 449 void
 450 weston_pointer_clamp(struct weston_pointer *pointer,
 451                             wl_fixed_t *fx, wl_fixed_t *fy);
 452 void
 453 weston_pointer_move(struct weston_pointer *pointer,
 454                     struct weston_pointer_motion_event *event);
 455 void
 456 weston_pointer_set_default_grab(struct weston_pointer *pointer,
 457                 const struct weston_pointer_grab_interface *interface);
 458
 459 void
 460 weston_pointer_constraint_destroy(struct weston_pointer_constraint *constraint);
 461
 462 struct weston_keyboard *
 463 weston_keyboard_create(void);
 464 void
 465 weston_keyboard_destroy(struct weston_keyboard *keyboard);
 466 void
 467 weston_keyboard_set_focus(struct weston_keyboard *keyboard,
 468                           struct weston_surface *surface);
 469 void
 470 weston_keyboard_start_grab(struct weston_keyboard *device,
 471                            struct weston_keyboard_grab *grab);
 472 void
 473 weston_keyboard_end_grab(struct weston_keyboard *keyboard);
 474 int
 475 /*
 476  * 'mask' and 'value' should be a bitwise mask of one or more
 477  * valued of the weston_keyboard_locks enum.
 478  */
 479 weston_keyboard_set_locks(struct weston_keyboard *keyboard,
 480                           uint32_t mask, uint32_t value);
 481
 482 bool
 483 weston_keyboard_has_focus_resource(struct weston_keyboard *keyboard);
 484 void
 485 weston_keyboard_send_key(struct weston_keyboard *keyboard,
 486                          uint32_t time, uint32_t key,
 487                          enum wl_keyboard_key_state state);
 488 void
 489 weston_keyboard_send_modifiers(struct weston_keyboard *keyboard,
 490                                uint32_t serial, uint32_t mods_depressed,
 491                                uint32_t mods_latched,
 492                                uint32_t mods_locked, uint32_t group);
 493
 494 struct weston_touch *
 495 weston_touch_create(void);
 496 void
 497 weston_touch_destroy(struct weston_touch *touch);
 498 void
 499 weston_touch_set_focus(struct weston_touch *touch,
 500                        struct weston_view *view);
 501 void
 502 weston_touch_start_grab(struct weston_touch *device,
 503                         struct weston_touch_grab *grab);
 504 void
 505 weston_touch_end_grab(struct weston_touch *touch);
 506
 507 bool
 508 weston_touch_has_focus_resource(struct weston_touch *touch);
 509 void
 510 weston_touch_send_down(struct weston_touch *touch, uint32_t time,
 511                        int touch_id, wl_fixed_t x, wl_fixed_t y);
 512 void
 513 weston_touch_send_up(struct weston_touch *touch, uint32_t time, int touch_id);
 514 void
 515 weston_touch_send_motion(struct weston_touch *touch, uint32_t time,
 516                          int touch_id, wl_fixed_t x, wl_fixed_t y);
 517 void
 518 weston_touch_send_frame(struct weston_touch *touch);
 519
 520 void
 521 wl_data_device_set_keyboard_focus(struct weston_seat *seat);
 522
 523 int
 524 wl_data_device_manager_init(struct wl_display *display);
 525
 526
 527 void
 528 weston_seat_set_selection(struct weston_seat *seat,
 529                           struct weston_data_source *source, uint32_t serial);
 530 void
 531 weston_seat_send_selection(struct weston_seat *seat, struct wl_client *client);
 532
 533 int
 534 weston_pointer_start_drag(struct weston_pointer *pointer,
 535                        struct weston_data_source *source,
 536                        struct weston_surface *icon,
 537                        struct wl_client *client);
 538 int
 539 weston_touch_start_drag(struct weston_touch *touch,
 540                         struct weston_data_source *source,
 541                         struct weston_surface *icon,
 542                         struct wl_client *client);
 543
 544 struct weston_xkb_info {
 545         struct xkb_keymap *keymap;
 546         int keymap_fd;
 547         size_t keymap_size;
 548         char *keymap_area;
 549         int32_t ref_count;
 550         xkb_mod_index_t shift_mod;
 551         xkb_mod_index_t caps_mod;
 552         xkb_mod_index_t ctrl_mod;
 553         xkb_mod_index_t alt_mod;
 554         xkb_mod_index_t mod2_mod;
 555         xkb_mod_index_t mod3_mod;
 556         xkb_mod_index_t super_mod;
 557         xkb_mod_index_t mod5_mod;
 558         xkb_led_index_t num_led;
 559         xkb_led_index_t caps_led;
 560         xkb_led_index_t scroll_led;
 561 };
 562
 563 struct weston_keyboard {
 564         struct weston_seat *seat;
 565
 566         struct wl_list resource_list;
 567         struct wl_list focus_resource_list;
 568         struct weston_surface *focus;
 569         struct wl_listener focus_resource_listener;
 570         uint32_t focus_serial;
 571         struct wl_signal focus_signal;
 572
 573         struct weston_keyboard_grab *grab;
 574         struct weston_keyboard_grab default_grab;
 575         uint32_t grab_key;
 576         uint32_t grab_serial;
 577         uint32_t grab_time;
 578
 579         struct wl_array keys;
 580
 581         struct {
 582                 uint32_t mods_depressed;
 583                 uint32_t mods_latched;
 584                 uint32_t mods_locked;
 585                 uint32_t group;
 586         } modifiers;
 587
 588         struct weston_keyboard_grab input_method_grab;
 589         struct wl_resource *input_method_resource;
 590
 591         struct weston_xkb_info *xkb_info;
 592         struct {
 593                 struct xkb_state *state;
 594                 enum weston_led leds;
 595         } xkb_state;
 596         struct xkb_keymap *pending_keymap;
 597 };
 598
 599 struct weston_seat {
 600         struct wl_list base_resource_list;
 601
 602         struct wl_global *global;
 603         struct weston_pointer *pointer_state;
 604         struct weston_keyboard *keyboard_state;
 605         struct weston_touch *touch_state;
 606         int pointer_device_count;
 607         int keyboard_device_count;
 608         int touch_device_count;
 609
 610         struct weston_output *output; /* constraint */
 611
 612         struct wl_signal destroy_signal;
 613         struct wl_signal updated_caps_signal;
 614
 615         struct weston_compositor *compositor;
 616         struct wl_list link;
 617         enum weston_keyboard_modifier modifier_state;
 618         struct weston_surface *saved_kbd_focus;
 619         struct wl_listener saved_kbd_focus_listener;
 620         struct wl_list drag_resource_list;
 621
 622         uint32_t selection_serial;
 623         struct weston_data_source *selection_data_source;
 624         struct wl_listener selection_data_source_listener;
 625         struct wl_signal selection_signal;
 626
 627         void (*led_update)(struct weston_seat *ws, enum weston_led leds);
 628
 629         struct input_method *input_method;
 630         char *seat_name;
 631 };
 632
 633 enum {
 634         WESTON_COMPOSITOR_ACTIVE,       /* normal rendering and events */
 635         WESTON_COMPOSITOR_IDLE,         /* shell->unlock called on activity */
 636         WESTON_COMPOSITOR_OFFSCREEN,    /* no rendering, no frame events */
 637         WESTON_COMPOSITOR_SLEEPING      /* same as offscreen, but also set dpms
 638                                          * to off */
 639 };
 640
 641 struct weston_layer_entry {
 642         struct wl_list link;
 643         struct weston_layer *layer;
 644 };
 645
 646 /**
 647  * Higher value means higher in the stack.
 648  *
 649  * These values are based on well-known concepts in a classic desktop
 650  * environment. Third-party modules based on libweston are encouraged to use
 651  * them to integrate better with other projects.
 652  *
 653  * A fully integrated environment can use any value, based on these or not,
 654  * at their discretion.
 655  */
 656 enum weston_layer_position {
 657         /*
 658          * Special value to make the layer invisible and still rendered.
 659          * This is used by compositors wanting e.g. minimized surfaces to still
 660          * receive frame callbacks.
 661          */
 662         WESTON_LAYER_POSITION_HIDDEN     = 0x00000000,
 663
 664         /*
 665          * There should always be a background layer with a surface covering
 666          * the visible area.
 667          *
 668          * If the compositor handles the background itself, it should use
 669          * BACKGROUND.
 670          *
 671          * If the compositor supports runtime-loadable modules to set the
 672          * background, it should put a solid color surface at (BACKGROUND - 1)
 673          * and modules must use BACKGROUND.
 674          */
 675         WESTON_LAYER_POSITION_BACKGROUND = 0x00000002,
 676
 677         /* For "desktop widgets" and applications like conky. */
 678         WESTON_LAYER_POSITION_BOTTOM_UI  = 0x30000000,
 679
 680         /* For regular applications, only one layer should have this value
 681          * to ensure proper stacking control. */
 682         WESTON_LAYER_POSITION_NORMAL     = 0x50000000,
 683
 684         /* For desktop UI, like panels. */
 685         WESTON_LAYER_POSITION_UI         = 0x80000000,
 686
 687         /* For fullscreen applications that should cover UI. */
 688         WESTON_LAYER_POSITION_FULLSCREEN = 0xb0000000,
 689
 690         /* For special UI like on-screen keyboard that fullscreen applications
 691          * will need. */
 692         WESTON_LAYER_POSITION_TOP_UI     = 0xe0000000,
 693
 694         /* For the lock surface. */
 695         WESTON_LAYER_POSITION_LOCK       = 0xffff0000,
 696
 697         /* Values reserved for libweston internal usage */
 698         WESTON_LAYER_POSITION_CURSOR     = 0xfffffffe,
 699         WESTON_LAYER_POSITION_FADE       = 0xffffffff,
 700 };
 701
 702 struct weston_layer {
 703         struct weston_compositor *compositor;
 704         struct wl_list link; /* weston_compositor::layer_list */
 705         enum weston_layer_position position;
 706         pixman_box32_t mask;
 707         struct weston_layer_entry view_list;
 708 };
 709
 710 struct weston_plane {
 711         struct weston_compositor *compositor;
 712         pixman_region32_t damage; /**< in global coords */
 713         pixman_region32_t clip;
 714         int32_t x, y;
 715         struct wl_list link;
 716 };
 717
 718 struct weston_renderer {
 719         int (*read_pixels)(struct weston_output *output,
 720                                pixman_format_code_t format, void *pixels,
 721                                uint32_t x, uint32_t y,
 722                                uint32_t width, uint32_t height);
 723         void (*repaint_output)(struct weston_output *output,
 724                                pixman_region32_t *output_damage);
 725         void (*flush_damage)(struct weston_surface *surface);
 726         void (*attach)(struct weston_surface *es, struct weston_buffer *buffer);
 727         void (*surface_set_color)(struct weston_surface *surface,
 728                                float red, float green,
 729                                float blue, float alpha);
 730         void (*destroy)(struct weston_compositor *ec);
 731
 732
 733         /** See weston_surface_get_content_size() */
 734         void (*surface_get_content_size)(struct weston_surface *surface,
 735                                          int *width, int *height);
 736
 737         /** See weston_surface_copy_content() */
 738         int (*surface_copy_content)(struct weston_surface *surface,
 739                                     void *target, size_t size,
 740                                     int src_x, int src_y,
 741                                     int width, int height);
 742
 743         /** See weston_compositor_import_dmabuf() */
 744         bool (*import_dmabuf)(struct weston_compositor *ec,
 745                               struct linux_dmabuf_buffer *buffer);
 746 };
 747
 748 enum weston_capability {
 749         /* backend/renderer supports arbitrary rotation */
 750         WESTON_CAP_ROTATION_ANY                 = 0x0001,
 751
 752         /* screencaptures need to be y-flipped */
 753         WESTON_CAP_CAPTURE_YFLIP                = 0x0002,
 754
 755         /* backend/renderer has a separate cursor plane */
 756         WESTON_CAP_CURSOR_PLANE                 = 0x0004,
 757
 758         /* backend supports setting arbitrary resolutions */
 759         WESTON_CAP_ARBITRARY_MODES              = 0x0008,
 760
 761         /* renderer supports weston_view_set_mask() clipping */
 762         WESTON_CAP_VIEW_CLIP_MASK               = 0x0010,
 763 };
 764
 765 /* Configuration struct for a backend.
 766  *
 767  * This struct carries the configuration for a backend, and it's
 768  * passed to the backend's init entry point. The backend will
 769  * likely want to subclass this in order to handle backend specific
 770  * data.
 771  *
 772  * NOTE: Alternate designs were proposed (Feb 2016) for using opaque
 773  * structures[1] and for section+key/value getter/setters[2].  The rationale
 774  * for selecting the transparent structure design is based on several
 775  * assumptions[3] which may require re-evaluating the design choice if they
 776  * fail to hold.
 777  *
 778  * 1: https://lists.freedesktop.org/archives/wayland-devel/2016-February/026989.html
 779  * 2: https://lists.freedesktop.org/archives/wayland-devel/2016-February/026929.html
 780  * 3: https://lists.freedesktop.org/archives/wayland-devel/2016-February/027228.html
 781  */
 782 struct weston_backend_config {
 783    /** Major version for the backend-specific config struct
 784     *
 785     * This version must match exactly what the backend expects, otherwise
 786     * the struct is incompatible.
 787     */
 788    uint32_t struct_version;
 789
 790    /** Minor version of the backend-specific config struct
 791     *
 792     * This must be set to sizeof(struct backend-specific config).
 793     * If the value here is smaller than what the backend expects, the
 794     * extra config members will assume their default values.
 795     *
 796     * A value greater than what the backend expects is incompatible.
 797     */
 798    size_t struct_size;
 799 };
 800
 801 struct weston_backend {
 802         void (*destroy)(struct weston_compositor *compositor);
 803         void (*restore)(struct weston_compositor *compositor);
 804 };
 805
 806 struct weston_desktop_xwayland;
 807 struct weston_desktop_xwayland_interface;
 808
 809 struct weston_compositor {
 810         struct wl_signal destroy_signal;
 811
 812         struct wl_display *wl_display;
 813         struct weston_desktop_xwayland *xwayland;
 814         const struct weston_desktop_xwayland_interface *xwayland_interface;
 815
 816         /* surface signals */
 817         struct wl_signal create_surface_signal;
 818         struct wl_signal activate_signal;
 819         struct wl_signal transform_signal;
 820
 821         struct wl_signal kill_signal;
 822         struct wl_signal idle_signal;
 823         struct wl_signal wake_signal;
 824
 825         struct wl_signal show_input_panel_signal;
 826         struct wl_signal hide_input_panel_signal;
 827         struct wl_signal update_input_panel_signal;
 828
 829         struct wl_signal seat_created_signal;
 830         struct wl_signal output_pending_signal;
 831         struct wl_signal output_created_signal;
 832         struct wl_signal output_destroyed_signal;
 833         struct wl_signal output_moved_signal;
 834         struct wl_signal output_resized_signal; /* callback argument: resized output */
 835
 836         struct wl_signal session_signal;
 837         int session_active;
 838
 839         struct weston_layer fade_layer;
 840         struct weston_layer cursor_layer;
 841
 842         struct wl_list pending_output_list;
 843         struct wl_list output_list;
 844         struct wl_list seat_list;
 845         struct wl_list layer_list;      /* struct weston_layer::link */
 846         struct wl_list view_list;       /* struct weston_view::link */
 847         struct wl_list plane_list;
 848         struct wl_list key_binding_list;
 849         struct wl_list modifier_binding_list;
 850         struct wl_list button_binding_list;
 851         struct wl_list touch_binding_list;
 852         struct wl_list axis_binding_list;
 853         struct wl_list debug_binding_list;
 854
 855         uint32_t state;
 856         struct wl_event_source *idle_source;
 857         uint32_t idle_inhibit;
 858         int idle_time;                  /* timeout, s */
 859
 860         const struct weston_pointer_grab_interface *default_pointer_grab;
 861
 862         /* Repaint state. */
 863         struct weston_plane primary_plane;
 864         uint32_t capabilities; /* combination of enum weston_capability */
 865
 866         struct weston_renderer *renderer;
 867
 868         pixman_format_code_t read_format;
 869
 870         struct weston_backend *backend;
 871
 872         struct weston_launcher *launcher;
 873
 874         struct wl_list plugin_api_list; /* struct weston_plugin_api::link */
 875
 876         uint32_t output_id_pool;
 877
 878         struct xkb_rule_names xkb_names;
 879         struct xkb_context *xkb_context;
 880         struct weston_xkb_info *xkb_info;
 881
 882         /* Raw keyboard processing (no libxkbcommon initialization or handling) */
 883         int use_xkbcommon;
 884
 885         int32_t kb_repeat_rate;
 886         int32_t kb_repeat_delay;
 887
 888         bool vt_switching;
 889
 890         clockid_t presentation_clock;
 891         int32_t repaint_msec;
 892
 893         unsigned int activate_serial;
 894
 895         struct wl_global *pointer_constraints;
 896
 897         int exit_code;
 898
 899         void *user_data;
 900         void (*exit)(struct weston_compositor *c);
 901
 902         /* Whether to let the compositor run without any input device. */
 903         bool require_input;
 904
 905 };
 906
 907 struct weston_buffer {
 908         struct wl_resource *resource;
 909         struct wl_signal destroy_signal;
 910         struct wl_listener destroy_listener;
 911
 912         union {
 913                 struct wl_shm_buffer *shm_buffer;
 914                 void *legacy_buffer;
 915         };
 916         int32_t width, height;
 917         uint32_t busy_count;
 918         int y_inverted;
 919 };
 920
 921 struct weston_buffer_reference {
 922         struct weston_buffer *buffer;
 923         struct wl_listener destroy_listener;
 924 };
 925
 926 struct weston_buffer_viewport {
 927         struct {
 928                 /* wl_surface.set_buffer_transform */
 929                 uint32_t transform;
 930
 931                 /* wl_surface.set_scaling_factor */
 932                 int32_t scale;
 933
 934                 /*
 935                  * If src_width != wl_fixed_from_int(-1),
 936                  * then and only then src_* are used.
 937                  */
 938                 wl_fixed_t src_x, src_y;
 939                 wl_fixed_t src_width, src_height;
 940         } buffer;
 941
 942         struct {
 943                 /*
 944                  * If width == -1, the size is inferred from the buffer.
 945                  */
 946                 int32_t width, height;
 947         } surface;
 948
 949         int changed;
 950 };
 951
 952 struct weston_region {
 953         struct wl_resource *resource;
 954         pixman_region32_t region;
 955 };
 956
 957 /* Using weston_view transformations
 958  *
 959  * To add a transformation to a view, create a struct weston_transform, and
 960  * add it to the list view->geometry.transformation_list. Whenever you
 961  * change the list, anything under view->geometry, or anything in the
 962  * weston_transforms linked into the list, you must call
 963  * weston_view_geometry_dirty().
 964  *
 965  * The order in the list defines the order of transformations. Let the list
 966  * contain the transformation matrices M1, ..., Mn as head to tail. The
 967  * transformation is applied to view-local coordinate vector p as
 968  *    P = Mn * ... * M2 * M1 * p
 969  * to produce the global coordinate vector P. The total transform
 970  *    Mn * ... * M2 * M1
 971  * is cached in view->transform.matrix, and the inverse of it in
 972  * view->transform.inverse.
 973  *
 974  * The list always contains view->transform.position transformation, which
 975  * is the translation by view->geometry.x and y.
 976  *
 977  * If you want to apply a transformation in local coordinates, add your
 978  * weston_transform to the head of the list. If you want to apply a
 979  * transformation in global coordinates, add it to the tail of the list.
 980  *
 981  * If view->geometry.parent is set, the total transformation of this
 982  * view will be the parent's total transformation and this transformation
 983  * combined:
 984  *    Mparent * Mn * ... * M2 * M1
 985  */
 986
 987 struct weston_view {
 988         struct weston_surface *surface;
 989         struct wl_list surface_link;
 990         struct wl_signal destroy_signal;
 991
 992         struct wl_list link;             /* weston_compositor::view_list */
 993         struct weston_layer_entry layer_link; /* part of geometry */
 994         struct weston_plane *plane;
 995
 996         /* For weston_layer inheritance from another view */
 997         struct weston_view *parent_view;
 998
 999         unsigned int click_to_activate_serial;
1000
1001         pixman_region32_t clip;          /* See weston_view_damage_below() */
1002         float alpha;                     /* part of geometry, see below */
1003
1004         void *renderer_state;
1005
1006         /* Surface geometry state, mutable.
1007          * If you change anything, call weston_surface_geometry_dirty().
1008          * That includes the transformations referenced from the list.
1009          */
1010         struct {
1011                 float x, y; /* surface translation on display */
1012
1013                 /* struct weston_transform */
1014                 struct wl_list transformation_list;
1015
1016                 /* managed by weston_surface_set_transform_parent() */
1017                 struct weston_view *parent;
1018                 struct wl_listener parent_destroy_listener;
1019                 struct wl_list child_list; /* geometry.parent_link */
1020                 struct wl_list parent_link;
1021
1022                 /* managed by weston_view_set_mask() */
1023                 bool scissor_enabled;
1024                 pixman_region32_t scissor; /* always a simple rect */
1025         } geometry;
1026
1027         /* State derived from geometry state, read-only.
1028          * This is updated by weston_view_update_transform().
1029          */
1030         struct {
1031                 int dirty;
1032
1033                 /* Approximations in global coordinates:
1034                  * - boundingbox is guaranteed to include the whole view in
1035                  *   the smallest possible single rectangle.
1036                  * - opaque is guaranteed to be fully opaque, though not
1037                  *   necessarily include all opaque areas.
1038                  */
1039                 pixman_region32_t boundingbox;
1040                 pixman_region32_t opaque;
1041
1042                 /* matrix and inverse are used only if enabled = 1.
1043                  * If enabled = 0, use x, y, width, height directly.
1044                  */
1045                 int enabled;
1046                 struct weston_matrix matrix;
1047                 struct weston_matrix inverse;
1048
1049                 struct weston_transform position; /* matrix from x, y */
1050         } transform;
1051
1052         /*
1053          * The primary output for this view.
1054          * Used for picking the output for driving internal animations on the
1055          * view, inheriting the primary output for related views in shells, etc.
1056          */
1057         struct weston_output *output;
1058
1059         /*
1060          * A more complete representation of all outputs this surface is
1061          * displayed on.
1062          */
1063         uint32_t output_mask;
1064
1065         /* Per-surface Presentation feedback flags, controlled by backend. */
1066         uint32_t psf_flags;
1067
1068         bool is_mapped;
1069 };
1070
1071 struct weston_surface_state {
1072         /* wl_surface.attach */
1073         int newly_attached;
1074         struct weston_buffer *buffer;
1075         struct wl_listener buffer_destroy_listener;
1076         int32_t sx;
1077         int32_t sy;
1078
1079         /* wl_surface.damage */
1080         pixman_region32_t damage_surface;
1081         /* wl_surface.damage_buffer */
1082         pixman_region32_t damage_buffer;
1083
1084         /* wl_surface.set_opaque_region */
1085         pixman_region32_t opaque;
1086
1087         /* wl_surface.set_input_region */
1088         pixman_region32_t input;
1089
1090         /* wl_surface.frame */
1091         struct wl_list frame_callback_list;
1092
1093         /* presentation.feedback */
1094         struct wl_list feedback_list;
1095
1096         /* wl_surface.set_buffer_transform */
1097         /* wl_surface.set_scaling_factor */
1098         /* wp_viewport.set_source */
1099         /* wp_viewport.set_destination */
1100         struct weston_buffer_viewport buffer_viewport;
1101 };
1102
1103 struct weston_surface_activation_data {
1104         struct weston_surface *surface;
1105         struct weston_seat *seat;
1106 };
1107
1108 struct weston_pointer_constraint {
1109         struct wl_list link;
1110
1111         struct weston_surface *surface;
1112         struct weston_view *view;
1113         struct wl_resource *resource;
1114         struct weston_pointer_grab grab;
1115         struct weston_pointer *pointer;
1116         uint32_t lifetime;
1117
1118         pixman_region32_t region;
1119         pixman_region32_t region_pending;
1120         bool region_is_pending;
1121
1122         wl_fixed_t hint_x;
1123         wl_fixed_t hint_y;
1124         wl_fixed_t hint_x_pending;
1125         wl_fixed_t hint_y_pending;
1126         bool hint_is_pending;
1127
1128         struct wl_listener pointer_destroy_listener;
1129         struct wl_listener surface_destroy_listener;
1130         struct wl_listener surface_commit_listener;
1131         struct wl_listener surface_activate_listener;
1132 };
1133
1134 struct weston_surface {
1135         struct wl_resource *resource;
1136         struct wl_signal destroy_signal; /* callback argument: this surface */
1137         struct weston_compositor *compositor;
1138         struct wl_signal commit_signal;
1139
1140         /** Damage in local coordinates from the client, for tex upload. */
1141         pixman_region32_t damage;
1142
1143         pixman_region32_t opaque;        /* part of geometry, see below */
1144         pixman_region32_t input;
1145         int32_t width, height;
1146         int32_t ref_count;
1147
1148         /* Not for long-term storage.  This exists for book-keeping while
1149          * iterating over surfaces and views
1150          */
1151         bool touched;
1152
1153         void *renderer_state;
1154
1155         struct wl_list views;
1156
1157         /*
1158          * Which output to vsync this surface to.
1159          * Used to determine whether to send or queue frame events, and for
1160          * other client-visible syncing/throttling tied to the output
1161          * repaint cycle.
1162          */
1163         struct weston_output *output;
1164
1165         /*
1166          * A more complete representation of all outputs this surface is
1167          * displayed on.
1168          */
1169         uint32_t output_mask;
1170
1171         struct wl_list frame_callback_list;
1172         struct wl_list feedback_list;
1173
1174         struct weston_buffer_reference buffer_ref;
1175         struct weston_buffer_viewport buffer_viewport;
1176         int32_t width_from_buffer; /* before applying viewport */
1177         int32_t height_from_buffer;
1178         bool keep_buffer; /* for backends to prevent early release */
1179
1180         /* wp_viewport resource for this surface */
1181         struct wl_resource *viewport_resource;
1182
1183         /* All the pending state, that wl_surface.commit will apply. */
1184         struct weston_surface_state pending;
1185
1186         /* Matrices representating of the full transformation between
1187          * buffer and surface coordinates.  These matrices are updated
1188          * using the weston_surface_build_buffer_matrix function. */
1189         struct weston_matrix buffer_to_surface_matrix;
1190         struct weston_matrix surface_to_buffer_matrix;
1191
1192         /*
1193          * If non-NULL, this function will be called on
1194          * wl_surface::commit after a new buffer has been set up for
1195          * this surface. The integer params are the sx and sy
1196          * parameters supplied to wl_surface::attach.
1197          */
1198         void (*committed)(struct weston_surface *es, int32_t sx, int32_t sy);
1199         void *committed_private;
1200         int (*get_label)(struct weston_surface *surface, char *buf, size_t len);
1201
1202         /* Parent's list of its sub-surfaces, weston_subsurface:parent_link.
1203          * Contains also the parent itself as a dummy weston_subsurface,
1204          * if the list is not empty.
1205          */
1206         struct wl_list subsurface_list; /* weston_subsurface::parent_link */
1207         struct wl_list subsurface_list_pending; /* ...::parent_link_pending */
1208
1209         /*
1210          * For tracking protocol role assignments. Different roles may
1211          * have the same configure hook, e.g. in shell.c. Configure hook
1212          * may get reset, this will not.
1213          * XXX: map configure functions 1:1 to roles, and never reset it,
1214          * and replace role_name with configure.
1215          */
1216         const char *role_name;
1217
1218         struct weston_timeline_object timeline;
1219
1220         bool is_mapped;
1221
1222         /* An list of per seat pointer constraints. */
1223         struct wl_list pointer_constraints;
1224 };
1225
1226 struct weston_subsurface {
1227         struct wl_resource *resource;
1228
1229         /* guaranteed to be valid and non-NULL */
1230         struct weston_surface *surface;
1231         struct wl_listener surface_destroy_listener;
1232
1233         /* can be NULL */
1234         struct weston_surface *parent;
1235         struct wl_listener parent_destroy_listener;
1236         struct wl_list parent_link;
1237         struct wl_list parent_link_pending;
1238
1239         struct {
1240                 int32_t x;
1241                 int32_t y;
1242                 int set;
1243         } position;
1244
1245         int has_cached_data;
1246         struct weston_surface_state cached;
1247         struct weston_buffer_reference cached_buffer_ref;
1248
1249         /* Sub-surface has been reordered; need to apply damage. */
1250         bool reordered;
1251
1252         int synchronized;
1253
1254         /* Used for constructing the view tree */
1255         struct wl_list unused_views;
1256 };
1257
1258 enum weston_key_state_update {
1259         STATE_UPDATE_AUTOMATIC,
1260         STATE_UPDATE_NONE,
1261 };
1262
1263 enum weston_activate_flag {
1264         WESTON_ACTIVATE_FLAG_NONE = 0,
1265         WESTON_ACTIVATE_FLAG_CONFIGURE = 1 << 0,
1266         WESTON_ACTIVATE_FLAG_CLICKED = 1 << 1,
1267 };
1268
1269 void
1270 weston_version(int *major, int *minor, int *micro);
1271
1272 void
1273 weston_view_update_transform(struct weston_view *view);
1274
1275 void
1276 weston_view_geometry_dirty(struct weston_view *view);
1277
1278 void
1279 weston_view_to_global_fixed(struct weston_view *view,
1280                             wl_fixed_t sx, wl_fixed_t sy,
1281                             wl_fixed_t *x, wl_fixed_t *y);
1282 void
1283 weston_view_to_global_float(struct weston_view *view,
1284                             float sx, float sy, float *x, float *y);
1285
1286 void
1287 weston_view_from_global_float(struct weston_view *view,
1288                               float x, float y, float *vx, float *vy);
1289 void
1290 weston_view_from_global(struct weston_view *view,
1291                         int32_t x, int32_t y, int32_t *vx, int32_t *vy);
1292 void
1293 weston_view_from_global_fixed(struct weston_view *view,
1294                               wl_fixed_t x, wl_fixed_t y,
1295                               wl_fixed_t *vx, wl_fixed_t *vy);
1296
1297 void
1298 weston_surface_to_buffer_float(struct weston_surface *surface,
1299                                float x, float y, float *bx, float *by);
1300 pixman_box32_t
1301 weston_surface_to_buffer_rect(struct weston_surface *surface,
1302                               pixman_box32_t rect);
1303
1304 void
1305 weston_surface_to_buffer_region(struct weston_surface *surface,
1306                                 pixman_region32_t *surface_region,
1307                                 pixman_region32_t *buffer_region);
1308
1309 void
1310 weston_spring_init(struct weston_spring *spring,
1311                    double k, double current, double target);
1312 void
1313 weston_spring_update(struct weston_spring *spring, uint32_t msec);
1314 int
1315 weston_spring_done(struct weston_spring *spring);
1316
1317 void
1318 weston_view_activate(struct weston_view *view,
1319                      struct weston_seat *seat,
1320                      uint32_t flags);
1321
1322 void
1323 notify_motion(struct weston_seat *seat, uint32_t time,
1324               struct weston_pointer_motion_event *event);
1325 void
1326 notify_motion_absolute(struct weston_seat *seat, uint32_t time,
1327                        double x, double y);
1328 void
1329 notify_button(struct weston_seat *seat, uint32_t time, int32_t button,
1330               enum wl_pointer_button_state state);
1331 void
1332 notify_axis(struct weston_seat *seat, uint32_t time,
1333             struct weston_pointer_axis_event *event);
1334 void
1335 notify_axis_source(struct weston_seat *seat, uint32_t source);
1336
1337 void
1338 notify_pointer_frame(struct weston_seat *seat);
1339
1340 void
1341 notify_key(struct weston_seat *seat, uint32_t time, uint32_t key,
1342            enum wl_keyboard_key_state state,
1343            enum weston_key_state_update update_state);
1344 void
1345 notify_modifiers(struct weston_seat *seat, uint32_t serial);
1346
1347 void
1348 notify_pointer_focus(struct weston_seat *seat, struct weston_output *output,
1349                      double x, double y);
1350
1351 void
1352 notify_keyboard_focus_in(struct weston_seat *seat, struct wl_array *keys,
1353                          enum weston_key_state_update update_state);
1354 void
1355 notify_keyboard_focus_out(struct weston_seat *seat);
1356
1357 void
1358 notify_touch(struct weston_seat *seat, uint32_t time, int touch_id,
1359              double x, double y, int touch_type);
1360 void
1361 notify_touch_frame(struct weston_seat *seat);
1362
1363 void
1364 notify_touch_cancel(struct weston_seat *seat);
1365
1366 void
1367 weston_layer_entry_insert(struct weston_layer_entry *list,
1368                           struct weston_layer_entry *entry);
1369 void
1370 weston_layer_entry_remove(struct weston_layer_entry *entry);
1371 void
1372 weston_layer_init(struct weston_layer *layer,
1373                   struct weston_compositor *compositor);
1374 void
1375 weston_layer_set_position(struct weston_layer *layer,
1376                           enum weston_layer_position position);
1377 void
1378 weston_layer_unset_position(struct weston_layer *layer);
1379
1380 void
1381 weston_layer_set_mask(struct weston_layer *layer, int x, int y, int width, int height);
1382
1383 void
1384 weston_layer_set_mask_infinite(struct weston_layer *layer);
1385
1386 void
1387 weston_plane_init(struct weston_plane *plane,
1388                         struct weston_compositor *ec,
1389                         int32_t x, int32_t y);
1390 void
1391 weston_plane_release(struct weston_plane *plane);
1392
1393 void
1394 weston_compositor_stack_plane(struct weston_compositor *ec,
1395                               struct weston_plane *plane,
1396                               struct weston_plane *above);
1397
1398 /* An invalid flag in presented_flags to catch logic errors. */
1399 #define WP_PRESENTATION_FEEDBACK_INVALID (1U << 31)
1400
1401 void
1402 weston_output_finish_frame(struct weston_output *output,
1403                            const struct timespec *stamp,
1404                            uint32_t presented_flags);
1405 void
1406 weston_output_schedule_repaint(struct weston_output *output);
1407 void
1408 weston_output_damage(struct weston_output *output);
1409 void
1410 weston_compositor_schedule_repaint(struct weston_compositor *compositor);
1411 void
1412 weston_compositor_fade(struct weston_compositor *compositor, float tint);
1413 void
1414 weston_compositor_damage_all(struct weston_compositor *compositor);
1415 void
1416 weston_compositor_unlock(struct weston_compositor *compositor);
1417 void
1418 weston_compositor_wake(struct weston_compositor *compositor);
1419 void
1420 weston_compositor_offscreen(struct weston_compositor *compositor);
1421 void
1422 weston_compositor_sleep(struct weston_compositor *compositor);
1423 struct weston_view *
1424 weston_compositor_pick_view(struct weston_compositor *compositor,
1425                             wl_fixed_t x, wl_fixed_t y,
1426                             wl_fixed_t *sx, wl_fixed_t *sy);
1427
1428
1429 struct weston_binding;
1430 typedef void (*weston_key_binding_handler_t)(struct weston_keyboard *keyboard,
1431                                              uint32_t time, uint32_t key,
1432                                              void *data);
1433 struct weston_binding *
1434 weston_compositor_add_key_binding(struct weston_compositor *compositor,
1435                                   uint32_t key,
1436                                   enum weston_keyboard_modifier modifier,
1437                                   weston_key_binding_handler_t binding,
1438                                   void *data);
1439
1440 typedef void (*weston_modifier_binding_handler_t)(struct weston_keyboard *keyboard,
1441                                                   enum weston_keyboard_modifier modifier,
1442                                                   void *data);
1443 struct weston_binding *
1444 weston_compositor_add_modifier_binding(struct weston_compositor *compositor,
1445                                        enum weston_keyboard_modifier modifier,
1446                                        weston_modifier_binding_handler_t binding,
1447                                        void *data);
1448
1449 typedef void (*weston_button_binding_handler_t)(struct weston_pointer *pointer,
1450                                                 uint32_t time, uint32_t button,
1451                                                 void *data);
1452 struct weston_binding *
1453 weston_compositor_add_button_binding(struct weston_compositor *compositor,
1454                                      uint32_t button,
1455                                      enum weston_keyboard_modifier modifier,
1456                                      weston_button_binding_handler_t binding,
1457                                      void *data);
1458
1459 typedef void (*weston_touch_binding_handler_t)(struct weston_touch *touch,
1460                                                uint32_t time,
1461                                                void *data);
1462 struct weston_binding *
1463 weston_compositor_add_touch_binding(struct weston_compositor *compositor,
1464                                     enum weston_keyboard_modifier modifier,
1465                                     weston_touch_binding_handler_t binding,
1466                                     void *data);
1467
1468 typedef void (*weston_axis_binding_handler_t)(struct weston_pointer *pointer,
1469                                               uint32_t time,
1470                                               struct weston_pointer_axis_event *event,
1471                                               void *data);
1472 struct weston_binding *
1473 weston_compositor_add_axis_binding(struct weston_compositor *compositor,
1474                                    uint32_t axis,
1475                                    enum weston_keyboard_modifier modifier,
1476                                    weston_axis_binding_handler_t binding,
1477                                    void *data);
1478 struct weston_binding *
1479 weston_compositor_add_debug_binding(struct weston_compositor *compositor,
1480                                     uint32_t key,
1481                                     weston_key_binding_handler_t binding,
1482                                     void *data);
1483 void
1484 weston_binding_destroy(struct weston_binding *binding);
1485
1486 void
1487 weston_install_debug_key_binding(struct weston_compositor *compositor,
1488                                  uint32_t mod);
1489
1490 void
1491 weston_binding_list_destroy_all(struct wl_list *list);
1492
1493 void
1494 weston_compositor_run_key_binding(struct weston_compositor *compositor,
1495                                   struct weston_keyboard *keyboard,
1496                                   uint32_t time,
1497                                   uint32_t key,
1498                                   enum wl_keyboard_key_state state);
1499
1500 void
1501 weston_compositor_run_modifier_binding(struct weston_compositor *compositor,
1502                                        struct weston_keyboard *keyboard,
1503                                        enum weston_keyboard_modifier modifier,
1504                                        enum wl_keyboard_key_state state);
1505 void
1506 weston_compositor_run_button_binding(struct weston_compositor *compositor,
1507                                      struct weston_pointer *pointer, uint32_t time,
1508                                      uint32_t button,
1509                                      enum wl_pointer_button_state value);
1510 void
1511 weston_compositor_run_touch_binding(struct weston_compositor *compositor,
1512                                     struct weston_touch *touch, uint32_t time,
1513                                     int touch_type);
1514 int
1515 weston_compositor_run_axis_binding(struct weston_compositor *compositor,
1516                                    struct weston_pointer *pointer, uint32_t time,
1517                                    struct weston_pointer_axis_event *event);
1518 int
1519 weston_compositor_run_debug_binding(struct weston_compositor *compositor,
1520                                     struct weston_keyboard *keyboard, uint32_t time,
1521                                     uint32_t key,
1522                                     enum wl_keyboard_key_state state);
1523
1524 void
1525 weston_compositor_set_default_pointer_grab(struct weston_compositor *compositor,
1526                         const struct weston_pointer_grab_interface *interface);
1527
1528 int
1529 weston_environment_get_fd(const char *env);
1530
1531 struct weston_surface *
1532 weston_surface_create(struct weston_compositor *compositor);
1533
1534 struct weston_view *
1535 weston_view_create(struct weston_surface *surface);
1536
1537 void
1538 weston_view_destroy(struct weston_view *view);
1539
1540 void
1541 weston_view_set_position(struct weston_view *view,
1542                          float x, float y);
1543
1544 void
1545 weston_view_set_transform_parent(struct weston_view *view,
1546                                  struct weston_view *parent);
1547
1548 void
1549 weston_view_set_mask(struct weston_view *view,
1550                      int x, int y, int width, int height);
1551
1552 void
1553 weston_view_set_mask_infinite(struct weston_view *view);
1554
1555 bool
1556 weston_view_is_mapped(struct weston_view *view);
1557
1558 void
1559 weston_view_schedule_repaint(struct weston_view *view);
1560
1561 bool
1562 weston_surface_is_mapped(struct weston_surface *surface);
1563
1564 void
1565 weston_surface_set_size(struct weston_surface *surface,
1566                         int32_t width, int32_t height);
1567
1568 void
1569 weston_surface_schedule_repaint(struct weston_surface *surface);
1570
1571 void
1572 weston_surface_damage(struct weston_surface *surface);
1573
1574 void
1575 weston_view_damage_below(struct weston_view *view);
1576
1577 void
1578 weston_view_move_to_plane(struct weston_view *view,
1579                           struct weston_plane *plane);
1580 void
1581 weston_view_unmap(struct weston_view *view);
1582
1583 void
1584 weston_surface_unmap(struct weston_surface *surface);
1585
1586 struct weston_surface *
1587 weston_surface_get_main_surface(struct weston_surface *surface);
1588
1589 int
1590 weston_surface_set_role(struct weston_surface *surface,
1591                         const char *role_name,
1592                         struct wl_resource *error_resource,
1593                         uint32_t error_code);
1594 const char *
1595 weston_surface_get_role(struct weston_surface *surface);
1596
1597 void
1598 weston_surface_set_label_func(struct weston_surface *surface,
1599                               int (*desc)(struct weston_surface *,
1600                                           char *, size_t));
1601
1602 void
1603 weston_surface_get_content_size(struct weston_surface *surface,
1604                                 int *width, int *height);
1605
1606 struct weston_geometry
1607 weston_surface_get_bounding_box(struct weston_surface *surface);
1608
1609 int
1610 weston_surface_copy_content(struct weston_surface *surface,
1611                             void *target, size_t size,
1612                             int src_x, int src_y,
1613                             int width, int height);
1614
1615 struct weston_buffer *
1616 weston_buffer_from_resource(struct wl_resource *resource);
1617
1618 void
1619 weston_buffer_reference(struct weston_buffer_reference *ref,
1620                         struct weston_buffer *buffer);
1621
1622 uint32_t
1623 weston_compositor_get_time(void);
1624
1625 void
1626 weston_compositor_destroy(struct weston_compositor *ec);
1627 struct weston_compositor *
1628 weston_compositor_create(struct wl_display *display, void *user_data);
1629
1630 enum weston_compositor_backend {
1631         WESTON_BACKEND_DRM,
1632         WESTON_BACKEND_FBDEV,
1633         WESTON_BACKEND_HEADLESS,
1634         WESTON_BACKEND_RDP,
1635         WESTON_BACKEND_WAYLAND,
1636         WESTON_BACKEND_X11,
1637 };
1638
1639 int
1640 weston_compositor_load_backend(struct weston_compositor *compositor,
1641                                enum weston_compositor_backend backend,
1642                                struct weston_backend_config *config_base);
1643 void
1644 weston_compositor_exit(struct weston_compositor *ec);
1645 void *
1646 weston_compositor_get_user_data(struct weston_compositor *compositor);
1647 int
1648 weston_compositor_set_presentation_clock(struct weston_compositor *compositor,
1649                                          clockid_t clk_id);
1650 int
1651 weston_compositor_set_presentation_clock_software(
1652                                         struct weston_compositor *compositor);
1653 void
1654 weston_compositor_read_presentation_clock(
1655                         const struct weston_compositor *compositor,
1656                         struct timespec *ts);
1657
1658 bool
1659 weston_compositor_import_dmabuf(struct weston_compositor *compositor,
1660                                 struct linux_dmabuf_buffer *buffer);
1661
1662 void
1663 weston_compositor_shutdown(struct weston_compositor *ec);
1664 void
1665 weston_compositor_exit_with_code(struct weston_compositor *compositor,
1666                                  int exit_code);
1667 void
1668 weston_output_init_zoom(struct weston_output *output);
1669 void
1670 weston_output_update_zoom(struct weston_output *output);
1671 void
1672 weston_output_activate_zoom(struct weston_output *output,
1673                             struct weston_seat *seat);
1674 void
1675 weston_output_update_matrix(struct weston_output *output);
1676 void
1677 weston_output_move(struct weston_output *output, int x, int y);
1678
1679 void
1680 weston_compositor_add_output(struct weston_compositor *compositor,
1681                              struct weston_output *output);
1682 void
1683 weston_output_destroy(struct weston_output *output);
1684 void
1685 weston_output_transform_coordinate(struct weston_output *output,
1686                                    double device_x, double device_y,
1687                                    double *x, double *y);
1688
1689 void
1690 weston_seat_init(struct weston_seat *seat, struct weston_compositor *ec,
1691                  const char *seat_name);
1692 void
1693 weston_seat_init_pointer(struct weston_seat *seat);
1694 void
1695 weston_seat_release_pointer(struct weston_seat *seat);
1696 int
1697 weston_seat_init_keyboard(struct weston_seat *seat, struct xkb_keymap *keymap);
1698 void
1699 weston_seat_release_keyboard(struct weston_seat *seat);
1700 void
1701 weston_seat_init_touch(struct weston_seat *seat);
1702 void
1703 weston_seat_release_touch(struct weston_seat *seat);
1704 void
1705 weston_seat_repick(struct weston_seat *seat);
1706 void
1707 weston_seat_update_keymap(struct weston_seat *seat, struct xkb_keymap *keymap);
1708
1709 void
1710 weston_seat_release(struct weston_seat *seat);
1711 int
1712 weston_compositor_set_xkb_rule_names(struct weston_compositor *ec,
1713                                      struct xkb_rule_names *names);
1714 void
1715 weston_compositor_xkb_destroy(struct weston_compositor *ec);
1716
1717 /* String literal of spaces, the same width as the timestamp. */
1718 #define STAMP_SPACE "               "
1719
1720 typedef int (*log_func_t)(const char *fmt, va_list ap);
1721 void
1722 weston_log_set_handler(log_func_t log, log_func_t cont);
1723 int
1724 weston_vlog(const char *fmt, va_list ap);
1725 int
1726 weston_vlog_continue(const char *fmt, va_list ap);
1727 int
1728 weston_log(const char *fmt, ...)
1729         __attribute__ ((format (printf, 1, 2)));
1730 int
1731 weston_log_continue(const char *fmt, ...)
1732         __attribute__ ((format (printf, 1, 2)));
1733
1734 enum {
1735         TTY_ENTER_VT,
1736         TTY_LEAVE_VT
1737 };
1738
1739 struct tty *
1740 tty_create(struct weston_compositor *compositor, int tty_nr);
1741
1742 void
1743 tty_destroy(struct tty *tty);
1744
1745 void
1746 tty_reset(struct tty *tty);
1747
1748 int
1749 tty_activate_vt(struct tty *tty, int vt);
1750
1751 enum weston_screenshooter_outcome {
1752         WESTON_SCREENSHOOTER_SUCCESS,
1753         WESTON_SCREENSHOOTER_NO_MEMORY,
1754         WESTON_SCREENSHOOTER_BAD_BUFFER
1755 };
1756
1757 typedef void (*weston_screenshooter_done_func_t)(void *data,
1758                                 enum weston_screenshooter_outcome outcome);
1759 int
1760 weston_screenshooter_shoot(struct weston_output *output, struct weston_buffer *buffer,
1761                            weston_screenshooter_done_func_t done, void *data);
1762 struct weston_recorder *
1763 weston_recorder_start(struct weston_output *output, const char *filename);
1764 void
1765 weston_recorder_stop(struct weston_recorder *recorder);
1766
1767 struct clipboard *
1768 clipboard_create(struct weston_seat *seat);
1769
1770 struct weston_view_animation;
1771 typedef void (*weston_view_animation_done_func_t)(struct weston_view_animation *animation, void *data);
1772
1773 void
1774 weston_view_animation_destroy(struct weston_view_animation *animation);
1775
1776 struct weston_view_animation *
1777 weston_zoom_run(struct weston_view *view, float start, float stop,
1778                 weston_view_animation_done_func_t done, void *data);
1779
1780 struct weston_view_animation *
1781 weston_fade_run(struct weston_view *view,
1782                 float start, float end, float k,
1783                 weston_view_animation_done_func_t done, void *data);
1784
1785 struct weston_view_animation *
1786 weston_move_scale_run(struct weston_view *view, int dx, int dy,
1787                       float start, float end, bool reverse,
1788                       weston_view_animation_done_func_t done, void *data);
1789
1790 struct weston_view_animation *
1791 weston_move_run(struct weston_view *view, int dx, int dy,
1792                 float start, float end, bool reverse,
1793                 weston_view_animation_done_func_t done, void *data);
1794
1795 void
1796 weston_fade_update(struct weston_view_animation *fade, float target);
1797
1798 struct weston_view_animation *
1799 weston_stable_fade_run(struct weston_view *front_view, float start,
1800                        struct weston_view *back_view, float end,
1801                        weston_view_animation_done_func_t done, void *data);
1802
1803 struct weston_view_animation *
1804 weston_slide_run(struct weston_view *view, float start, float stop,
1805                  weston_view_animation_done_func_t done, void *data);
1806
1807 void
1808 weston_surface_set_color(struct weston_surface *surface,
1809                          float red, float green, float blue, float alpha);
1810
1811 void
1812 weston_surface_destroy(struct weston_surface *surface);
1813
1814 int
1815 weston_output_mode_set_native(struct weston_output *output,
1816                               struct weston_mode *mode,
1817                               int32_t scale);
1818 int
1819 weston_output_mode_switch_to_temporary(struct weston_output *output,
1820                                        struct weston_mode *mode,
1821                                        int32_t scale);
1822 int
1823 weston_output_mode_switch_to_native(struct weston_output *output);
1824
1825 int
1826 noop_renderer_init(struct weston_compositor *ec);
1827
1828 int
1829 weston_input_init(struct weston_compositor *compositor);
1830
1831 int
1832 weston_backend_init(struct weston_compositor *c,
1833                     struct weston_backend_config *config_base);
1834 int
1835 weston_module_init(struct weston_compositor *compositor);
1836
1837 void
1838 weston_transformed_coord(int width, int height,
1839                          enum wl_output_transform transform,
1840                          int32_t scale,
1841                          float sx, float sy, float *bx, float *by);
1842 pixman_box32_t
1843 weston_transformed_rect(int width, int height,
1844                         enum wl_output_transform transform,
1845                         int32_t scale,
1846                         pixman_box32_t rect);
1847 void
1848 weston_matrix_transform_region(pixman_region32_t *dest,
1849                                struct weston_matrix *matrix,
1850                                pixman_region32_t *src);
1851 void
1852 weston_transformed_region(int width, int height,
1853                           enum wl_output_transform transform,
1854                           int32_t scale,
1855                           pixman_region32_t *src, pixman_region32_t *dest);
1856
1857 void *
1858 weston_load_module(const char *name, const char *entrypoint);
1859
1860 int
1861 weston_parse_transform(const char *transform, uint32_t *out);
1862
1863 const char *
1864 weston_transform_to_string(uint32_t output_transform);
1865
1866 struct weston_keyboard *
1867 weston_seat_get_keyboard(struct weston_seat *seat);
1868
1869 struct weston_pointer *
1870 weston_seat_get_pointer(struct weston_seat *seat);
1871
1872 struct weston_touch *
1873 weston_seat_get_touch(struct weston_seat *seat);
1874
1875 void
1876 weston_seat_set_keyboard_focus(struct weston_seat *seat,
1877                                struct weston_surface *surface);
1878
1879 int
1880 weston_compositor_load_xwayland(struct weston_compositor *compositor);
1881
1882 void
1883 weston_output_set_scale(struct weston_output *output,
1884                         int32_t scale);
1885
1886 void
1887 weston_output_set_transform(struct weston_output *output,
1888                             uint32_t transform);
1889
1890 void
1891 weston_output_init(struct weston_output *output,
1892                    struct weston_compositor *compositor);
1893
1894 void
1895 weston_compositor_add_pending_output(struct weston_output *output,
1896                                      struct weston_compositor *compositor);
1897
1898 int
1899 weston_output_enable(struct weston_output *output);
1900
1901 void
1902 weston_output_disable(struct weston_output *output);
1903
1904 void
1905 weston_pending_output_coldplug(struct weston_compositor *compositor);
1906
1907 #ifdef  __cplusplus
1908 }
1909 #endif
1910
1911 #endif