From 73dae4b28d7f7c83a0600c013bad9f10db391a8c Mon Sep 17 00:00:00 2001 From: Luka Vilfan Date: Tue, 24 May 2022 20:21:27 +0200 Subject: [PATCH] A lot. Add keyboard layouts and switching. Add protocol definitions. Always use software cursor, to avoid a bug (probably f-d up something). Add proper minimize and maximize for views, fullscreen needs some work, same for cursor, always jumping. Resize doesn't work properly, should not be able to move window when resizing. --- bonsai/config/{signal.c => global.c} | 2 +- bonsai/config/input.c | 74 +- bonsai/{scene => desktop}/cursor.c | 7 +- bonsai/desktop/layer.c | 0 bonsai/{scene => desktop}/view.c | 95 +- bonsai/{scene => desktop}/workspace.c | 2 +- bonsai/events/{bsi-listeners.c => evglobal.c} | 4 +- bonsai/events/{bsi-input.c => evinput.c} | 5 +- bonsai/events/{bsi-output.c => evoutput.c} | 0 bonsai/events/{bsi-view.c => evview.c} | 44 +- .../events/{bsi-workspace.c => evworkspace.c} | 2 +- bonsai/main.c | 18 +- bonsai/meson.build | 22 +- bonsai/server.c | 2 +- include/bonsai/config/input.h | 56 +- include/bonsai/{scene => desktop}/cursor.h | 0 include/bonsai/desktop/layer.h | 25 + include/bonsai/{scene => desktop}/view.h | 25 +- include/bonsai/{scene => desktop}/workspace.h | 2 +- include/bonsai/server.h | 6 +- include/protocols/idle-protocol.h | 176 +++ .../protocols/server-decoration-protocol.h | 232 +++ .../wlr-layer-shell-unstable-v1-protocol.h | 606 ++++++++ .../wlr-screencopy-unstable-v1-protocol.h | 403 ++++++ meson.build | 5 - protocols/idle.xml | 49 + protocols/server-decoration.xml | 94 ++ protocols/wlr-layer-shell-unstable-v1.xml | 390 +++++ protocols/wlr-screencopy-unstable-v1.xml | 225 +++ protocols/xdg-shell.xml | 1282 +++++++++++++++++ 30 files changed, 3787 insertions(+), 66 deletions(-) rename bonsai/config/{signal.c => global.c} (97%) rename bonsai/{scene => desktop}/cursor.c (98%) create mode 100644 bonsai/desktop/layer.c rename bonsai/{scene => desktop}/view.c (69%) rename bonsai/{scene => desktop}/workspace.c (99%) rename bonsai/events/{bsi-listeners.c => evglobal.c} (99%) rename bonsai/events/{bsi-input.c => evinput.c} (99%) rename bonsai/events/{bsi-output.c => evoutput.c} (100%) rename bonsai/events/{bsi-view.c => evview.c} (85%) rename bonsai/events/{bsi-workspace.c => evworkspace.c} (96%) rename include/bonsai/{scene => desktop}/cursor.h (100%) create mode 100644 include/bonsai/desktop/layer.h rename include/bonsai/{scene => desktop}/view.h (88%) rename include/bonsai/{scene => desktop}/workspace.h (99%) create mode 100644 include/protocols/idle-protocol.h create mode 100644 include/protocols/server-decoration-protocol.h create mode 100644 include/protocols/wlr-layer-shell-unstable-v1-protocol.h create mode 100644 include/protocols/wlr-screencopy-unstable-v1-protocol.h create mode 100644 protocols/idle.xml create mode 100644 protocols/server-decoration.xml create mode 100644 protocols/wlr-layer-shell-unstable-v1.xml create mode 100644 protocols/wlr-screencopy-unstable-v1.xml create mode 100644 protocols/xdg-shell.xml diff --git a/bonsai/config/signal.c b/bonsai/config/global.c similarity index 97% rename from bonsai/config/signal.c rename to bonsai/config/global.c index 2560704..2e5158f 100644 --- a/bonsai/config/signal.c +++ b/bonsai/config/global.c @@ -6,7 +6,7 @@ #include #include "bonsai/config/signal.h" -#include "bonsai/scene/view.h" +#include "bonsai/desktop/view.h" #include "bonsai/server.h" struct bsi_listeners* diff --git a/bonsai/config/input.c b/bonsai/config/input.c index 8a1f093..e817bfb 100644 --- a/bonsai/config/input.c +++ b/bonsai/config/input.c @@ -1,5 +1,7 @@ #include +#include #include +#include #include #include #include @@ -66,7 +68,9 @@ bsi_inputs_keyboard_add(struct bsi_inputs* bsi_inputs, ++bsi_inputs->len_keyboards; wl_list_insert(&bsi_inputs->keyboards, &bsi_input_keyboard->link); - bsi_input_keyboard_keymap_set(bsi_input_keyboard, NULL); + bsi_input_keyboard_keymap_set(bsi_input_keyboard, + bsi_input_keyboard_rules, + bsi_input_keyboard_rules_len); wlr_seat_set_keyboard(bsi_inputs->wlr_seat, bsi_input_keyboard->wlr_input_device); @@ -158,13 +162,68 @@ bsi_input_keyboard_init(struct bsi_input_keyboard* bsi_input_keyboard, void bsi_input_keyboard_keymap_set(struct bsi_input_keyboard* bsi_input_keyboard, - const struct xkb_rule_names* xkb_rule_names) + const struct xkb_rule_names* xkb_rule_names, + const size_t xkb_rule_names_len) { assert(bsi_input_keyboard); +#define rs_len_max 50 + size_t rs_len[] = { [4] = 0 }; + char rules[rs_len_max] = { 0 }, models[rs_len_max] = { 0 }, + layouts[rs_len_max] = { 0 }, variants[rs_len_max] = { 0 }, + options[rs_len_max] = { 0 }; + + for (size_t i = 0; i < xkb_rule_names_len; ++i) { + const struct xkb_rule_names* rs = &xkb_rule_names[i]; + if (rs->rules != NULL && + rs_len[0] + strlen(rs->rules) < rs_len_max - 1) { + if (rs_len[0] != 0) + strcat(rules + strlen(rules), ","); + strcat(rules + strlen(rules), rs->rules); + rs_len[0] = strlen(rules); + } + if (rs->model != NULL && + rs_len[1] + strlen(rs->model) < rs_len_max - 1) { + if (rs_len[1] != 0) + strcat(models + strlen(models), ","); + strcat(models + strlen(models), rs->model); + rs_len[1] = strlen(models); + } + if (rs->layout != NULL && + rs_len[2] + strlen(rs->layout) < rs_len_max - 1) { + if (rs_len[2] != 0) + strcat(layouts + strlen(layouts), ","); + strcat(layouts + strlen(layouts), rs->layout); + rs_len[2] = strlen(layouts); + } + if (rs->variant != NULL && + rs_len[3] + strlen(rs->variant) < rs_len_max - 1) { + if (rs_len[3] != 0) + strcat(variants + strlen(variants), ","); + strcat(variants + strlen(variants), rs->variant); + rs_len[3] = strlen(variants); + } + if (rs->options != NULL && + rs_len[4] + strlen(rs->options) < rs_len_max - 1) { + if (rs_len[4] != 0) + strcat(options + strlen(options), ","); + strcat(options + strlen(options), rs->options); + rs_len[4] = strlen(options); + } + } +#undef rs_len_max + + struct xkb_rule_names xkb_rules_all = { + .rules = rules, + .model = models, + .layout = layouts, + .variant = variants, + .options = options, + }; + struct xkb_context* xkb_context = xkb_context_new(XKB_CONTEXT_NO_FLAGS); struct xkb_keymap* xkb_keymap = xkb_keymap_new_from_names( - xkb_context, xkb_rule_names, XKB_KEYMAP_COMPILE_NO_FLAGS); + xkb_context, &xkb_rules_all, XKB_KEYMAP_COMPILE_NO_FLAGS); wlr_keyboard_set_keymap(bsi_input_keyboard->wlr_input_device->keyboard, xkb_keymap); @@ -173,15 +232,6 @@ bsi_input_keyboard_keymap_set(struct bsi_input_keyboard* bsi_input_keyboard, xkb_context_unref(xkb_context); } -void -bsi_input_keyboard_layout_set(struct bsi_input_keyboard* bsi_input_keyboard, - const char* layout) -{ - assert(bsi_input_keyboard); - - // TODO: Wat do? -} - void bsi_input_keyboard_destroy(struct bsi_input_keyboard* bsi_input_keyboard) { diff --git a/bonsai/scene/cursor.c b/bonsai/desktop/cursor.c similarity index 98% rename from bonsai/scene/cursor.c rename to bonsai/desktop/cursor.c index 0168579..df617dc 100644 --- a/bonsai/scene/cursor.c +++ b/bonsai/desktop/cursor.c @@ -8,7 +8,8 @@ #include #include -#include "bonsai/scene/cursor.h" +#include "bonsai/desktop/cursor.h" +#include "bonsai/desktop/view.h" #include "bonsai/server.h" struct bsi_cursor* @@ -132,6 +133,10 @@ bsi_cursor_process_view_move(struct bsi_cursor* bsi_cursor, bsi_view->x = bsi_server->wlr_cursor->x - bsi_cursor->grab_x; bsi_view->y = bsi_server->wlr_cursor->y - bsi_cursor->grab_y; + + if (bsi_view->maximized) + bsi_view_set_maximized(bsi_view, false); + wlr_scene_node_set_position( bsi_view->wlr_scene_node, bsi_view->x, bsi_view->y); } diff --git a/bonsai/desktop/layer.c b/bonsai/desktop/layer.c new file mode 100644 index 0000000..e69de29 diff --git a/bonsai/scene/view.c b/bonsai/desktop/view.c similarity index 69% rename from bonsai/scene/view.c rename to bonsai/desktop/view.c index 3956a1c..31ebc2b 100644 --- a/bonsai/scene/view.c +++ b/bonsai/desktop/view.c @@ -8,10 +8,12 @@ #include #include #include +#include #include -#include "bonsai/scene/cursor.h" -#include "bonsai/scene/view.h" +#include "bonsai/config/output.h" +#include "bonsai/desktop/cursor.h" +#include "bonsai/desktop/view.h" #include "bonsai/server.h" struct bsi_views* @@ -71,8 +73,14 @@ bsi_view_init(struct bsi_view* bsi_view, bsi_view->bsi_workspace = bsi_workspace; bsi_view->x = 0.0; bsi_view->y = 0.0; + bsi_view->width = 0; + bsi_view->height = 0; bsi_view->active_listeners = 0; bsi_view->len_active_links = 0; + bsi_view->mapped = false; + bsi_view->maximized = false; + bsi_view->minimized = false; + bsi_view->fullscreen = false; /* Create a new node from the root server node. */ bsi_view->wlr_scene_node = wlr_scene_xdg_surface_create( @@ -194,6 +202,89 @@ bsi_view_interactive_begin(struct bsi_view* bsi_view, } } +void +bsi_view_set_maximized(struct bsi_view* bsi_view, bool maximized) +{ + assert(bsi_view); + + if (!maximized) { + bsi_view_restore_prev(bsi_view); + } else { + struct wlr_box box; + wlr_xdg_surface_get_geometry(bsi_view->wlr_xdg_surface, &box); + bsi_view->x = box.x; + bsi_view->y = box.y; + bsi_view->width = box.width; + bsi_view->height = box.height; + bsi_view->maximized = maximized; + + struct bsi_server* server = bsi_view->bsi_server; + struct bsi_output* output = bsi_view->bsi_workspace->bsi_output; + struct wlr_box* output_box = wlr_output_layout_get_box( + server->wlr_output_layout, output->wlr_output); + wlr_scene_node_set_position(bsi_view->wlr_scene_node, 0, 0); + wlr_xdg_toplevel_set_size( + bsi_view->wlr_xdg_surface, output_box->width, output_box->height); + } +} + +void +bsi_view_set_minimized(struct bsi_view* bsi_view, bool minimized) +{ + assert(bsi_view); + + if (!minimized) { + bsi_view_restore_prev(bsi_view); + } else { + struct wlr_box box; + wlr_xdg_surface_get_geometry(bsi_view->wlr_xdg_surface, &box); + bsi_view->x = box.x; + bsi_view->y = box.y; + bsi_view->width = box.width; + bsi_view->height = box.height; + bsi_view->minimized = minimized; + + wlr_scene_node_set_enabled(bsi_view->wlr_scene_node, false); + } +} + +void +bsi_view_set_fullscreen(struct bsi_view* bsi_view, bool fullscreen) +{ + assert(bsi_view); + + if (!fullscreen) { + bsi_view_restore_prev(bsi_view); + } else { + struct wlr_box box; + wlr_xdg_surface_get_geometry(bsi_view->wlr_xdg_surface, &box); + bsi_view->x = box.x; + bsi_view->y = box.y; + bsi_view->width = box.width; + bsi_view->height = box.height; + bsi_view->fullscreen = fullscreen; + + // TODO: This should probably get rid of decorations to put the entire + // app fullscreen + struct bsi_server* server = bsi_view->bsi_server; + struct bsi_output* output = bsi_view->bsi_workspace->bsi_output; + struct wlr_box* output_box = wlr_output_layout_get_box( + server->wlr_output_layout, output->wlr_output); + wlr_scene_node_set_position(bsi_view->wlr_scene_node, 0, 0); + wlr_xdg_toplevel_set_size( + bsi_view->wlr_xdg_surface, output_box->width, output_box->height); + } +} + +void +bsi_view_restore_prev(struct bsi_view* bsi_view) +{ + wlr_xdg_toplevel_set_size( + bsi_view->wlr_xdg_surface, bsi_view->width, bsi_view->height); + wlr_scene_node_set_position( + bsi_view->wlr_scene_node, bsi_view->x, bsi_view->y); +} + void bsi_view_listener_add(struct bsi_view* bsi_view, enum bsi_view_listener_mask bsi_listener_type, diff --git a/bonsai/scene/workspace.c b/bonsai/desktop/workspace.c similarity index 99% rename from bonsai/scene/workspace.c rename to bonsai/desktop/workspace.c index 59c3d98..4eef441 100644 --- a/bonsai/scene/workspace.c +++ b/bonsai/desktop/workspace.c @@ -6,7 +6,7 @@ #include #include -#include "bonsai/scene/workspace.h" +#include "bonsai/desktop/workspace.h" #include "bonsai/server.h" #include "bonsai/util.h" diff --git a/bonsai/events/bsi-listeners.c b/bonsai/events/evglobal.c similarity index 99% rename from bonsai/events/bsi-listeners.c rename to bonsai/events/evglobal.c index bf3ec78..8193d8f 100644 --- a/bonsai/events/bsi-listeners.c +++ b/bonsai/events/evglobal.c @@ -24,9 +24,9 @@ #include "bonsai/config/input.h" #include "bonsai/config/signal.h" +#include "bonsai/desktop/view.h" +#include "bonsai/desktop/workspace.h" #include "bonsai/events.h" -#include "bonsai/scene/view.h" -#include "bonsai/scene/workspace.h" #include "bonsai/server.h" #define GIMME_ALL_GLOBAL_EVENTS diff --git a/bonsai/events/bsi-input.c b/bonsai/events/evinput.c similarity index 99% rename from bonsai/events/bsi-input.c rename to bonsai/events/evinput.c index c89d015..b7547e5 100644 --- a/bonsai/events/bsi-input.c +++ b/bonsai/events/evinput.c @@ -14,9 +14,9 @@ #include #include "bonsai/config/input.h" +#include "bonsai/desktop/cursor.h" +#include "bonsai/desktop/view.h" #include "bonsai/events.h" -#include "bonsai/scene/cursor.h" -#include "bonsai/scene/view.h" #include "bonsai/server.h" // #define GIMME_ALL_POINTER_EVENTS @@ -306,6 +306,7 @@ bsi_input_keyboard_repeat_info_notify(struct wl_listener* listener, void* data) // TODO: Wat do? // TODO: Server is only handler? + #warning "Not implemented" } diff --git a/bonsai/events/bsi-output.c b/bonsai/events/evoutput.c similarity index 100% rename from bonsai/events/bsi-output.c rename to bonsai/events/evoutput.c diff --git a/bonsai/events/bsi-view.c b/bonsai/events/evview.c similarity index 85% rename from bonsai/events/bsi-view.c rename to bonsai/events/evview.c index 4ec686e..9c11ba7 100644 --- a/bonsai/events/bsi-view.c +++ b/bonsai/events/evview.c @@ -12,10 +12,10 @@ #include #include +#include "bonsai/desktop/cursor.h" +#include "bonsai/desktop/view.h" +#include "bonsai/desktop/workspace.h" #include "bonsai/events.h" -#include "bonsai/scene/cursor.h" -#include "bonsai/scene/view.h" -#include "bonsai/scene/workspace.h" #include "bonsai/server.h" #define GIMME_ALL_VIEW_EVENTS @@ -85,8 +85,7 @@ bsi_view_new_popup_notify(struct wl_listener* listener, void* data) } void -bsi_view_map_notify(struct wl_listener* listener, - __attribute__((unused)) void* data) +bsi_view_map_notify(struct wl_listener* listener, void* data) { #ifdef GIMME_ALL_VIEW_EVENTS wlr_log(WLR_DEBUG, "Got event map from wlr_xdg_surface"); @@ -94,7 +93,15 @@ bsi_view_map_notify(struct wl_listener* listener, struct bsi_view* bsi_view = wl_container_of(listener, bsi_view, events.map); struct bsi_views* bsi_views = &bsi_view->bsi_server->bsi_views; + struct wlr_xdg_surface* wlr_xdg_surface = data; + + if (wlr_xdg_surface->role == WLR_XDG_SURFACE_ROLE_TOPLEVEL) { + struct wlr_xdg_toplevel_requested* requested = + &wlr_xdg_surface->toplevel->requested; + // TODO: Implement maximize for surface + } + bsi_view->mapped = true; bsi_views_add(bsi_views, bsi_view); bsi_view_focus(bsi_view); } @@ -111,6 +118,7 @@ bsi_view_unmap_notify(struct wl_listener* listener, wl_container_of(listener, bsi_view, events.unmap); struct bsi_views* bsi_views = &bsi_view->bsi_server->bsi_views; + bsi_view->mapped = false; bsi_views_remove(bsi_views, bsi_view); } @@ -142,7 +150,15 @@ bsi_view_request_maximize_notify(struct wl_listener* listener, void* data) // TODO: This should probably take into account the panels and such stuff. // Also take a look at // https://gitlab.freedesktop.org/wlroots/wlr-protocols/-/blob/master/unstable/wlr-layer-shell-unstable-v1.xml -#warning "Not implemented" + + struct bsi_view* bsi_view = + wl_container_of(listener, bsi_view, events.request_maximize); + struct wlr_xdg_surface* surface = bsi_view->wlr_xdg_surface; + bool maximized = data; + + bsi_view_set_maximized(bsi_view, maximized); + /* This surface should now consider itself */ + wlr_xdg_toplevel_set_maximized(surface, maximized); } void @@ -151,12 +167,18 @@ bsi_view_request_fullscreen_notify(struct wl_listener* listener, void* data) #ifdef GIMME_ALL_VIEW_EVENTS wlr_log(WLR_DEBUG, "Got event request_fullscreen from wlr_xdg_toplevel"); #endif -#warning "Not implemented" + + struct bsi_view* bsi_view = + wl_container_of(listener, bsi_view, events.request_fullscreen); + struct wlr_xdg_toplevel_set_fullscreen_event* event = data; + + bsi_view_set_fullscreen(bsi_view, event->fullscreen); + /* This surface should now consider itself (un-)fullscreen. */ + wlr_xdg_toplevel_set_fullscreen(event->surface, event->fullscreen); } void -bsi_view_request_minimize_notify(struct wl_listener* listener, - __attribute__((unused)) void* data) +bsi_view_request_minimize_notify(struct wl_listener* listener, void* data) { #ifdef GIMME_ALL_VIEW_EVENTS wlr_log(WLR_DEBUG, "Got event request_minimize from wlr_xdg_toplevel"); @@ -165,7 +187,11 @@ bsi_view_request_minimize_notify(struct wl_listener* listener, struct bsi_view* bsi_view = wl_container_of(listener, bsi_view, events.request_minimize); struct bsi_views* bsi_views = &bsi_view->bsi_server->bsi_views; + bool minimized = data; + + // TODO: Is this right? I have no clue. + bsi_view_set_minimized(bsi_view, minimized); bsi_views_remove(bsi_views, bsi_view); } diff --git a/bonsai/events/bsi-workspace.c b/bonsai/events/evworkspace.c similarity index 96% rename from bonsai/events/bsi-workspace.c rename to bonsai/events/evworkspace.c index dcb2cf7..5747acf 100644 --- a/bonsai/events/bsi-workspace.c +++ b/bonsai/events/evworkspace.c @@ -7,8 +7,8 @@ #include #include +#include "bonsai/desktop/view.h" #include "bonsai/events.h" -#include "bonsai/scene/view.h" #include "bonsai/server.h" #define GIMME_ALL_WORKSPACE_EVENTS diff --git a/bonsai/main.c b/bonsai/main.c index a43aaab..c173af4 100644 --- a/bonsai/main.c +++ b/bonsai/main.c @@ -25,12 +25,15 @@ #include "bonsai/config/input.h" #include "bonsai/config/output.h" #include "bonsai/config/signal.h" +#include "bonsai/desktop/cursor.h" +#include "bonsai/desktop/view.h" #include "bonsai/events.h" -#include "bonsai/scene/cursor.h" -#include "bonsai/scene/view.h" #include "bonsai/server.h" #include "bonsai/util.h" +// TODO: Take a look at +// https://gitlab.freedesktop.org/wlroots/wlroots/-/tree/master/examples + int main(void) { @@ -54,6 +57,17 @@ main(void) exit(EXIT_FAILURE); } + if (setenv("WLR_NO_HARDWARE_CURSORS", "1", true) != 0) { + // Workaround for https://github.com/swaywm/wlroots/issues/3189 + // TODO: Idk man these cursors are weird. + wlr_log(WLR_ERROR, + "Failed to set WLR_NO_HARDWARE_CURSORS env var: %s", + strerror(errno)); + wlr_backend_destroy(server.wlr_backend); + wl_display_destroy(server.wl_display); + exit(EXIT_FAILURE); + } + if (!wlr_backend_start(server.wlr_backend)) { wlr_log(WLR_ERROR, "Failed to start backend"); wlr_backend_destroy(server.wlr_backend); diff --git a/bonsai/meson.build b/bonsai/meson.build index 3289679..ccc31ad 100644 --- a/bonsai/meson.build +++ b/bonsai/meson.build @@ -5,23 +5,25 @@ bonsai_src = files( 'config/input.c', 'config/output.c', - 'config/signal.c', + 'config/global.c', - 'scene/view.c', - 'scene/cursor.c', - 'scene/workspace.c', + 'desktop/view.c', + 'desktop/cursor.c', + 'desktop/workspace.c', + 'desktop/layer.c', - 'events/bsi-listeners.c', - 'events/bsi-output.c', - 'events/bsi-input.c', - 'events/bsi-view.c', - 'events/bsi-workspace.c', + 'events/evglobal.c', + 'events/evoutput.c', + 'events/evinput.c', + 'events/evview.c', + 'events/evworkspace.c', ) bonsai_dep = [ dep_wlroots, dep_libinput, - dep_libdev, + dep_libudev, + dep_libevdev, dep_xkbcommon, dep_glesv2, dep_drm, diff --git a/bonsai/server.c b/bonsai/server.c index 995af39..25cf821 100644 --- a/bonsai/server.c +++ b/bonsai/server.c @@ -12,8 +12,8 @@ #include #include "bonsai/config/signal.h" +#include "bonsai/desktop/workspace.h" #include "bonsai/events.h" -#include "bonsai/scene/workspace.h" #include "bonsai/server.h" struct bsi_server* diff --git a/include/bonsai/config/input.h b/include/bonsai/config/input.h index 6a842d6..338fb5e 100644 --- a/include/bonsai/config/input.h +++ b/include/bonsai/config/input.h @@ -119,6 +119,49 @@ struct bsi_input_keyboard struct wl_list link; }; +/** + * @brief Identifies all currently supported xkb layouts. + * + */ +enum bsi_input_keyboard_layout +{ + BSI_INPUT_KEYBOARD_LAYOUT_EN_US, + BSI_INPUT_KEYBOARD_LAYOUT_SI_SI, + BSI_INPUT_KEYBOARD_LAYOUT_SI_US, +}; + +#define bsi_input_keyboard_rules_len 3 + +/** + * @brief Holds all currently supported xkb layout rules. + * + */ +// ! For documentation on this illusive thing, see xkeyboard-config(7). +// TODO: Make this configuration available from somewhere. +static const struct xkb_rule_names bsi_input_keyboard_rules[] = { + [BSI_INPUT_KEYBOARD_LAYOUT_EN_US] = { + .rules = NULL, + .model = "pc105", + .layout = "us", + .variant = NULL, + .options = "grp:win_space_toggle", + }, + [BSI_INPUT_KEYBOARD_LAYOUT_SI_SI] = { + .rules = NULL, + .model = "pc105", + .layout = "si", + .variant = NULL, + .options = "grp:win_space_toggle", + }, + [BSI_INPUT_KEYBOARD_LAYOUT_SI_US] = { + .rules = NULL, + .model = "pc105", + .layout = "si(us)", + .variant = NULL, + .options = "grp:win_space_toggle", + }, +}; + /** * @brief Initializes inputs for the given server seat. * @@ -243,17 +286,8 @@ bsi_input_keyboard_init(struct bsi_input_keyboard* bsi_input_keyboard, */ void bsi_input_keyboard_keymap_set(struct bsi_input_keyboard* bsi_input_keyboard, - const struct xkb_rule_names* xkb_rule_names); - -/** - * @brief Sets the layout for the specified input keyboard. - * - * @param bsi_input_keyboard The keyboard. - * @param layout The layout string. - */ -void -bsi_input_keyboard_layout_set(struct bsi_input_keyboard* bsi_input_keyboard, - const char* layout); + const struct xkb_rule_names* xkb_rule_names, + const size_t xkb_rule_names_len); /** * @brief Destroys (calls `free`) on the keyboard. diff --git a/include/bonsai/scene/cursor.h b/include/bonsai/desktop/cursor.h similarity index 100% rename from include/bonsai/scene/cursor.h rename to include/bonsai/desktop/cursor.h diff --git a/include/bonsai/desktop/layer.h b/include/bonsai/desktop/layer.h new file mode 100644 index 0000000..72e0715 --- /dev/null +++ b/include/bonsai/desktop/layer.h @@ -0,0 +1,25 @@ +#pragma once + +#include +#include + +struct bsi_layer_background +{}; + +struct bsi_layer_bottom +{}; + +struct bsi_layer_top +{}; + +struct bsi_layer_overlay +{}; + +struct bsi_layers +{ + // TODO: Wat do? + struct bsi_layer_background background; + struct bsi_layer_bottom bottom; + struct bsi_layer_top top; + struct bsi_layer_overlay overlay; +}; diff --git a/include/bonsai/scene/view.h b/include/bonsai/desktop/view.h similarity index 88% rename from include/bonsai/scene/view.h rename to include/bonsai/desktop/view.h index 0a8d74c..cab7739 100644 --- a/include/bonsai/scene/view.h +++ b/include/bonsai/desktop/view.h @@ -1,7 +1,7 @@ #pragma once -#include "bonsai/scene/cursor.h" -#include "bonsai/scene/workspace.h" +#include "bonsai/desktop/cursor.h" +#include "bonsai/desktop/workspace.h" #include #include @@ -57,10 +57,19 @@ struct bsi_view struct wlr_xdg_surface* wlr_xdg_surface; struct wlr_scene_node* wlr_scene_node; + bool mapped; + bool maximized, minimized, fullscreen; + char* app_id; char* app_title; struct bsi_workspace* bsi_workspace; + + /* Note, that when the window goes fullscreen, minimized or maximized, + * this will hold the last state of the window that should be restored when + * restoring the window mode to normal. The helper function + * bsi_view_restore_prev() does just that. */ double x, y; + uint32_t width, height; uint32_t active_listeners; struct wl_list* active_links[bsi_view_listener_len]; @@ -182,6 +191,18 @@ bsi_view_interactive_begin(struct bsi_view* bsi_view, enum bsi_cursor_mode bsi_cursor_mode, uint32_t edges); +void +bsi_view_set_maximized(struct bsi_view* bsi_view, bool maximized); + +void +bsi_view_set_minimized(struct bsi_view* bsi_view, bool minimized); + +void +bsi_view_set_fullscreen(struct bsi_view* bsi_view, bool fullscreen); + +void +bsi_view_restore_prev(struct bsi_view* bsi_view); + /** * @brief Adds a listener to the scene node represented by `bsi_view`. * diff --git a/include/bonsai/scene/workspace.h b/include/bonsai/desktop/workspace.h similarity index 99% rename from include/bonsai/scene/workspace.h rename to include/bonsai/desktop/workspace.h index b4cf43b..636fd9e 100644 --- a/include/bonsai/scene/workspace.h +++ b/include/bonsai/desktop/workspace.h @@ -3,7 +3,7 @@ #include #include "bonsai/config/output.h" -#include "bonsai/scene/view.h" +#include "bonsai/desktop/view.h" struct bsi_server; diff --git a/include/bonsai/server.h b/include/bonsai/server.h index 8d18529..486ec7b 100644 --- a/include/bonsai/server.h +++ b/include/bonsai/server.h @@ -3,9 +3,9 @@ #include "bonsai/config/input.h" #include "bonsai/config/output.h" #include "bonsai/config/signal.h" -#include "bonsai/scene/cursor.h" -#include "bonsai/scene/view.h" -#include "bonsai/scene/workspace.h" +#include "bonsai/desktop/cursor.h" +#include "bonsai/desktop/view.h" +#include "bonsai/desktop/workspace.h" /** * @brief Represents the compositor and its internal state. diff --git a/include/protocols/idle-protocol.h b/include/protocols/idle-protocol.h new file mode 100644 index 0000000..88b85df --- /dev/null +++ b/include/protocols/idle-protocol.h @@ -0,0 +1,176 @@ +/* Generated by wayland-scanner 1.20.0 */ + +#ifndef IDLE_SERVER_PROTOCOL_H +#define IDLE_SERVER_PROTOCOL_H + +#include +#include +#include "wayland-server.h" + +#ifdef __cplusplus +extern "C" { +#endif + +struct wl_client; +struct wl_resource; + +/** + * @page page_idle The idle protocol + * @section page_ifaces_idle Interfaces + * - @subpage page_iface_org_kde_kwin_idle - User idle time manager + * - @subpage page_iface_org_kde_kwin_idle_timeout - + * @section page_copyright_idle Copyright + * 
+ *
+ * Copyright (C) 2015 Martin Gräßlin
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 2.1 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see .
+ *
+ */ +struct org_kde_kwin_idle; +struct org_kde_kwin_idle_timeout; +struct wl_seat; + +#ifndef ORG_KDE_KWIN_IDLE_INTERFACE +#define ORG_KDE_KWIN_IDLE_INTERFACE +/** + * @page page_iface_org_kde_kwin_idle org_kde_kwin_idle + * @section page_iface_org_kde_kwin_idle_desc Description + * + * This interface allows to monitor user idle time on a given seat. The interface + * allows to register timers which trigger after no user activity was registered + * on the seat for a given interval. It notifies when user activity resumes. + * + * This is useful for applications wanting to perform actions when the user is not + * interacting with the system, e.g. chat applications setting the user as away, power + * management features to dim screen, etc.. + * @section page_iface_org_kde_kwin_idle_api API + * See @ref iface_org_kde_kwin_idle. + */ +/** + * @defgroup iface_org_kde_kwin_idle The org_kde_kwin_idle interface + * + * This interface allows to monitor user idle time on a given seat. The interface + * allows to register timers which trigger after no user activity was registered + * on the seat for a given interval. It notifies when user activity resumes. + * + * This is useful for applications wanting to perform actions when the user is not + * interacting with the system, e.g. chat applications setting the user as away, power + * management features to dim screen, etc.. + */ +extern const struct wl_interface org_kde_kwin_idle_interface; +#endif +#ifndef ORG_KDE_KWIN_IDLE_TIMEOUT_INTERFACE +#define ORG_KDE_KWIN_IDLE_TIMEOUT_INTERFACE +/** + * @page page_iface_org_kde_kwin_idle_timeout org_kde_kwin_idle_timeout + * @section page_iface_org_kde_kwin_idle_timeout_api API + * See @ref iface_org_kde_kwin_idle_timeout. + */ +/** + * @defgroup iface_org_kde_kwin_idle_timeout The org_kde_kwin_idle_timeout interface + */ +extern const struct wl_interface org_kde_kwin_idle_timeout_interface; +#endif + +/** + * @ingroup iface_org_kde_kwin_idle + * @struct org_kde_kwin_idle_interface + */ +struct org_kde_kwin_idle_interface { + /** + * @param timeout The idle timeout in msec + */ + void (*get_idle_timeout)(struct wl_client *client, + struct wl_resource *resource, + uint32_t id, + struct wl_resource *seat, + uint32_t timeout); +}; + + +/** + * @ingroup iface_org_kde_kwin_idle + */ +#define ORG_KDE_KWIN_IDLE_GET_IDLE_TIMEOUT_SINCE_VERSION 1 + +/** + * @ingroup iface_org_kde_kwin_idle_timeout + * @struct org_kde_kwin_idle_timeout_interface + */ +struct org_kde_kwin_idle_timeout_interface { + /** + * release the timeout object + * + * + */ + void (*release)(struct wl_client *client, + struct wl_resource *resource); + /** + * Simulates user activity for this timeout, behaves just like real user activity on the seat + * + * + */ + void (*simulate_user_activity)(struct wl_client *client, + struct wl_resource *resource); +}; + +#define ORG_KDE_KWIN_IDLE_TIMEOUT_IDLE 0 +#define ORG_KDE_KWIN_IDLE_TIMEOUT_RESUMED 1 + +/** + * @ingroup iface_org_kde_kwin_idle_timeout + */ +#define ORG_KDE_KWIN_IDLE_TIMEOUT_IDLE_SINCE_VERSION 1 +/** + * @ingroup iface_org_kde_kwin_idle_timeout + */ +#define ORG_KDE_KWIN_IDLE_TIMEOUT_RESUMED_SINCE_VERSION 1 + +/** + * @ingroup iface_org_kde_kwin_idle_timeout + */ +#define ORG_KDE_KWIN_IDLE_TIMEOUT_RELEASE_SINCE_VERSION 1 +/** + * @ingroup iface_org_kde_kwin_idle_timeout + */ +#define ORG_KDE_KWIN_IDLE_TIMEOUT_SIMULATE_USER_ACTIVITY_SINCE_VERSION 1 + +/** + * @ingroup iface_org_kde_kwin_idle_timeout + * Sends an idle event to the client owning the resource. + * @param resource_ The client's resource + */ +static inline void +org_kde_kwin_idle_timeout_send_idle(struct wl_resource *resource_) +{ + wl_resource_post_event(resource_, ORG_KDE_KWIN_IDLE_TIMEOUT_IDLE); +} + +/** + * @ingroup iface_org_kde_kwin_idle_timeout + * Sends an resumed event to the client owning the resource. + * @param resource_ The client's resource + */ +static inline void +org_kde_kwin_idle_timeout_send_resumed(struct wl_resource *resource_) +{ + wl_resource_post_event(resource_, ORG_KDE_KWIN_IDLE_TIMEOUT_RESUMED); +} + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/include/protocols/server-decoration-protocol.h b/include/protocols/server-decoration-protocol.h new file mode 100644 index 0000000..39b3167 --- /dev/null +++ b/include/protocols/server-decoration-protocol.h @@ -0,0 +1,232 @@ +/* Generated by wayland-scanner 1.20.0 */ + +#ifndef SERVER_DECORATION_SERVER_PROTOCOL_H +#define SERVER_DECORATION_SERVER_PROTOCOL_H + +#include +#include +#include "wayland-server.h" + +#ifdef __cplusplus +extern "C" { +#endif + +struct wl_client; +struct wl_resource; + +/** + * @page page_server_decoration The server_decoration protocol + * @section page_ifaces_server_decoration Interfaces + * - @subpage page_iface_org_kde_kwin_server_decoration_manager - Server side window decoration manager + * - @subpage page_iface_org_kde_kwin_server_decoration - + * @section page_copyright_server_decoration Copyright + * 
+ *
+ * Copyright (C) 2015 Martin Gräßlin
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 2.1 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see .
+ *
+ */ +struct org_kde_kwin_server_decoration; +struct org_kde_kwin_server_decoration_manager; +struct wl_surface; + +#ifndef ORG_KDE_KWIN_SERVER_DECORATION_MANAGER_INTERFACE +#define ORG_KDE_KWIN_SERVER_DECORATION_MANAGER_INTERFACE +/** + * @page page_iface_org_kde_kwin_server_decoration_manager org_kde_kwin_server_decoration_manager + * @section page_iface_org_kde_kwin_server_decoration_manager_desc Description + * + * This interface allows to coordinate whether the server should create + * a server-side window decoration around a wl_surface representing a + * shell surface (wl_shell_surface or similar). By announcing support + * for this interface the server indicates that it supports server + * side decorations. + * @section page_iface_org_kde_kwin_server_decoration_manager_api API + * See @ref iface_org_kde_kwin_server_decoration_manager. + */ +/** + * @defgroup iface_org_kde_kwin_server_decoration_manager The org_kde_kwin_server_decoration_manager interface + * + * This interface allows to coordinate whether the server should create + * a server-side window decoration around a wl_surface representing a + * shell surface (wl_shell_surface or similar). By announcing support + * for this interface the server indicates that it supports server + * side decorations. + */ +extern const struct wl_interface org_kde_kwin_server_decoration_manager_interface; +#endif +#ifndef ORG_KDE_KWIN_SERVER_DECORATION_INTERFACE +#define ORG_KDE_KWIN_SERVER_DECORATION_INTERFACE +/** + * @page page_iface_org_kde_kwin_server_decoration org_kde_kwin_server_decoration + * @section page_iface_org_kde_kwin_server_decoration_api API + * See @ref iface_org_kde_kwin_server_decoration. + */ +/** + * @defgroup iface_org_kde_kwin_server_decoration The org_kde_kwin_server_decoration interface + */ +extern const struct wl_interface org_kde_kwin_server_decoration_interface; +#endif + +#ifndef ORG_KDE_KWIN_SERVER_DECORATION_MANAGER_MODE_ENUM +#define ORG_KDE_KWIN_SERVER_DECORATION_MANAGER_MODE_ENUM +/** + * @ingroup iface_org_kde_kwin_server_decoration_manager + * Possible values to use in request_mode and the event mode. + */ +enum org_kde_kwin_server_decoration_manager_mode { + /** + * Undecorated: The surface is not decorated at all, neither server nor client-side. An example is a popup surface which should not be decorated. + */ + ORG_KDE_KWIN_SERVER_DECORATION_MANAGER_MODE_NONE = 0, + /** + * Client-side decoration: The decoration is part of the surface and the client. + */ + ORG_KDE_KWIN_SERVER_DECORATION_MANAGER_MODE_CLIENT = 1, + /** + * Server-side decoration: The server embeds the surface into a decoration frame. + */ + ORG_KDE_KWIN_SERVER_DECORATION_MANAGER_MODE_SERVER = 2, +}; +#endif /* ORG_KDE_KWIN_SERVER_DECORATION_MANAGER_MODE_ENUM */ + +/** + * @ingroup iface_org_kde_kwin_server_decoration_manager + * @struct org_kde_kwin_server_decoration_manager_interface + */ +struct org_kde_kwin_server_decoration_manager_interface { + /** + * Create a server-side decoration object for a given surface + * + * When a client creates a server-side decoration object it + * indicates that it supports the protocol. The client is supposed + * to tell the server whether it wants server-side decorations or + * will provide client-side decorations. + * + * If the client does not create a server-side decoration object + * for a surface the server interprets this as lack of support for + * this protocol and considers it as client-side decorated. + * Nevertheless a client-side decorated surface should use this + * protocol to indicate to the server that it does not want a + * server-side deco. + */ + void (*create)(struct wl_client *client, + struct wl_resource *resource, + uint32_t id, + struct wl_resource *surface); +}; + +#define ORG_KDE_KWIN_SERVER_DECORATION_MANAGER_DEFAULT_MODE 0 + +/** + * @ingroup iface_org_kde_kwin_server_decoration_manager + */ +#define ORG_KDE_KWIN_SERVER_DECORATION_MANAGER_DEFAULT_MODE_SINCE_VERSION 1 + +/** + * @ingroup iface_org_kde_kwin_server_decoration_manager + */ +#define ORG_KDE_KWIN_SERVER_DECORATION_MANAGER_CREATE_SINCE_VERSION 1 + +/** + * @ingroup iface_org_kde_kwin_server_decoration_manager + * Sends an default_mode event to the client owning the resource. + * @param resource_ The client's resource + * @param mode The default decoration mode applied to newly created server decorations. + */ +static inline void +org_kde_kwin_server_decoration_manager_send_default_mode(struct wl_resource *resource_, uint32_t mode) +{ + wl_resource_post_event(resource_, ORG_KDE_KWIN_SERVER_DECORATION_MANAGER_DEFAULT_MODE, mode); +} + +#ifndef ORG_KDE_KWIN_SERVER_DECORATION_MODE_ENUM +#define ORG_KDE_KWIN_SERVER_DECORATION_MODE_ENUM +/** + * @ingroup iface_org_kde_kwin_server_decoration + * Possible values to use in request_mode and the event mode. + */ +enum org_kde_kwin_server_decoration_mode { + /** + * Undecorated: The surface is not decorated at all, neither server nor client-side. An example is a popup surface which should not be decorated. + */ + ORG_KDE_KWIN_SERVER_DECORATION_MODE_NONE = 0, + /** + * Client-side decoration: The decoration is part of the surface and the client. + */ + ORG_KDE_KWIN_SERVER_DECORATION_MODE_CLIENT = 1, + /** + * Server-side decoration: The server embeds the surface into a decoration frame. + */ + ORG_KDE_KWIN_SERVER_DECORATION_MODE_SERVER = 2, +}; +#endif /* ORG_KDE_KWIN_SERVER_DECORATION_MODE_ENUM */ + +/** + * @ingroup iface_org_kde_kwin_server_decoration + * @struct org_kde_kwin_server_decoration_interface + */ +struct org_kde_kwin_server_decoration_interface { + /** + * release the server decoration object + * + * + */ + void (*release)(struct wl_client *client, + struct wl_resource *resource); + /** + * The decoration mode the surface wants to use. + * + * + * @param mode The mode this surface wants to use. + */ + void (*request_mode)(struct wl_client *client, + struct wl_resource *resource, + uint32_t mode); +}; + +#define ORG_KDE_KWIN_SERVER_DECORATION_MODE 0 + +/** + * @ingroup iface_org_kde_kwin_server_decoration + */ +#define ORG_KDE_KWIN_SERVER_DECORATION_MODE_SINCE_VERSION 1 + +/** + * @ingroup iface_org_kde_kwin_server_decoration + */ +#define ORG_KDE_KWIN_SERVER_DECORATION_RELEASE_SINCE_VERSION 1 +/** + * @ingroup iface_org_kde_kwin_server_decoration + */ +#define ORG_KDE_KWIN_SERVER_DECORATION_REQUEST_MODE_SINCE_VERSION 1 + +/** + * @ingroup iface_org_kde_kwin_server_decoration + * Sends an mode event to the client owning the resource. + * @param resource_ The client's resource + * @param mode The decoration mode applied to the surface by the server. + */ +static inline void +org_kde_kwin_server_decoration_send_mode(struct wl_resource *resource_, uint32_t mode) +{ + wl_resource_post_event(resource_, ORG_KDE_KWIN_SERVER_DECORATION_MODE, mode); +} + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/include/protocols/wlr-layer-shell-unstable-v1-protocol.h b/include/protocols/wlr-layer-shell-unstable-v1-protocol.h new file mode 100644 index 0000000..0277e39 --- /dev/null +++ b/include/protocols/wlr-layer-shell-unstable-v1-protocol.h @@ -0,0 +1,606 @@ +/* Generated by wayland-scanner 1.20.0 */ + +#ifndef WLR_LAYER_SHELL_UNSTABLE_V1_SERVER_PROTOCOL_H +#define WLR_LAYER_SHELL_UNSTABLE_V1_SERVER_PROTOCOL_H + +#include +#include +#include "wayland-server.h" + +#ifdef __cplusplus +extern "C" { +#endif + +struct wl_client; +struct wl_resource; + +/** + * @page page_wlr_layer_shell_unstable_v1 The wlr_layer_shell_unstable_v1 protocol + * @section page_ifaces_wlr_layer_shell_unstable_v1 Interfaces + * - @subpage page_iface_zwlr_layer_shell_v1 - create surfaces that are layers of the desktop + * - @subpage page_iface_zwlr_layer_surface_v1 - layer metadata interface + * @section page_copyright_wlr_layer_shell_unstable_v1 Copyright + * 
+ *
+ * Copyright © 2017 Drew DeVault
+ *
+ * Permission to use, copy, modify, distribute, and sell this
+ * software and its documentation for any purpose is hereby granted
+ * without fee, provided that the above copyright notice appear in
+ * all copies and that both that copyright notice and this permission
+ * notice appear in supporting documentation, and that the name of
+ * the copyright holders not be used in advertising or publicity
+ * pertaining to distribution of the software without specific,
+ * written prior permission.  The copyright holders make no
+ * representations about the suitability of this software for any
+ * purpose.  It is provided "as is" without express or implied
+ * warranty.
+ *
+ * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
+ * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
+ * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
+ * ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+ * THIS SOFTWARE.
+ *
+ */ +struct wl_output; +struct wl_surface; +struct xdg_popup; +struct zwlr_layer_shell_v1; +struct zwlr_layer_surface_v1; + +#ifndef ZWLR_LAYER_SHELL_V1_INTERFACE +#define ZWLR_LAYER_SHELL_V1_INTERFACE +/** + * @page page_iface_zwlr_layer_shell_v1 zwlr_layer_shell_v1 + * @section page_iface_zwlr_layer_shell_v1_desc Description + * + * Clients can use this interface to assign the surface_layer role to + * wl_surfaces. Such surfaces are assigned to a "layer" of the output and + * rendered with a defined z-depth respective to each other. They may also be + * anchored to the edges and corners of a screen and specify input handling + * semantics. This interface should be suitable for the implementation of + * many desktop shell components, and a broad number of other applications + * that interact with the desktop. + * @section page_iface_zwlr_layer_shell_v1_api API + * See @ref iface_zwlr_layer_shell_v1. + */ +/** + * @defgroup iface_zwlr_layer_shell_v1 The zwlr_layer_shell_v1 interface + * + * Clients can use this interface to assign the surface_layer role to + * wl_surfaces. Such surfaces are assigned to a "layer" of the output and + * rendered with a defined z-depth respective to each other. They may also be + * anchored to the edges and corners of a screen and specify input handling + * semantics. This interface should be suitable for the implementation of + * many desktop shell components, and a broad number of other applications + * that interact with the desktop. + */ +extern const struct wl_interface zwlr_layer_shell_v1_interface; +#endif +#ifndef ZWLR_LAYER_SURFACE_V1_INTERFACE +#define ZWLR_LAYER_SURFACE_V1_INTERFACE +/** + * @page page_iface_zwlr_layer_surface_v1 zwlr_layer_surface_v1 + * @section page_iface_zwlr_layer_surface_v1_desc Description + * + * An interface that may be implemented by a wl_surface, for surfaces that + * are designed to be rendered as a layer of a stacked desktop-like + * environment. + * + * Layer surface state (layer, size, anchor, exclusive zone, + * margin, interactivity) is double-buffered, and will be applied at the + * time wl_surface.commit of the corresponding wl_surface is called. + * + * Attaching a null buffer to a layer surface unmaps it. + * + * Unmapping a layer_surface means that the surface cannot be shown by the + * compositor until it is explicitly mapped again. The layer_surface + * returns to the state it had right after layer_shell.get_layer_surface. + * The client can re-map the surface by performing a commit without any + * buffer attached, waiting for a configure event and handling it as usual. + * @section page_iface_zwlr_layer_surface_v1_api API + * See @ref iface_zwlr_layer_surface_v1. + */ +/** + * @defgroup iface_zwlr_layer_surface_v1 The zwlr_layer_surface_v1 interface + * + * An interface that may be implemented by a wl_surface, for surfaces that + * are designed to be rendered as a layer of a stacked desktop-like + * environment. + * + * Layer surface state (layer, size, anchor, exclusive zone, + * margin, interactivity) is double-buffered, and will be applied at the + * time wl_surface.commit of the corresponding wl_surface is called. + * + * Attaching a null buffer to a layer surface unmaps it. + * + * Unmapping a layer_surface means that the surface cannot be shown by the + * compositor until it is explicitly mapped again. The layer_surface + * returns to the state it had right after layer_shell.get_layer_surface. + * The client can re-map the surface by performing a commit without any + * buffer attached, waiting for a configure event and handling it as usual. + */ +extern const struct wl_interface zwlr_layer_surface_v1_interface; +#endif + +#ifndef ZWLR_LAYER_SHELL_V1_ERROR_ENUM +#define ZWLR_LAYER_SHELL_V1_ERROR_ENUM +enum zwlr_layer_shell_v1_error { + /** + * wl_surface has another role + */ + ZWLR_LAYER_SHELL_V1_ERROR_ROLE = 0, + /** + * layer value is invalid + */ + ZWLR_LAYER_SHELL_V1_ERROR_INVALID_LAYER = 1, + /** + * wl_surface has a buffer attached or committed + */ + ZWLR_LAYER_SHELL_V1_ERROR_ALREADY_CONSTRUCTED = 2, +}; +#endif /* ZWLR_LAYER_SHELL_V1_ERROR_ENUM */ + +#ifndef ZWLR_LAYER_SHELL_V1_LAYER_ENUM +#define ZWLR_LAYER_SHELL_V1_LAYER_ENUM +/** + * @ingroup iface_zwlr_layer_shell_v1 + * available layers for surfaces + * + * These values indicate which layers a surface can be rendered in. They + * are ordered by z depth, bottom-most first. Traditional shell surfaces + * will typically be rendered between the bottom and top layers. + * Fullscreen shell surfaces are typically rendered at the top layer. + * Multiple surfaces can share a single layer, and ordering within a + * single layer is undefined. + */ +enum zwlr_layer_shell_v1_layer { + ZWLR_LAYER_SHELL_V1_LAYER_BACKGROUND = 0, + ZWLR_LAYER_SHELL_V1_LAYER_BOTTOM = 1, + ZWLR_LAYER_SHELL_V1_LAYER_TOP = 2, + ZWLR_LAYER_SHELL_V1_LAYER_OVERLAY = 3, +}; +#endif /* ZWLR_LAYER_SHELL_V1_LAYER_ENUM */ + +/** + * @ingroup iface_zwlr_layer_shell_v1 + * @struct zwlr_layer_shell_v1_interface + */ +struct zwlr_layer_shell_v1_interface { + /** + * create a layer_surface from a surface + * + * Create a layer surface for an existing surface. This assigns + * the role of layer_surface, or raises a protocol error if another + * role is already assigned. + * + * Creating a layer surface from a wl_surface which has a buffer + * attached or committed is a client error, and any attempts by a + * client to attach or manipulate a buffer prior to the first + * layer_surface.configure call must also be treated as errors. + * + * After creating a layer_surface object and setting it up, the + * client must perform an initial commit without any buffer + * attached. The compositor will reply with a + * layer_surface.configure event. The client must acknowledge it + * and is then allowed to attach a buffer to map the surface. + * + * You may pass NULL for output to allow the compositor to decide + * which output to use. Generally this will be the one that the + * user most recently interacted with. + * + * Clients can specify a namespace that defines the purpose of the + * layer surface. + * @param layer layer to add this surface to + * @param namespace namespace for the layer surface + */ + void (*get_layer_surface)(struct wl_client *client, + struct wl_resource *resource, + uint32_t id, + struct wl_resource *surface, + struct wl_resource *output, + uint32_t layer, + const char *namespace); + /** + * destroy the layer_shell object + * + * This request indicates that the client will not use the + * layer_shell object any more. Objects that have been created + * through this instance are not affected. + * @since 3 + */ + void (*destroy)(struct wl_client *client, + struct wl_resource *resource); +}; + + +/** + * @ingroup iface_zwlr_layer_shell_v1 + */ +#define ZWLR_LAYER_SHELL_V1_GET_LAYER_SURFACE_SINCE_VERSION 1 +/** + * @ingroup iface_zwlr_layer_shell_v1 + */ +#define ZWLR_LAYER_SHELL_V1_DESTROY_SINCE_VERSION 3 + +#ifndef ZWLR_LAYER_SURFACE_V1_KEYBOARD_INTERACTIVITY_ENUM +#define ZWLR_LAYER_SURFACE_V1_KEYBOARD_INTERACTIVITY_ENUM +/** + * @ingroup iface_zwlr_layer_surface_v1 + * types of keyboard interaction possible for a layer shell surface + * + * Types of keyboard interaction possible for layer shell surfaces. The + * rationale for this is twofold: (1) some applications are not interested + * in keyboard events and not allowing them to be focused can improve the + * desktop experience; (2) some applications will want to take exclusive + * keyboard focus. + */ +enum zwlr_layer_surface_v1_keyboard_interactivity { + /** + * no keyboard focus is possible + * + * This value indicates that this surface is not interested in + * keyboard events and the compositor should never assign it the + * keyboard focus. + * + * This is the default value, set for newly created layer shell + * surfaces. + * + * This is useful for e.g. desktop widgets that display information + * or only have interaction with non-keyboard input devices. + */ + ZWLR_LAYER_SURFACE_V1_KEYBOARD_INTERACTIVITY_NONE = 0, + /** + * request exclusive keyboard focus + * + * Request exclusive keyboard focus if this surface is above the + * shell surface layer. + * + * For the top and overlay layers, the seat will always give + * exclusive keyboard focus to the top-most layer which has + * keyboard interactivity set to exclusive. If this layer contains + * multiple surfaces with keyboard interactivity set to exclusive, + * the compositor determines the one receiving keyboard events in + * an implementation- defined manner. In this case, no guarantee is + * made when this surface will receive keyboard focus (if ever). + * + * For the bottom and background layers, the compositor is allowed + * to use normal focus semantics. + * + * This setting is mainly intended for applications that need to + * ensure they receive all keyboard events, such as a lock screen + * or a password prompt. + */ + ZWLR_LAYER_SURFACE_V1_KEYBOARD_INTERACTIVITY_EXCLUSIVE = 1, + /** + * request regular keyboard focus semantics + * + * This requests the compositor to allow this surface to be + * focused and unfocused by the user in an implementation-defined + * manner. The user should be able to unfocus this surface even + * regardless of the layer it is on. + * + * Typically, the compositor will want to use its normal mechanism + * to manage keyboard focus between layer shell surfaces with this + * setting and regular toplevels on the desktop layer (e.g. click + * to focus). Nevertheless, it is possible for a compositor to + * require a special interaction to focus or unfocus layer shell + * surfaces (e.g. requiring a click even if focus follows the mouse + * normally, or providing a keybinding to switch focus between + * layers). + * + * This setting is mainly intended for desktop shell components + * (e.g. panels) that allow keyboard interaction. Using this option + * can allow implementing a desktop shell that can be fully usable + * without the mouse. + * @since 4 + */ + ZWLR_LAYER_SURFACE_V1_KEYBOARD_INTERACTIVITY_ON_DEMAND = 2, +}; +/** + * @ingroup iface_zwlr_layer_surface_v1 + */ +#define ZWLR_LAYER_SURFACE_V1_KEYBOARD_INTERACTIVITY_ON_DEMAND_SINCE_VERSION 4 +#endif /* ZWLR_LAYER_SURFACE_V1_KEYBOARD_INTERACTIVITY_ENUM */ + +#ifndef ZWLR_LAYER_SURFACE_V1_ERROR_ENUM +#define ZWLR_LAYER_SURFACE_V1_ERROR_ENUM +enum zwlr_layer_surface_v1_error { + /** + * provided surface state is invalid + */ + ZWLR_LAYER_SURFACE_V1_ERROR_INVALID_SURFACE_STATE = 0, + /** + * size is invalid + */ + ZWLR_LAYER_SURFACE_V1_ERROR_INVALID_SIZE = 1, + /** + * anchor bitfield is invalid + */ + ZWLR_LAYER_SURFACE_V1_ERROR_INVALID_ANCHOR = 2, + /** + * keyboard interactivity is invalid + */ + ZWLR_LAYER_SURFACE_V1_ERROR_INVALID_KEYBOARD_INTERACTIVITY = 3, +}; +#endif /* ZWLR_LAYER_SURFACE_V1_ERROR_ENUM */ + +#ifndef ZWLR_LAYER_SURFACE_V1_ANCHOR_ENUM +#define ZWLR_LAYER_SURFACE_V1_ANCHOR_ENUM +enum zwlr_layer_surface_v1_anchor { + /** + * the top edge of the anchor rectangle + */ + ZWLR_LAYER_SURFACE_V1_ANCHOR_TOP = 1, + /** + * the bottom edge of the anchor rectangle + */ + ZWLR_LAYER_SURFACE_V1_ANCHOR_BOTTOM = 2, + /** + * the left edge of the anchor rectangle + */ + ZWLR_LAYER_SURFACE_V1_ANCHOR_LEFT = 4, + /** + * the right edge of the anchor rectangle + */ + ZWLR_LAYER_SURFACE_V1_ANCHOR_RIGHT = 8, +}; +#endif /* ZWLR_LAYER_SURFACE_V1_ANCHOR_ENUM */ + +/** + * @ingroup iface_zwlr_layer_surface_v1 + * @struct zwlr_layer_surface_v1_interface + */ +struct zwlr_layer_surface_v1_interface { + /** + * sets the size of the surface + * + * Sets the size of the surface in surface-local coordinates. The + * compositor will display the surface centered with respect to its + * anchors. + * + * If you pass 0 for either value, the compositor will assign it + * and inform you of the assignment in the configure event. You + * must set your anchor to opposite edges in the dimensions you + * omit; not doing so is a protocol error. Both values are 0 by + * default. + * + * Size is double-buffered, see wl_surface.commit. + */ + void (*set_size)(struct wl_client *client, + struct wl_resource *resource, + uint32_t width, + uint32_t height); + /** + * configures the anchor point of the surface + * + * Requests that the compositor anchor the surface to the + * specified edges and corners. If two orthogonal edges are + * specified (e.g. 'top' and 'left'), then the anchor point will be + * the intersection of the edges (e.g. the top left corner of the + * output); otherwise the anchor point will be centered on that + * edge, or in the center if none is specified. + * + * Anchor is double-buffered, see wl_surface.commit. + */ + void (*set_anchor)(struct wl_client *client, + struct wl_resource *resource, + uint32_t anchor); + /** + * configures the exclusive geometry of this surface + * + * Requests that the compositor avoids occluding an area with + * other surfaces. The compositor's use of this information is + * implementation-dependent - do not assume that this region will + * not actually be occluded. + * + * A positive value is only meaningful if the surface is anchored + * to one edge or an edge and both perpendicular edges. If the + * surface is not anchored, anchored to only two perpendicular + * edges (a corner), anchored to only two parallel edges or + * anchored to all edges, a positive value will be treated the same + * as zero. + * + * A positive zone is the distance from the edge in surface-local + * coordinates to consider exclusive. + * + * Surfaces that do not wish to have an exclusive zone may instead + * specify how they should interact with surfaces that do. If set + * to zero, the surface indicates that it would like to be moved to + * avoid occluding surfaces with a positive exclusive zone. If set + * to -1, the surface indicates that it would not like to be moved + * to accommodate for other surfaces, and the compositor should + * extend it all the way to the edges it is anchored to. + * + * For example, a panel might set its exclusive zone to 10, so that + * maximized shell surfaces are not shown on top of it. A + * notification might set its exclusive zone to 0, so that it is + * moved to avoid occluding the panel, but shell surfaces are shown + * underneath it. A wallpaper or lock screen might set their + * exclusive zone to -1, so that they stretch below or over the + * panel. + * + * The default value is 0. + * + * Exclusive zone is double-buffered, see wl_surface.commit. + */ + void (*set_exclusive_zone)(struct wl_client *client, + struct wl_resource *resource, + int32_t zone); + /** + * sets a margin from the anchor point + * + * Requests that the surface be placed some distance away from + * the anchor point on the output, in surface-local coordinates. + * Setting this value for edges you are not anchored to has no + * effect. + * + * The exclusive zone includes the margin. + * + * Margin is double-buffered, see wl_surface.commit. + */ + void (*set_margin)(struct wl_client *client, + struct wl_resource *resource, + int32_t top, + int32_t right, + int32_t bottom, + int32_t left); + /** + * requests keyboard events + * + * Set how keyboard events are delivered to this surface. By + * default, layer shell surfaces do not receive keyboard events; + * this request can be used to change this. + * + * This setting is inherited by child surfaces set by the get_popup + * request. + * + * Layer surfaces receive pointer, touch, and tablet events + * normally. If you do not want to receive them, set the input + * region on your surface to an empty region. + * + * Keyboard interactivity is double-buffered, see + * wl_surface.commit. + */ + void (*set_keyboard_interactivity)(struct wl_client *client, + struct wl_resource *resource, + uint32_t keyboard_interactivity); + /** + * assign this layer_surface as an xdg_popup parent + * + * This assigns an xdg_popup's parent to this layer_surface. This + * popup should have been created via xdg_surface::get_popup with + * the parent set to NULL, and this request must be invoked before + * committing the popup's initial state. + * + * See the documentation of xdg_popup for more details about what + * an xdg_popup is and how it is used. + */ + void (*get_popup)(struct wl_client *client, + struct wl_resource *resource, + struct wl_resource *popup); + /** + * ack a configure event + * + * When a configure event is received, if a client commits the + * surface in response to the configure event, then the client must + * make an ack_configure request sometime before the commit + * request, passing along the serial of the configure event. + * + * If the client receives multiple configure events before it can + * respond to one, it only has to ack the last configure event. + * + * A client is not required to commit immediately after sending an + * ack_configure request - it may even ack_configure several times + * before its next surface commit. + * + * A client may send multiple ack_configure requests before + * committing, but only the last request sent before a commit + * indicates which configure event the client really is responding + * to. + * @param serial the serial from the configure event + */ + void (*ack_configure)(struct wl_client *client, + struct wl_resource *resource, + uint32_t serial); + /** + * destroy the layer_surface + * + * This request destroys the layer surface. + */ + void (*destroy)(struct wl_client *client, + struct wl_resource *resource); + /** + * change the layer of the surface + * + * Change the layer that the surface is rendered on. + * + * Layer is double-buffered, see wl_surface.commit. + * @param layer layer to move this surface to + * @since 2 + */ + void (*set_layer)(struct wl_client *client, + struct wl_resource *resource, + uint32_t layer); +}; + +#define ZWLR_LAYER_SURFACE_V1_CONFIGURE 0 +#define ZWLR_LAYER_SURFACE_V1_CLOSED 1 + +/** + * @ingroup iface_zwlr_layer_surface_v1 + */ +#define ZWLR_LAYER_SURFACE_V1_CONFIGURE_SINCE_VERSION 1 +/** + * @ingroup iface_zwlr_layer_surface_v1 + */ +#define ZWLR_LAYER_SURFACE_V1_CLOSED_SINCE_VERSION 1 + +/** + * @ingroup iface_zwlr_layer_surface_v1 + */ +#define ZWLR_LAYER_SURFACE_V1_SET_SIZE_SINCE_VERSION 1 +/** + * @ingroup iface_zwlr_layer_surface_v1 + */ +#define ZWLR_LAYER_SURFACE_V1_SET_ANCHOR_SINCE_VERSION 1 +/** + * @ingroup iface_zwlr_layer_surface_v1 + */ +#define ZWLR_LAYER_SURFACE_V1_SET_EXCLUSIVE_ZONE_SINCE_VERSION 1 +/** + * @ingroup iface_zwlr_layer_surface_v1 + */ +#define ZWLR_LAYER_SURFACE_V1_SET_MARGIN_SINCE_VERSION 1 +/** + * @ingroup iface_zwlr_layer_surface_v1 + */ +#define ZWLR_LAYER_SURFACE_V1_SET_KEYBOARD_INTERACTIVITY_SINCE_VERSION 1 +/** + * @ingroup iface_zwlr_layer_surface_v1 + */ +#define ZWLR_LAYER_SURFACE_V1_GET_POPUP_SINCE_VERSION 1 +/** + * @ingroup iface_zwlr_layer_surface_v1 + */ +#define ZWLR_LAYER_SURFACE_V1_ACK_CONFIGURE_SINCE_VERSION 1 +/** + * @ingroup iface_zwlr_layer_surface_v1 + */ +#define ZWLR_LAYER_SURFACE_V1_DESTROY_SINCE_VERSION 1 +/** + * @ingroup iface_zwlr_layer_surface_v1 + */ +#define ZWLR_LAYER_SURFACE_V1_SET_LAYER_SINCE_VERSION 2 + +/** + * @ingroup iface_zwlr_layer_surface_v1 + * Sends an configure event to the client owning the resource. + * @param resource_ The client's resource + */ +static inline void +zwlr_layer_surface_v1_send_configure(struct wl_resource *resource_, uint32_t serial, uint32_t width, uint32_t height) +{ + wl_resource_post_event(resource_, ZWLR_LAYER_SURFACE_V1_CONFIGURE, serial, width, height); +} + +/** + * @ingroup iface_zwlr_layer_surface_v1 + * Sends an closed event to the client owning the resource. + * @param resource_ The client's resource + */ +static inline void +zwlr_layer_surface_v1_send_closed(struct wl_resource *resource_) +{ + wl_resource_post_event(resource_, ZWLR_LAYER_SURFACE_V1_CLOSED); +} + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/include/protocols/wlr-screencopy-unstable-v1-protocol.h b/include/protocols/wlr-screencopy-unstable-v1-protocol.h new file mode 100644 index 0000000..fd5d5ab --- /dev/null +++ b/include/protocols/wlr-screencopy-unstable-v1-protocol.h @@ -0,0 +1,403 @@ +/* Generated by wayland-scanner 1.20.0 */ + +#ifndef WLR_SCREENCOPY_UNSTABLE_V1_SERVER_PROTOCOL_H +#define WLR_SCREENCOPY_UNSTABLE_V1_SERVER_PROTOCOL_H + +#include +#include +#include "wayland-server.h" + +#ifdef __cplusplus +extern "C" { +#endif + +struct wl_client; +struct wl_resource; + +/** + * @page page_wlr_screencopy_unstable_v1 The wlr_screencopy_unstable_v1 protocol + * screen content capturing on client buffers + * + * @section page_desc_wlr_screencopy_unstable_v1 Description + * + * This protocol allows clients to ask the compositor to copy part of the + * screen content to a client buffer. + * + * Warning! The protocol described in this file is experimental and + * backward incompatible changes may be made. Backward compatible changes + * may be added together with the corresponding interface version bump. + * Backward incompatible changes are done by bumping the version number in + * the protocol and interface names and resetting the interface version. + * Once the protocol is to be declared stable, the 'z' prefix and the + * version number in the protocol and interface names are removed and the + * interface version number is reset. + * + * @section page_ifaces_wlr_screencopy_unstable_v1 Interfaces + * - @subpage page_iface_zwlr_screencopy_manager_v1 - manager to inform clients and begin capturing + * - @subpage page_iface_zwlr_screencopy_frame_v1 - a frame ready for copy + * @section page_copyright_wlr_screencopy_unstable_v1 Copyright + * 
+ *
+ * Copyright © 2018 Simon Ser
+ * Copyright © 2019 Andri Yngvason
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the next
+ * paragraph) shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ *
+ */ +struct wl_buffer; +struct wl_output; +struct zwlr_screencopy_frame_v1; +struct zwlr_screencopy_manager_v1; + +#ifndef ZWLR_SCREENCOPY_MANAGER_V1_INTERFACE +#define ZWLR_SCREENCOPY_MANAGER_V1_INTERFACE +/** + * @page page_iface_zwlr_screencopy_manager_v1 zwlr_screencopy_manager_v1 + * @section page_iface_zwlr_screencopy_manager_v1_desc Description + * + * This object is a manager which offers requests to start capturing from a + * source. + * @section page_iface_zwlr_screencopy_manager_v1_api API + * See @ref iface_zwlr_screencopy_manager_v1. + */ +/** + * @defgroup iface_zwlr_screencopy_manager_v1 The zwlr_screencopy_manager_v1 interface + * + * This object is a manager which offers requests to start capturing from a + * source. + */ +extern const struct wl_interface zwlr_screencopy_manager_v1_interface; +#endif +#ifndef ZWLR_SCREENCOPY_FRAME_V1_INTERFACE +#define ZWLR_SCREENCOPY_FRAME_V1_INTERFACE +/** + * @page page_iface_zwlr_screencopy_frame_v1 zwlr_screencopy_frame_v1 + * @section page_iface_zwlr_screencopy_frame_v1_desc Description + * + * This object represents a single frame. + * + * When created, a series of buffer events will be sent, each representing a + * supported buffer type. The "buffer_done" event is sent afterwards to + * indicate that all supported buffer types have been enumerated. The client + * will then be able to send a "copy" request. If the capture is successful, + * the compositor will send a "flags" followed by a "ready" event. + * + * For objects version 2 or lower, wl_shm buffers are always supported, ie. + * the "buffer" event is guaranteed to be sent. + * + * If the capture failed, the "failed" event is sent. This can happen anytime + * before the "ready" event. + * + * Once either a "ready" or a "failed" event is received, the client should + * destroy the frame. + * @section page_iface_zwlr_screencopy_frame_v1_api API + * See @ref iface_zwlr_screencopy_frame_v1. + */ +/** + * @defgroup iface_zwlr_screencopy_frame_v1 The zwlr_screencopy_frame_v1 interface + * + * This object represents a single frame. + * + * When created, a series of buffer events will be sent, each representing a + * supported buffer type. The "buffer_done" event is sent afterwards to + * indicate that all supported buffer types have been enumerated. The client + * will then be able to send a "copy" request. If the capture is successful, + * the compositor will send a "flags" followed by a "ready" event. + * + * For objects version 2 or lower, wl_shm buffers are always supported, ie. + * the "buffer" event is guaranteed to be sent. + * + * If the capture failed, the "failed" event is sent. This can happen anytime + * before the "ready" event. + * + * Once either a "ready" or a "failed" event is received, the client should + * destroy the frame. + */ +extern const struct wl_interface zwlr_screencopy_frame_v1_interface; +#endif + +/** + * @ingroup iface_zwlr_screencopy_manager_v1 + * @struct zwlr_screencopy_manager_v1_interface + */ +struct zwlr_screencopy_manager_v1_interface { + /** + * capture an output + * + * Capture the next frame of an entire output. + * @param overlay_cursor composite cursor onto the frame + */ + void (*capture_output)(struct wl_client *client, + struct wl_resource *resource, + uint32_t frame, + int32_t overlay_cursor, + struct wl_resource *output); + /** + * capture an output's region + * + * Capture the next frame of an output's region. + * + * The region is given in output logical coordinates, see + * xdg_output.logical_size. The region will be clipped to the + * output's extents. + * @param overlay_cursor composite cursor onto the frame + */ + void (*capture_output_region)(struct wl_client *client, + struct wl_resource *resource, + uint32_t frame, + int32_t overlay_cursor, + struct wl_resource *output, + int32_t x, + int32_t y, + int32_t width, + int32_t height); + /** + * destroy the manager + * + * All objects created by the manager will still remain valid, + * until their appropriate destroy request has been called. + */ + void (*destroy)(struct wl_client *client, + struct wl_resource *resource); +}; + + +/** + * @ingroup iface_zwlr_screencopy_manager_v1 + */ +#define ZWLR_SCREENCOPY_MANAGER_V1_CAPTURE_OUTPUT_SINCE_VERSION 1 +/** + * @ingroup iface_zwlr_screencopy_manager_v1 + */ +#define ZWLR_SCREENCOPY_MANAGER_V1_CAPTURE_OUTPUT_REGION_SINCE_VERSION 1 +/** + * @ingroup iface_zwlr_screencopy_manager_v1 + */ +#define ZWLR_SCREENCOPY_MANAGER_V1_DESTROY_SINCE_VERSION 1 + +#ifndef ZWLR_SCREENCOPY_FRAME_V1_ERROR_ENUM +#define ZWLR_SCREENCOPY_FRAME_V1_ERROR_ENUM +enum zwlr_screencopy_frame_v1_error { + /** + * the object has already been used to copy a wl_buffer + */ + ZWLR_SCREENCOPY_FRAME_V1_ERROR_ALREADY_USED = 0, + /** + * buffer attributes are invalid + */ + ZWLR_SCREENCOPY_FRAME_V1_ERROR_INVALID_BUFFER = 1, +}; +#endif /* ZWLR_SCREENCOPY_FRAME_V1_ERROR_ENUM */ + +#ifndef ZWLR_SCREENCOPY_FRAME_V1_FLAGS_ENUM +#define ZWLR_SCREENCOPY_FRAME_V1_FLAGS_ENUM +enum zwlr_screencopy_frame_v1_flags { + /** + * contents are y-inverted + */ + ZWLR_SCREENCOPY_FRAME_V1_FLAGS_Y_INVERT = 1, +}; +#endif /* ZWLR_SCREENCOPY_FRAME_V1_FLAGS_ENUM */ + +/** + * @ingroup iface_zwlr_screencopy_frame_v1 + * @struct zwlr_screencopy_frame_v1_interface + */ +struct zwlr_screencopy_frame_v1_interface { + /** + * copy the frame + * + * Copy the frame to the supplied buffer. The buffer must have a + * the correct size, see zwlr_screencopy_frame_v1.buffer and + * zwlr_screencopy_frame_v1.linux_dmabuf. The buffer needs to have + * a supported format. + * + * If the frame is successfully copied, a "flags" and a "ready" + * events are sent. Otherwise, a "failed" event is sent. + */ + void (*copy)(struct wl_client *client, + struct wl_resource *resource, + struct wl_resource *buffer); + /** + * delete this object, used or not + * + * Destroys the frame. This request can be sent at any time by + * the client. + */ + void (*destroy)(struct wl_client *client, + struct wl_resource *resource); + /** + * copy the frame when it's damaged + * + * Same as copy, except it waits until there is damage to copy. + * @since 2 + */ + void (*copy_with_damage)(struct wl_client *client, + struct wl_resource *resource, + struct wl_resource *buffer); +}; + +#define ZWLR_SCREENCOPY_FRAME_V1_BUFFER 0 +#define ZWLR_SCREENCOPY_FRAME_V1_FLAGS 1 +#define ZWLR_SCREENCOPY_FRAME_V1_READY 2 +#define ZWLR_SCREENCOPY_FRAME_V1_FAILED 3 +#define ZWLR_SCREENCOPY_FRAME_V1_DAMAGE 4 +#define ZWLR_SCREENCOPY_FRAME_V1_LINUX_DMABUF 5 +#define ZWLR_SCREENCOPY_FRAME_V1_BUFFER_DONE 6 + +/** + * @ingroup iface_zwlr_screencopy_frame_v1 + */ +#define ZWLR_SCREENCOPY_FRAME_V1_BUFFER_SINCE_VERSION 1 +/** + * @ingroup iface_zwlr_screencopy_frame_v1 + */ +#define ZWLR_SCREENCOPY_FRAME_V1_FLAGS_SINCE_VERSION 1 +/** + * @ingroup iface_zwlr_screencopy_frame_v1 + */ +#define ZWLR_SCREENCOPY_FRAME_V1_READY_SINCE_VERSION 1 +/** + * @ingroup iface_zwlr_screencopy_frame_v1 + */ +#define ZWLR_SCREENCOPY_FRAME_V1_FAILED_SINCE_VERSION 1 +/** + * @ingroup iface_zwlr_screencopy_frame_v1 + */ +#define ZWLR_SCREENCOPY_FRAME_V1_DAMAGE_SINCE_VERSION 2 +/** + * @ingroup iface_zwlr_screencopy_frame_v1 + */ +#define ZWLR_SCREENCOPY_FRAME_V1_LINUX_DMABUF_SINCE_VERSION 3 +/** + * @ingroup iface_zwlr_screencopy_frame_v1 + */ +#define ZWLR_SCREENCOPY_FRAME_V1_BUFFER_DONE_SINCE_VERSION 3 + +/** + * @ingroup iface_zwlr_screencopy_frame_v1 + */ +#define ZWLR_SCREENCOPY_FRAME_V1_COPY_SINCE_VERSION 1 +/** + * @ingroup iface_zwlr_screencopy_frame_v1 + */ +#define ZWLR_SCREENCOPY_FRAME_V1_DESTROY_SINCE_VERSION 1 +/** + * @ingroup iface_zwlr_screencopy_frame_v1 + */ +#define ZWLR_SCREENCOPY_FRAME_V1_COPY_WITH_DAMAGE_SINCE_VERSION 2 + +/** + * @ingroup iface_zwlr_screencopy_frame_v1 + * Sends an buffer event to the client owning the resource. + * @param resource_ The client's resource + * @param format buffer format + * @param width buffer width + * @param height buffer height + * @param stride buffer stride + */ +static inline void +zwlr_screencopy_frame_v1_send_buffer(struct wl_resource *resource_, uint32_t format, uint32_t width, uint32_t height, uint32_t stride) +{ + wl_resource_post_event(resource_, ZWLR_SCREENCOPY_FRAME_V1_BUFFER, format, width, height, stride); +} + +/** + * @ingroup iface_zwlr_screencopy_frame_v1 + * Sends an flags event to the client owning the resource. + * @param resource_ The client's resource + * @param flags frame flags + */ +static inline void +zwlr_screencopy_frame_v1_send_flags(struct wl_resource *resource_, uint32_t flags) +{ + wl_resource_post_event(resource_, ZWLR_SCREENCOPY_FRAME_V1_FLAGS, flags); +} + +/** + * @ingroup iface_zwlr_screencopy_frame_v1 + * Sends an ready event to the client owning the resource. + * @param resource_ The client's resource + * @param tv_sec_hi high 32 bits of the seconds part of the timestamp + * @param tv_sec_lo low 32 bits of the seconds part of the timestamp + * @param tv_nsec nanoseconds part of the timestamp + */ +static inline void +zwlr_screencopy_frame_v1_send_ready(struct wl_resource *resource_, uint32_t tv_sec_hi, uint32_t tv_sec_lo, uint32_t tv_nsec) +{ + wl_resource_post_event(resource_, ZWLR_SCREENCOPY_FRAME_V1_READY, tv_sec_hi, tv_sec_lo, tv_nsec); +} + +/** + * @ingroup iface_zwlr_screencopy_frame_v1 + * Sends an failed event to the client owning the resource. + * @param resource_ The client's resource + */ +static inline void +zwlr_screencopy_frame_v1_send_failed(struct wl_resource *resource_) +{ + wl_resource_post_event(resource_, ZWLR_SCREENCOPY_FRAME_V1_FAILED); +} + +/** + * @ingroup iface_zwlr_screencopy_frame_v1 + * Sends an damage event to the client owning the resource. + * @param resource_ The client's resource + * @param x damaged x coordinates + * @param y damaged y coordinates + * @param width current width + * @param height current height + */ +static inline void +zwlr_screencopy_frame_v1_send_damage(struct wl_resource *resource_, uint32_t x, uint32_t y, uint32_t width, uint32_t height) +{ + wl_resource_post_event(resource_, ZWLR_SCREENCOPY_FRAME_V1_DAMAGE, x, y, width, height); +} + +/** + * @ingroup iface_zwlr_screencopy_frame_v1 + * Sends an linux_dmabuf event to the client owning the resource. + * @param resource_ The client's resource + * @param format fourcc pixel format + * @param width buffer width + * @param height buffer height + */ +static inline void +zwlr_screencopy_frame_v1_send_linux_dmabuf(struct wl_resource *resource_, uint32_t format, uint32_t width, uint32_t height) +{ + wl_resource_post_event(resource_, ZWLR_SCREENCOPY_FRAME_V1_LINUX_DMABUF, format, width, height); +} + +/** + * @ingroup iface_zwlr_screencopy_frame_v1 + * Sends an buffer_done event to the client owning the resource. + * @param resource_ The client's resource + */ +static inline void +zwlr_screencopy_frame_v1_send_buffer_done(struct wl_resource *resource_) +{ + wl_resource_post_event(resource_, ZWLR_SCREENCOPY_FRAME_V1_BUFFER_DONE); +} + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/meson.build b/meson.build index f981ee8..68fa833 100644 --- a/meson.build +++ b/meson.build @@ -25,11 +25,6 @@ dep_wayland_cursor = dependency('wayland-cursor', required : true) dep_wayland_egl = dependency('wayland-egl', required : true) dep_wayland_protocols = dependency('wayland-protocols', required : true) -dep_libdev = dep_libudev -if dep_libevdev.found() - dep_libdev = dep_libevdev -endif - ### Include dirs inc_default = include_directories('include') inc_protocols = include_directories('include/protocols') diff --git a/protocols/idle.xml b/protocols/idle.xml new file mode 100644 index 0000000..0737e7d --- /dev/null +++ b/protocols/idle.xml @@ -0,0 +1,49 @@ + + + . + ]]> + + + This interface allows to monitor user idle time on a given seat. The interface + allows to register timers which trigger after no user activity was registered + on the seat for a given interval. It notifies when user activity resumes. + + This is useful for applications wanting to perform actions when the user is not + interacting with the system, e.g. chat applications setting the user as away, power + management features to dim screen, etc.. + + + + + + + + + + + + + + + + + + + + + + diff --git a/protocols/server-decoration.xml b/protocols/server-decoration.xml new file mode 100644 index 0000000..f6403ac --- /dev/null +++ b/protocols/server-decoration.xml @@ -0,0 +1,94 @@ + + + . + ]]> + + + This interface allows to coordinate whether the server should create + a server-side window decoration around a wl_surface representing a + shell surface (wl_shell_surface or similar). By announcing support + for this interface the server indicates that it supports server + side decorations. + + + + When a client creates a server-side decoration object it indicates + that it supports the protocol. The client is supposed to tell the + server whether it wants server-side decorations or will provide + client-side decorations. + + If the client does not create a server-side decoration object for + a surface the server interprets this as lack of support for this + protocol and considers it as client-side decorated. Nevertheless a + client-side decorated surface should use this protocol to indicate + to the server that it does not want a server-side deco. + + + + + + + + + + + + + This event is emitted directly after binding the interface. It contains + the default mode for the decoration. When a new server decoration object + is created this new object will be in the default mode until the first + request_mode is requested. + + The server may change the default mode at any time. + + + + + + + + + + + + + + + + + + + + + This event is emitted directly after the decoration is created and + represents the base decoration policy by the server. E.g. a server + which wants all surfaces to be client-side decorated will send Client, + a server which wants server-side decoration will send Server. + + The client can request a different mode through the decoration request. + The server will acknowledge this by another event with the same mode. So + even if a server prefers server-side decoration it's possible to force a + client-side decoration. + + The server may emit this event at any time. In this case the client can + again request a different mode. It's the responsibility of the server to + prevent a feedback loop. + + + + + diff --git a/protocols/wlr-layer-shell-unstable-v1.xml b/protocols/wlr-layer-shell-unstable-v1.xml new file mode 100644 index 0000000..6b91ae5 --- /dev/null +++ b/protocols/wlr-layer-shell-unstable-v1.xml @@ -0,0 +1,390 @@ + + + + Copyright © 2017 Drew DeVault + + Permission to use, copy, modify, distribute, and sell this + software and its documentation for any purpose is hereby granted + without fee, provided that the above copyright notice appear in + all copies and that both that copyright notice and this permission + notice appear in supporting documentation, and that the name of + the copyright holders not be used in advertising or publicity + pertaining to distribution of the software without specific, + written prior permission. The copyright holders make no + representations about the suitability of this software for any + purpose. It is provided "as is" without express or implied + warranty. + + THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS + SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND + FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY + SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN + AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, + ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF + THIS SOFTWARE. + + + + + Clients can use this interface to assign the surface_layer role to + wl_surfaces. Such surfaces are assigned to a "layer" of the output and + rendered with a defined z-depth respective to each other. They may also be + anchored to the edges and corners of a screen and specify input handling + semantics. This interface should be suitable for the implementation of + many desktop shell components, and a broad number of other applications + that interact with the desktop. + + + + + Create a layer surface for an existing surface. This assigns the role of + layer_surface, or raises a protocol error if another role is already + assigned. + + Creating a layer surface from a wl_surface which has a buffer attached + or committed is a client error, and any attempts by a client to attach + or manipulate a buffer prior to the first layer_surface.configure call + must also be treated as errors. + + After creating a layer_surface object and setting it up, the client + must perform an initial commit without any buffer attached. + The compositor will reply with a layer_surface.configure event. + The client must acknowledge it and is then allowed to attach a buffer + to map the surface. + + You may pass NULL for output to allow the compositor to decide which + output to use. Generally this will be the one that the user most + recently interacted with. + + Clients can specify a namespace that defines the purpose of the layer + surface. + + + + + + + + + + + + + + + + + These values indicate which layers a surface can be rendered in. They + are ordered by z depth, bottom-most first. Traditional shell surfaces + will typically be rendered between the bottom and top layers. + Fullscreen shell surfaces are typically rendered at the top layer. + Multiple surfaces can share a single layer, and ordering within a + single layer is undefined. + + + + + + + + + + + + + This request indicates that the client will not use the layer_shell + object any more. Objects that have been created through this instance + are not affected. + + + + + + + An interface that may be implemented by a wl_surface, for surfaces that + are designed to be rendered as a layer of a stacked desktop-like + environment. + + Layer surface state (layer, size, anchor, exclusive zone, + margin, interactivity) is double-buffered, and will be applied at the + time wl_surface.commit of the corresponding wl_surface is called. + + Attaching a null buffer to a layer surface unmaps it. + + Unmapping a layer_surface means that the surface cannot be shown by the + compositor until it is explicitly mapped again. The layer_surface + returns to the state it had right after layer_shell.get_layer_surface. + The client can re-map the surface by performing a commit without any + buffer attached, waiting for a configure event and handling it as usual. + + + + + Sets the size of the surface in surface-local coordinates. The + compositor will display the surface centered with respect to its + anchors. + + If you pass 0 for either value, the compositor will assign it and + inform you of the assignment in the configure event. You must set your + anchor to opposite edges in the dimensions you omit; not doing so is a + protocol error. Both values are 0 by default. + + Size is double-buffered, see wl_surface.commit. + + + + + + + + Requests that the compositor anchor the surface to the specified edges + and corners. If two orthogonal edges are specified (e.g. 'top' and + 'left'), then the anchor point will be the intersection of the edges + (e.g. the top left corner of the output); otherwise the anchor point + will be centered on that edge, or in the center if none is specified. + + Anchor is double-buffered, see wl_surface.commit. + + + + + + + Requests that the compositor avoids occluding an area with other + surfaces. The compositor's use of this information is + implementation-dependent - do not assume that this region will not + actually be occluded. + + A positive value is only meaningful if the surface is anchored to one + edge or an edge and both perpendicular edges. If the surface is not + anchored, anchored to only two perpendicular edges (a corner), anchored + to only two parallel edges or anchored to all edges, a positive value + will be treated the same as zero. + + A positive zone is the distance from the edge in surface-local + coordinates to consider exclusive. + + Surfaces that do not wish to have an exclusive zone may instead specify + how they should interact with surfaces that do. If set to zero, the + surface indicates that it would like to be moved to avoid occluding + surfaces with a positive exclusive zone. If set to -1, the surface + indicates that it would not like to be moved to accommodate for other + surfaces, and the compositor should extend it all the way to the edges + it is anchored to. + + For example, a panel might set its exclusive zone to 10, so that + maximized shell surfaces are not shown on top of it. A notification + might set its exclusive zone to 0, so that it is moved to avoid + occluding the panel, but shell surfaces are shown underneath it. A + wallpaper or lock screen might set their exclusive zone to -1, so that + they stretch below or over the panel. + + The default value is 0. + + Exclusive zone is double-buffered, see wl_surface.commit. + + + + + + + Requests that the surface be placed some distance away from the anchor + point on the output, in surface-local coordinates. Setting this value + for edges you are not anchored to has no effect. + + The exclusive zone includes the margin. + + Margin is double-buffered, see wl_surface.commit. + + + + + + + + + + Types of keyboard interaction possible for layer shell surfaces. The + rationale for this is twofold: (1) some applications are not interested + in keyboard events and not allowing them to be focused can improve the + desktop experience; (2) some applications will want to take exclusive + keyboard focus. + + + + + This value indicates that this surface is not interested in keyboard + events and the compositor should never assign it the keyboard focus. + + This is the default value, set for newly created layer shell surfaces. + + This is useful for e.g. desktop widgets that display information or + only have interaction with non-keyboard input devices. + + + + + Request exclusive keyboard focus if this surface is above the shell surface layer. + + For the top and overlay layers, the seat will always give + exclusive keyboard focus to the top-most layer which has keyboard + interactivity set to exclusive. If this layer contains multiple + surfaces with keyboard interactivity set to exclusive, the compositor + determines the one receiving keyboard events in an implementation- + defined manner. In this case, no guarantee is made when this surface + will receive keyboard focus (if ever). + + For the bottom and background layers, the compositor is allowed to use + normal focus semantics. + + This setting is mainly intended for applications that need to ensure + they receive all keyboard events, such as a lock screen or a password + prompt. + + + + + This requests the compositor to allow this surface to be focused and + unfocused by the user in an implementation-defined manner. The user + should be able to unfocus this surface even regardless of the layer + it is on. + + Typically, the compositor will want to use its normal mechanism to + manage keyboard focus between layer shell surfaces with this setting + and regular toplevels on the desktop layer (e.g. click to focus). + Nevertheless, it is possible for a compositor to require a special + interaction to focus or unfocus layer shell surfaces (e.g. requiring + a click even if focus follows the mouse normally, or providing a + keybinding to switch focus between layers). + + This setting is mainly intended for desktop shell components (e.g. + panels) that allow keyboard interaction. Using this option can allow + implementing a desktop shell that can be fully usable without the + mouse. + + + + + + + Set how keyboard events are delivered to this surface. By default, + layer shell surfaces do not receive keyboard events; this request can + be used to change this. + + This setting is inherited by child surfaces set by the get_popup + request. + + Layer surfaces receive pointer, touch, and tablet events normally. If + you do not want to receive them, set the input region on your surface + to an empty region. + + Keyboard interactivity is double-buffered, see wl_surface.commit. + + + + + + + This assigns an xdg_popup's parent to this layer_surface. This popup + should have been created via xdg_surface::get_popup with the parent set + to NULL, and this request must be invoked before committing the popup's + initial state. + + See the documentation of xdg_popup for more details about what an + xdg_popup is and how it is used. + + + + + + + When a configure event is received, if a client commits the + surface in response to the configure event, then the client + must make an ack_configure request sometime before the commit + request, passing along the serial of the configure event. + + If the client receives multiple configure events before it + can respond to one, it only has to ack the last configure event. + + A client is not required to commit immediately after sending + an ack_configure request - it may even ack_configure several times + before its next surface commit. + + A client may send multiple ack_configure requests before committing, but + only the last request sent before a commit indicates which configure + event the client really is responding to. + + + + + + + This request destroys the layer surface. + + + + + + The configure event asks the client to resize its surface. + + Clients should arrange their surface for the new states, and then send + an ack_configure request with the serial sent in this configure event at + some point before committing the new surface. + + The client is free to dismiss all but the last configure event it + received. + + The width and height arguments specify the size of the window in + surface-local coordinates. + + The size is a hint, in the sense that the client is free to ignore it if + it doesn't resize, pick a smaller size (to satisfy aspect ratio or + resize in steps of NxM pixels). If the client picks a smaller size and + is anchored to two opposite anchors (e.g. 'top' and 'bottom'), the + surface will be centered on this axis. + + If the width or height arguments are zero, it means the client should + decide its own window dimension. + + + + + + + + + The closed event is sent by the compositor when the surface will no + longer be shown. The output may have been destroyed or the user may + have asked for it to be removed. Further changes to the surface will be + ignored. The client should destroy the resource after receiving this + event, and create a new surface if they so choose. + + + + + + + + + + + + + + + + + + + + + + Change the layer that the surface is rendered on. + + Layer is double-buffered, see wl_surface.commit. + + + + + diff --git a/protocols/wlr-screencopy-unstable-v1.xml b/protocols/wlr-screencopy-unstable-v1.xml new file mode 100644 index 0000000..8c616c1 --- /dev/null +++ b/protocols/wlr-screencopy-unstable-v1.xml @@ -0,0 +1,225 @@ + + + + Copyright © 2018 Simon Ser + Copyright © 2019 Andri Yngvason + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the "Software"), + to deal in the Software without restriction, including without limitation + the rights to use, copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice (including the next + paragraph) shall be included in all copies or substantial portions of the + Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. + + + + This protocol allows clients to ask the compositor to copy part of the + screen content to a client buffer. + + Warning! The protocol described in this file is experimental and + backward incompatible changes may be made. Backward compatible changes + may be added together with the corresponding interface version bump. + Backward incompatible changes are done by bumping the version number in + the protocol and interface names and resetting the interface version. + Once the protocol is to be declared stable, the 'z' prefix and the + version number in the protocol and interface names are removed and the + interface version number is reset. + + + + + This object is a manager which offers requests to start capturing from a + source. + + + + + Capture the next frame of an entire output. + + + + + + + + + Capture the next frame of an output's region. + + The region is given in output logical coordinates, see + xdg_output.logical_size. The region will be clipped to the output's + extents. + + + + + + + + + + + + + All objects created by the manager will still remain valid, until their + appropriate destroy request has been called. + + + + + + + This object represents a single frame. + + When created, a series of buffer events will be sent, each representing a + supported buffer type. The "buffer_done" event is sent afterwards to + indicate that all supported buffer types have been enumerated. The client + will then be able to send a "copy" request. If the capture is successful, + the compositor will send a "flags" followed by a "ready" event. + + For objects version 2 or lower, wl_shm buffers are always supported, ie. + the "buffer" event is guaranteed to be sent. + + If the capture failed, the "failed" event is sent. This can happen anytime + before the "ready" event. + + Once either a "ready" or a "failed" event is received, the client should + destroy the frame. + + + + + Provides information about wl_shm buffer parameters that need to be + used for this frame. This event is sent once after the frame is created + if wl_shm buffers are supported. + + + + + + + + + + Copy the frame to the supplied buffer. The buffer must have a the + correct size, see zwlr_screencopy_frame_v1.buffer and + zwlr_screencopy_frame_v1.linux_dmabuf. The buffer needs to have a + supported format. + + If the frame is successfully copied, a "flags" and a "ready" events are + sent. Otherwise, a "failed" event is sent. + + + + + + + + + + + + + + + + Provides flags about the frame. This event is sent once before the + "ready" event. + + + + + + + Called as soon as the frame is copied, indicating it is available + for reading. This event includes the time at which presentation happened + at. + + The timestamp is expressed as tv_sec_hi, tv_sec_lo, tv_nsec triples, + each component being an unsigned 32-bit value. Whole seconds are in + tv_sec which is a 64-bit value combined from tv_sec_hi and tv_sec_lo, + and the additional fractional part in tv_nsec as nanoseconds. Hence, + for valid timestamps tv_nsec must be in [0, 999999999]. The seconds part + may have an arbitrary offset at start. + + After receiving this event, the client should destroy the object. + + + + + + + + + This event indicates that the attempted frame copy has failed. + + After receiving this event, the client should destroy the object. + + + + + + Destroys the frame. This request can be sent at any time by the client. + + + + + + + Same as copy, except it waits until there is damage to copy. + + + + + + + This event is sent right before the ready event when copy_with_damage is + requested. It may be generated multiple times for each copy_with_damage + request. + + The arguments describe a box around an area that has changed since the + last copy request that was derived from the current screencopy manager + instance. + + The union of all regions received between the call to copy_with_damage + and a ready event is the total damage since the prior ready event. + + + + + + + + + + + Provides information about linux-dmabuf buffer parameters that need to + be used for this frame. This event is sent once after the frame is + created if linux-dmabuf buffers are supported. + + + + + + + + + This event is sent once after all buffer events have been sent. + + The client should proceed to create a buffer of one of the supported + types, and send a "copy" request. + + + + diff --git a/protocols/xdg-shell.xml b/protocols/xdg-shell.xml new file mode 100644 index 0000000..f4b23c5 --- /dev/null +++ b/protocols/xdg-shell.xml @@ -0,0 +1,1282 @@ + + + + + Copyright © 2008-2013 Kristian Høgsberg + Copyright © 2013 Rafael Antognolli + Copyright © 2013 Jasper St. Pierre + Copyright © 2010-2013 Intel Corporation + Copyright © 2015-2017 Samsung Electronics Co., Ltd + Copyright © 2015-2017 Red Hat Inc. + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the "Software"), + to deal in the Software without restriction, including without limitation + the rights to use, copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice (including the next + paragraph) shall be included in all copies or substantial portions of the + Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. + + + + + The xdg_wm_base interface is exposed as a global object enabling clients + to turn their wl_surfaces into windows in a desktop environment. It + defines the basic functionality needed for clients and the compositor to + create windows that can be dragged, resized, maximized, etc, as well as + creating transient windows such as popup menus. + + + + + + + + + + + + + + Destroy this xdg_wm_base object. + + Destroying a bound xdg_wm_base object while there are surfaces + still alive created by this xdg_wm_base object instance is illegal + and will result in a protocol error. + + + + + + Create a positioner object. A positioner object is used to position + surfaces relative to some parent surface. See the interface description + and xdg_surface.get_popup for details. + + + + + + + This creates an xdg_surface for the given surface. While xdg_surface + itself is not a role, the corresponding surface may only be assigned + a role extending xdg_surface, such as xdg_toplevel or xdg_popup. It is + illegal to create an xdg_surface for a wl_surface which already has an + assigned role and this will result in a protocol error. + + This creates an xdg_surface for the given surface. An xdg_surface is + used as basis to define a role to a given surface, such as xdg_toplevel + or xdg_popup. It also manages functionality shared between xdg_surface + based surface roles. + + See the documentation of xdg_surface for more details about what an + xdg_surface is and how it is used. + + + + + + + + A client must respond to a ping event with a pong request or + the client may be deemed unresponsive. See xdg_wm_base.ping. + + + + + + + The ping event asks the client if it's still alive. Pass the + serial specified in the event back to the compositor by sending + a "pong" request back with the specified serial. See xdg_wm_base.pong. + + Compositors can use this to determine if the client is still + alive. It's unspecified what will happen if the client doesn't + respond to the ping request, or in what timeframe. Clients should + try to respond in a reasonable amount of time. + + A compositor is free to ping in any way it wants, but a client must + always respond to any xdg_wm_base object it created. + + + + + + + + The xdg_positioner provides a collection of rules for the placement of a + child surface relative to a parent surface. Rules can be defined to ensure + the child surface remains within the visible area's borders, and to + specify how the child surface changes its position, such as sliding along + an axis, or flipping around a rectangle. These positioner-created rules are + constrained by the requirement that a child surface must intersect with or + be at least partially adjacent to its parent surface. + + See the various requests for details about possible rules. + + At the time of the request, the compositor makes a copy of the rules + specified by the xdg_positioner. Thus, after the request is complete the + xdg_positioner object can be destroyed or reused; further changes to the + object will have no effect on previous usages. + + For an xdg_positioner object to be considered complete, it must have a + non-zero size set by set_size, and a non-zero anchor rectangle set by + set_anchor_rect. Passing an incomplete xdg_positioner object when + positioning a surface raises an error. + + + + + + + + + Notify the compositor that the xdg_positioner will no longer be used. + + + + + + Set the size of the surface that is to be positioned with the positioner + object. The size is in surface-local coordinates and corresponds to the + window geometry. See xdg_surface.set_window_geometry. + + If a zero or negative size is set the invalid_input error is raised. + + + + + + + + Specify the anchor rectangle within the parent surface that the child + surface will be placed relative to. The rectangle is relative to the + window geometry as defined by xdg_surface.set_window_geometry of the + parent surface. + + When the xdg_positioner object is used to position a child surface, the + anchor rectangle may not extend outside the window geometry of the + positioned child's parent surface. + + If a negative size is set the invalid_input error is raised. + + + + + + + + + + + + + + + + + + + + + + Defines the anchor point for the anchor rectangle. The specified anchor + is used derive an anchor point that the child surface will be + positioned relative to. If a corner anchor is set (e.g. 'top_left' or + 'bottom_right'), the anchor point will be at the specified corner; + otherwise, the derived anchor point will be centered on the specified + edge, or in the center of the anchor rectangle if no edge is specified. + + + + + + + + + + + + + + + + + + + Defines in what direction a surface should be positioned, relative to + the anchor point of the parent surface. If a corner gravity is + specified (e.g. 'bottom_right' or 'top_left'), then the child surface + will be placed towards the specified gravity; otherwise, the child + surface will be centered over the anchor point on any axis that had no + gravity specified. + + + + + + + The constraint adjustment value define ways the compositor will adjust + the position of the surface, if the unadjusted position would result + in the surface being partly constrained. + + Whether a surface is considered 'constrained' is left to the compositor + to determine. For example, the surface may be partly outside the + compositor's defined 'work area', thus necessitating the child surface's + position be adjusted until it is entirely inside the work area. + + The adjustments can be combined, according to a defined precedence: 1) + Flip, 2) Slide, 3) Resize. + + + + Don't alter the surface position even if it is constrained on some + axis, for example partially outside the edge of an output. + + + + + Slide the surface along the x axis until it is no longer constrained. + + First try to slide towards the direction of the gravity on the x axis + until either the edge in the opposite direction of the gravity is + unconstrained or the edge in the direction of the gravity is + constrained. + + Then try to slide towards the opposite direction of the gravity on the + x axis until either the edge in the direction of the gravity is + unconstrained or the edge in the opposite direction of the gravity is + constrained. + + + + + Slide the surface along the y axis until it is no longer constrained. + + First try to slide towards the direction of the gravity on the y axis + until either the edge in the opposite direction of the gravity is + unconstrained or the edge in the direction of the gravity is + constrained. + + Then try to slide towards the opposite direction of the gravity on the + y axis until either the edge in the direction of the gravity is + unconstrained or the edge in the opposite direction of the gravity is + constrained. + + + + + Invert the anchor and gravity on the x axis if the surface is + constrained on the x axis. For example, if the left edge of the + surface is constrained, the gravity is 'left' and the anchor is + 'left', change the gravity to 'right' and the anchor to 'right'. + + If the adjusted position also ends up being constrained, the resulting + position of the flip_x adjustment will be the one before the + adjustment. + + + + + Invert the anchor and gravity on the y axis if the surface is + constrained on the y axis. For example, if the bottom edge of the + surface is constrained, the gravity is 'bottom' and the anchor is + 'bottom', change the gravity to 'top' and the anchor to 'top'. + + The adjusted position is calculated given the original anchor + rectangle and offset, but with the new flipped anchor and gravity + values. + + If the adjusted position also ends up being constrained, the resulting + position of the flip_y adjustment will be the one before the + adjustment. + + + + + Resize the surface horizontally so that it is completely + unconstrained. + + + + + Resize the surface vertically so that it is completely unconstrained. + + + + + + + Specify how the window should be positioned if the originally intended + position caused the surface to be constrained, meaning at least + partially outside positioning boundaries set by the compositor. The + adjustment is set by constructing a bitmask describing the adjustment to + be made when the surface is constrained on that axis. + + If no bit for one axis is set, the compositor will assume that the child + surface should not change its position on that axis when constrained. + + If more than one bit for one axis is set, the order of how adjustments + are applied is specified in the corresponding adjustment descriptions. + + The default adjustment is none. + + + + + + + Specify the surface position offset relative to the position of the + anchor on the anchor rectangle and the anchor on the surface. For + example if the anchor of the anchor rectangle is at (x, y), the surface + has the gravity bottom|right, and the offset is (ox, oy), the calculated + surface position will be (x + ox, y + oy). The offset position of the + surface is the one used for constraint testing. See + set_constraint_adjustment. + + An example use case is placing a popup menu on top of a user interface + element, while aligning the user interface element of the parent surface + with some user interface element placed somewhere in the popup surface. + + + + + + + + + + When set reactive, the surface is reconstrained if the conditions used + for constraining changed, e.g. the parent window moved. + + If the conditions changed and the popup was reconstrained, an + xdg_popup.configure event is sent with updated geometry, followed by an + xdg_surface.configure event. + + + + + + Set the parent window geometry the compositor should use when + positioning the popup. The compositor may use this information to + determine the future state the popup should be constrained using. If + this doesn't match the dimension of the parent the popup is eventually + positioned against, the behavior is undefined. + + The arguments are given in the surface-local coordinate space. + + + + + + + + Set the serial of an xdg_surface.configure event this positioner will be + used in response to. The compositor may use this information together + with set_parent_size to determine what future state the popup should be + constrained using. + + + + + + + + An interface that may be implemented by a wl_surface, for + implementations that provide a desktop-style user interface. + + It provides a base set of functionality required to construct user + interface elements requiring management by the compositor, such as + toplevel windows, menus, etc. The types of functionality are split into + xdg_surface roles. + + Creating an xdg_surface does not set the role for a wl_surface. In order + to map an xdg_surface, the client must create a role-specific object + using, e.g., get_toplevel, get_popup. The wl_surface for any given + xdg_surface can have at most one role, and may not be assigned any role + not based on xdg_surface. + + A role must be assigned before any other requests are made to the + xdg_surface object. + + The client must call wl_surface.commit on the corresponding wl_surface + for the xdg_surface state to take effect. + + Creating an xdg_surface from a wl_surface which has a buffer attached or + committed is a client error, and any attempts by a client to attach or + manipulate a buffer prior to the first xdg_surface.configure call must + also be treated as errors. + + After creating a role-specific object and setting it up, the client must + perform an initial commit without any buffer attached. The compositor + will reply with an xdg_surface.configure event. The client must + acknowledge it and is then allowed to attach a buffer to map the surface. + + Mapping an xdg_surface-based role surface is defined as making it + possible for the surface to be shown by the compositor. Note that + a mapped surface is not guaranteed to be visible once it is mapped. + + For an xdg_surface to be mapped by the compositor, the following + conditions must be met: + (1) the client has assigned an xdg_surface-based role to the surface + (2) the client has set and committed the xdg_surface state and the + role-dependent state to the surface + (3) the client has committed a buffer to the surface + + A newly-unmapped surface is considered to have met condition (1) out + of the 3 required conditions for mapping a surface if its role surface + has not been destroyed, i.e. the client must perform the initial commit + again before attaching a buffer. + + + + + + + + + + + Destroy the xdg_surface object. An xdg_surface must only be destroyed + after its role object has been destroyed. + + + + + + This creates an xdg_toplevel object for the given xdg_surface and gives + the associated wl_surface the xdg_toplevel role. + + See the documentation of xdg_toplevel for more details about what an + xdg_toplevel is and how it is used. + + + + + + + This creates an xdg_popup object for the given xdg_surface and gives + the associated wl_surface the xdg_popup role. + + If null is passed as a parent, a parent surface must be specified using + some other protocol, before committing the initial state. + + See the documentation of xdg_popup for more details about what an + xdg_popup is and how it is used. + + + + + + + + + The window geometry of a surface is its "visible bounds" from the + user's perspective. Client-side decorations often have invisible + portions like drop-shadows which should be ignored for the + purposes of aligning, placing and constraining windows. + + The window geometry is double buffered, and will be applied at the + time wl_surface.commit of the corresponding wl_surface is called. + + When maintaining a position, the compositor should treat the (x, y) + coordinate of the window geometry as the top left corner of the window. + A client changing the (x, y) window geometry coordinate should in + general not alter the position of the window. + + Once the window geometry of the surface is set, it is not possible to + unset it, and it will remain the same until set_window_geometry is + called again, even if a new subsurface or buffer is attached. + + If never set, the value is the full bounds of the surface, + including any subsurfaces. This updates dynamically on every + commit. This unset is meant for extremely simple clients. + + The arguments are given in the surface-local coordinate space of + the wl_surface associated with this xdg_surface. + + The width and height must be greater than zero. Setting an invalid size + will raise an error. When applied, the effective window geometry will be + the set window geometry clamped to the bounding rectangle of the + combined geometry of the surface of the xdg_surface and the associated + subsurfaces. + + + + + + + + + + When a configure event is received, if a client commits the + surface in response to the configure event, then the client + must make an ack_configure request sometime before the commit + request, passing along the serial of the configure event. + + For instance, for toplevel surfaces the compositor might use this + information to move a surface to the top left only when the client has + drawn itself for the maximized or fullscreen state. + + If the client receives multiple configure events before it + can respond to one, it only has to ack the last configure event. + + A client is not required to commit immediately after sending + an ack_configure request - it may even ack_configure several times + before its next surface commit. + + A client may send multiple ack_configure requests before committing, but + only the last request sent before a commit indicates which configure + event the client really is responding to. + + + + + + + The configure event marks the end of a configure sequence. A configure + sequence is a set of one or more events configuring the state of the + xdg_surface, including the final xdg_surface.configure event. + + Where applicable, xdg_surface surface roles will during a configure + sequence extend this event as a latched state sent as events before the + xdg_surface.configure event. Such events should be considered to make up + a set of atomically applied configuration states, where the + xdg_surface.configure commits the accumulated state. + + Clients should arrange their surface for the new states, and then send + an ack_configure request with the serial sent in this configure event at + some point before committing the new surface. + + If the client receives multiple configure events before it can respond + to one, it is free to discard all but the last event it received. + + + + + + + + + This interface defines an xdg_surface role which allows a surface to, + among other things, set window-like properties such as maximize, + fullscreen, and minimize, set application-specific metadata like title and + id, and well as trigger user interactive operations such as interactive + resize and move. + + Unmapping an xdg_toplevel means that the surface cannot be shown + by the compositor until it is explicitly mapped again. + All active operations (e.g., move, resize) are canceled and all + attributes (e.g. title, state, stacking, ...) are discarded for + an xdg_toplevel surface when it is unmapped. The xdg_toplevel returns to + the state it had right after xdg_surface.get_toplevel. The client + can re-map the toplevel by perfoming a commit without any buffer + attached, waiting for a configure event and handling it as usual (see + xdg_surface description). + + Attaching a null buffer to a toplevel unmaps the surface. + + + + + This request destroys the role surface and unmaps the surface; + see "Unmapping" behavior in interface section for details. + + + + + + + + + + Set the "parent" of this surface. This surface should be stacked + above the parent surface and all other ancestor surfaces. + + Parent surfaces should be set on dialogs, toolboxes, or other + "auxiliary" surfaces, so that the parent is raised when the dialog + is raised. + + Setting a null parent for a child surface unsets its parent. Setting + a null parent for a surface which currently has no parent is a no-op. + + Only mapped surfaces can have child surfaces. Setting a parent which + is not mapped is equivalent to setting a null parent. If a surface + becomes unmapped, its children's parent is set to the parent of + the now-unmapped surface. If the now-unmapped surface has no parent, + its children's parent is unset. If the now-unmapped surface becomes + mapped again, its parent-child relationship is not restored. + + + + + + + Set a short title for the surface. + + This string may be used to identify the surface in a task bar, + window list, or other user interface elements provided by the + compositor. + + The string must be encoded in UTF-8. + + + + + + + Set an application identifier for the surface. + + The app ID identifies the general class of applications to which + the surface belongs. The compositor can use this to group multiple + surfaces together, or to determine how to launch a new application. + + For D-Bus activatable applications, the app ID is used as the D-Bus + service name. + + The compositor shell will try to group application surfaces together + by their app ID. As a best practice, it is suggested to select app + ID's that match the basename of the application's .desktop file. + For example, "org.freedesktop.FooViewer" where the .desktop file is + "org.freedesktop.FooViewer.desktop". + + Like other properties, a set_app_id request can be sent after the + xdg_toplevel has been mapped to update the property. + + See the desktop-entry specification [0] for more details on + application identifiers and how they relate to well-known D-Bus + names and .desktop files. + + [0] http://standards.freedesktop.org/desktop-entry-spec/ + + + + + + + Clients implementing client-side decorations might want to show + a context menu when right-clicking on the decorations, giving the + user a menu that they can use to maximize or minimize the window. + + This request asks the compositor to pop up such a window menu at + the given position, relative to the local surface coordinates of + the parent surface. There are no guarantees as to what menu items + the window menu contains. + + This request must be used in response to some sort of user action + like a button press, key press, or touch down event. + + + + + + + + + + Start an interactive, user-driven move of the surface. + + This request must be used in response to some sort of user action + like a button press, key press, or touch down event. The passed + serial is used to determine the type of interactive move (touch, + pointer, etc). + + The server may ignore move requests depending on the state of + the surface (e.g. fullscreen or maximized), or if the passed serial + is no longer valid. + + If triggered, the surface will lose the focus of the device + (wl_pointer, wl_touch, etc) used for the move. It is up to the + compositor to visually indicate that the move is taking place, such as + updating a pointer cursor, during the move. There is no guarantee + that the device focus will return when the move is completed. + + + + + + + + These values are used to indicate which edge of a surface + is being dragged in a resize operation. + + + + + + + + + + + + + + + Start a user-driven, interactive resize of the surface. + + This request must be used in response to some sort of user action + like a button press, key press, or touch down event. The passed + serial is used to determine the type of interactive resize (touch, + pointer, etc). + + The server may ignore resize requests depending on the state of + the surface (e.g. fullscreen or maximized). + + If triggered, the client will receive configure events with the + "resize" state enum value and the expected sizes. See the "resize" + enum value for more details about what is required. The client + must also acknowledge configure events using "ack_configure". After + the resize is completed, the client will receive another "configure" + event without the resize state. + + If triggered, the surface also will lose the focus of the device + (wl_pointer, wl_touch, etc) used for the resize. It is up to the + compositor to visually indicate that the resize is taking place, + such as updating a pointer cursor, during the resize. There is no + guarantee that the device focus will return when the resize is + completed. + + The edges parameter specifies how the surface should be resized, and + is one of the values of the resize_edge enum. Values not matching + a variant of the enum will cause a protocol error. The compositor + may use this information to update the surface position for example + when dragging the top left corner. The compositor may also use + this information to adapt its behavior, e.g. choose an appropriate + cursor image. + + + + + + + + + The different state values used on the surface. This is designed for + state values like maximized, fullscreen. It is paired with the + configure event to ensure that both the client and the compositor + setting the state can be synchronized. + + States set in this way are double-buffered. They will get applied on + the next commit. + + + + The surface is maximized. The window geometry specified in the configure + event must be obeyed by the client. + + The client should draw without shadow or other + decoration outside of the window geometry. + + + + + The surface is fullscreen. The window geometry specified in the + configure event is a maximum; the client cannot resize beyond it. For + a surface to cover the whole fullscreened area, the geometry + dimensions must be obeyed by the client. For more details, see + xdg_toplevel.set_fullscreen. + + + + + The surface is being resized. The window geometry specified in the + configure event is a maximum; the client cannot resize beyond it. + Clients that have aspect ratio or cell sizing configuration can use + a smaller size, however. + + + + + Client window decorations should be painted as if the window is + active. Do not assume this means that the window actually has + keyboard or pointer focus. + + + + + The window is currently in a tiled layout and the left edge is + considered to be adjacent to another part of the tiling grid. + + + + + The window is currently in a tiled layout and the right edge is + considered to be adjacent to another part of the tiling grid. + + + + + The window is currently in a tiled layout and the top edge is + considered to be adjacent to another part of the tiling grid. + + + + + The window is currently in a tiled layout and the bottom edge is + considered to be adjacent to another part of the tiling grid. + + + + + + + Set a maximum size for the window. + + The client can specify a maximum size so that the compositor does + not try to configure the window beyond this size. + + The width and height arguments are in window geometry coordinates. + See xdg_surface.set_window_geometry. + + Values set in this way are double-buffered. They will get applied + on the next commit. + + The compositor can use this information to allow or disallow + different states like maximize or fullscreen and draw accurate + animations. + + Similarly, a tiling window manager may use this information to + place and resize client windows in a more effective way. + + The client should not rely on the compositor to obey the maximum + size. The compositor may decide to ignore the values set by the + client and request a larger size. + + If never set, or a value of zero in the request, means that the + client has no expected maximum size in the given dimension. + As a result, a client wishing to reset the maximum size + to an unspecified state can use zero for width and height in the + request. + + Requesting a maximum size to be smaller than the minimum size of + a surface is illegal and will result in a protocol error. + + The width and height must be greater than or equal to zero. Using + strictly negative values for width and height will result in a + protocol error. + + + + + + + + Set a minimum size for the window. + + The client can specify a minimum size so that the compositor does + not try to configure the window below this size. + + The width and height arguments are in window geometry coordinates. + See xdg_surface.set_window_geometry. + + Values set in this way are double-buffered. They will get applied + on the next commit. + + The compositor can use this information to allow or disallow + different states like maximize or fullscreen and draw accurate + animations. + + Similarly, a tiling window manager may use this information to + place and resize client windows in a more effective way. + + The client should not rely on the compositor to obey the minimum + size. The compositor may decide to ignore the values set by the + client and request a smaller size. + + If never set, or a value of zero in the request, means that the + client has no expected minimum size in the given dimension. + As a result, a client wishing to reset the minimum size + to an unspecified state can use zero for width and height in the + request. + + Requesting a minimum size to be larger than the maximum size of + a surface is illegal and will result in a protocol error. + + The width and height must be greater than or equal to zero. Using + strictly negative values for width and height will result in a + protocol error. + + + + + + + + Maximize the surface. + + After requesting that the surface should be maximized, the compositor + will respond by emitting a configure event. Whether this configure + actually sets the window maximized is subject to compositor policies. + The client must then update its content, drawing in the configured + state. The client must also acknowledge the configure when committing + the new content (see ack_configure). + + It is up to the compositor to decide how and where to maximize the + surface, for example which output and what region of the screen should + be used. + + If the surface was already maximized, the compositor will still emit + a configure event with the "maximized" state. + + If the surface is in a fullscreen state, this request has no direct + effect. It may alter the state the surface is returned to when + unmaximized unless overridden by the compositor. + + + + + + Unmaximize the surface. + + After requesting that the surface should be unmaximized, the compositor + will respond by emitting a configure event. Whether this actually + un-maximizes the window is subject to compositor policies. + If available and applicable, the compositor will include the window + geometry dimensions the window had prior to being maximized in the + configure event. The client must then update its content, drawing it in + the configured state. The client must also acknowledge the configure + when committing the new content (see ack_configure). + + It is up to the compositor to position the surface after it was + unmaximized; usually the position the surface had before maximizing, if + applicable. + + If the surface was already not maximized, the compositor will still + emit a configure event without the "maximized" state. + + If the surface is in a fullscreen state, this request has no direct + effect. It may alter the state the surface is returned to when + unmaximized unless overridden by the compositor. + + + + + + Make the surface fullscreen. + + After requesting that the surface should be fullscreened, the + compositor will respond by emitting a configure event. Whether the + client is actually put into a fullscreen state is subject to compositor + policies. The client must also acknowledge the configure when + committing the new content (see ack_configure). + + The output passed by the request indicates the client's preference as + to which display it should be set fullscreen on. If this value is NULL, + it's up to the compositor to choose which display will be used to map + this surface. + + If the surface doesn't cover the whole output, the compositor will + position the surface in the center of the output and compensate with + with border fill covering the rest of the output. The content of the + border fill is undefined, but should be assumed to be in some way that + attempts to blend into the surrounding area (e.g. solid black). + + If the fullscreened surface is not opaque, the compositor must make + sure that other screen content not part of the same surface tree (made + up of subsurfaces, popups or similarly coupled surfaces) are not + visible below the fullscreened surface. + + + + + + + Make the surface no longer fullscreen. + + After requesting that the surface should be unfullscreened, the + compositor will respond by emitting a configure event. + Whether this actually removes the fullscreen state of the client is + subject to compositor policies. + + Making a surface unfullscreen sets states for the surface based on the following: + * the state(s) it may have had before becoming fullscreen + * any state(s) decided by the compositor + * any state(s) requested by the client while the surface was fullscreen + + The compositor may include the previous window geometry dimensions in + the configure event, if applicable. + + The client must also acknowledge the configure when committing the new + content (see ack_configure). + + + + + + Request that the compositor minimize your surface. There is no + way to know if the surface is currently minimized, nor is there + any way to unset minimization on this surface. + + If you are looking to throttle redrawing when minimized, please + instead use the wl_surface.frame event for this, as this will + also work with live previews on windows in Alt-Tab, Expose or + similar compositor features. + + + + + + This configure event asks the client to resize its toplevel surface or + to change its state. The configured state should not be applied + immediately. See xdg_surface.configure for details. + + The width and height arguments specify a hint to the window + about how its surface should be resized in window geometry + coordinates. See set_window_geometry. + + If the width or height arguments are zero, it means the client + should decide its own window dimension. This may happen when the + compositor needs to configure the state of the surface but doesn't + have any information about any previous or expected dimension. + + The states listed in the event specify how the width/height + arguments should be interpreted, and possibly how it should be + drawn. + + Clients must send an ack_configure in response to this event. See + xdg_surface.configure and xdg_surface.ack_configure for details. + + + + + + + + + The close event is sent by the compositor when the user + wants the surface to be closed. This should be equivalent to + the user clicking the close button in client-side decorations, + if your application has any. + + This is only a request that the user intends to close the + window. The client may choose to ignore this request, or show + a dialog to ask the user to save their data, etc. + + + + + + + + The configure_bounds event may be sent prior to a xdg_toplevel.configure + event to communicate the bounds a window geometry size is recommended + to constrain to. + + The passed width and height are in surface coordinate space. If width + and height are 0, it means bounds is unknown and equivalent to as if no + configure_bounds event was ever sent for this surface. + + The bounds can for example correspond to the size of a monitor excluding + any panels or other shell components, so that a surface isn't created in + a way that it cannot fit. + + The bounds may change at any point, and in such a case, a new + xdg_toplevel.configure_bounds will be sent, followed by + xdg_toplevel.configure and xdg_surface.configure. + + + + + + + + + A popup surface is a short-lived, temporary surface. It can be used to + implement for example menus, popovers, tooltips and other similar user + interface concepts. + + A popup can be made to take an explicit grab. See xdg_popup.grab for + details. + + When the popup is dismissed, a popup_done event will be sent out, and at + the same time the surface will be unmapped. See the xdg_popup.popup_done + event for details. + + Explicitly destroying the xdg_popup object will also dismiss the popup and + unmap the surface. Clients that want to dismiss the popup when another + surface of their own is clicked should dismiss the popup using the destroy + request. + + A newly created xdg_popup will be stacked on top of all previously created + xdg_popup surfaces associated with the same xdg_toplevel. + + The parent of an xdg_popup must be mapped (see the xdg_surface + description) before the xdg_popup itself. + + The client must call wl_surface.commit on the corresponding wl_surface + for the xdg_popup state to take effect. + + + + + + + + + This destroys the popup. Explicitly destroying the xdg_popup + object will also dismiss the popup, and unmap the surface. + + If this xdg_popup is not the "topmost" popup, a protocol error + will be sent. + + + + + + This request makes the created popup take an explicit grab. An explicit + grab will be dismissed when the user dismisses the popup, or when the + client destroys the xdg_popup. This can be done by the user clicking + outside the surface, using the keyboard, or even locking the screen + through closing the lid or a timeout. + + If the compositor denies the grab, the popup will be immediately + dismissed. + + This request must be used in response to some sort of user action like a + button press, key press, or touch down event. The serial number of the + event should be passed as 'serial'. + + The parent of a grabbing popup must either be an xdg_toplevel surface or + another xdg_popup with an explicit grab. If the parent is another + xdg_popup it means that the popups are nested, with this popup now being + the topmost popup. + + Nested popups must be destroyed in the reverse order they were created + in, e.g. the only popup you are allowed to destroy at all times is the + topmost one. + + When compositors choose to dismiss a popup, they may dismiss every + nested grabbing popup as well. When a compositor dismisses popups, it + will follow the same dismissing order as required from the client. + + The parent of a grabbing popup must either be another xdg_popup with an + active explicit grab, or an xdg_popup or xdg_toplevel, if there are no + explicit grabs already taken. + + If the topmost grabbing popup is destroyed, the grab will be returned to + the parent of the popup, if that parent previously had an explicit grab. + + If the parent is a grabbing popup which has already been dismissed, this + popup will be immediately dismissed. If the parent is a popup that did + not take an explicit grab, an error will be raised. + + During a popup grab, the client owning the grab will receive pointer + and touch events for all their surfaces as normal (similar to an + "owner-events" grab in X11 parlance), while the top most grabbing popup + will always have keyboard focus. + + + + + + + + This event asks the popup surface to configure itself given the + configuration. The configured state should not be applied immediately. + See xdg_surface.configure for details. + + The x and y arguments represent the position the popup was placed at + given the xdg_positioner rule, relative to the upper left corner of the + window geometry of the parent surface. + + For version 2 or older, the configure event for an xdg_popup is only + ever sent once for the initial configuration. Starting with version 3, + it may be sent again if the popup is setup with an xdg_positioner with + set_reactive requested, or in response to xdg_popup.reposition requests. + + + + + + + + + + The popup_done event is sent out when a popup is dismissed by the + compositor. The client should destroy the xdg_popup object at this + point. + + + + + + + + Reposition an already-mapped popup. The popup will be placed given the + details in the passed xdg_positioner object, and a + xdg_popup.repositioned followed by xdg_popup.configure and + xdg_surface.configure will be emitted in response. Any parameters set + by the previous positioner will be discarded. + + The passed token will be sent in the corresponding + xdg_popup.repositioned event. The new popup position will not take + effect until the corresponding configure event is acknowledged by the + client. See xdg_popup.repositioned for details. The token itself is + opaque, and has no other special meaning. + + If multiple reposition requests are sent, the compositor may skip all + but the last one. + + If the popup is repositioned in response to a configure event for its + parent, the client should send an xdg_positioner.set_parent_configure + and possibly an xdg_positioner.set_parent_size request to allow the + compositor to properly constrain the popup. + + If the popup is repositioned together with a parent that is being + resized, but not in response to a configure event, the client should + send an xdg_positioner.set_parent_size request. + + + + + + + + The repositioned event is sent as part of a popup configuration + sequence, together with xdg_popup.configure and lastly + xdg_surface.configure to notify the completion of a reposition request. + + The repositioned event is to notify about the completion of a + xdg_popup.reposition request. The token argument is the token passed + in the xdg_popup.reposition request. + + Immediately after this event is emitted, xdg_popup.configure and + xdg_surface.configure will be sent with the updated size and position, + as well as a new configure serial. + + The client should optionally update the content of the popup, but must + acknowledge the new popup configuration for the new position to take + effect. See xdg_surface.ack_configure for details. + + + + + +