commit 77f65c69755d356175cd158ebaf8d626f92442c5 Author: Simon Ser Date: Wed Jan 11 11:05:53 2023 +0100 Initial commit diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..c229150 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +root = true + +[*] +end_of_line = lf +insert_final_newline = true +charset = utf-8 +trim_trailing_whitespace = true +indent_style = tab +indent_size = 4 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..796b96d --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/build diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b06711c --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Simon Ser + +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 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..20f7074 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# chayang + +Gradually dim the screen. + +Can be used to implement a grace period before locking the session. + +## Usage + + chayang && swaylock + +## Building + + meson setup build/ + ninja -C build/ + +## License + +MIT diff --git a/include/chayang.h b/include/chayang.h new file mode 100644 index 0000000..c8efc6c --- /dev/null +++ b/include/chayang.h @@ -0,0 +1,46 @@ +#ifndef CHAYANG_H +#define CHAYANG_H + +#include +#include + +#include + +struct chayang { + struct wl_compositor *compositor; + struct zwlr_layer_shell_v1 *layer_shell; + struct wp_viewporter *viewporter; + struct wp_single_pixel_buffer_manager_v1 *single_pixel_buffer_manager; + + struct wl_list outputs; + struct wl_list seats; + + bool running; + int64_t start_time_ms; +}; + +struct chayang_output { + struct wl_output *wl; + struct chayang *chayang; + uint32_t global_name; + struct wl_list link; + + struct wl_surface *surface; + struct zwlr_layer_surface_v1 *layer_surface; + struct wp_viewport *viewport; + + int32_t surface_width, surface_height; +}; + +struct chayang_seat { + struct wl_seat *wl; + struct chayang *chayang; + uint32_t global_name; + struct wl_list link; + + uint32_t caps; + struct wl_pointer *pointer; + struct wl_keyboard *keyboard; +}; + +#endif diff --git a/main.c b/main.c new file mode 100644 index 0000000..3c63f41 --- /dev/null +++ b/main.c @@ -0,0 +1,332 @@ +#include +#include +#include +#include +#include + +#include +#include + +#include "chayang.h" +#include "single-pixel-buffer-v1-protocol.h" +#include "viewporter-protocol.h" +#include "wlr-layer-shell-unstable-v1-protocol.h" + +#define DIM_DELAY_MS 3000 + +static void repaint_output(struct chayang_output *output); + +static int64_t now_ms(void) { + struct timespec ts = {0}; + if (clock_gettime(CLOCK_MONOTONIC, &ts) != 0) { + perror("clock_gettime() failed"); + exit(1); + } + return (int64_t)ts.tv_sec * 1000 + ts.tv_nsec / 1000000; +} + +static void frame_callback_handle_done(void *data, struct wl_callback *callback, uint32_t time) { + struct chayang_output *output = data; + wl_callback_destroy(callback); + repaint_output(output); +} + +static const struct wl_callback_listener frame_callback_listener = { + .done = frame_callback_handle_done, +}; + +static void repaint_output(struct chayang_output *output) { + int64_t delta = now_ms() - output->chayang->start_time_ms; + double progress = (double)delta / DIM_DELAY_MS; + if (progress >= 1) { + output->chayang->running = false; + return; + } + + uint32_t alpha = progress * UINT32_MAX; + struct wl_buffer *buffer = wp_single_pixel_buffer_manager_v1_create_u32_rgba_buffer(output->chayang->single_pixel_buffer_manager, 0, 0, 0, alpha); + wl_surface_attach(output->surface, buffer, 0, 0); + + wp_viewport_set_destination(output->viewport, output->surface_width, output->surface_height); + + struct wl_callback *frame_callback = wl_surface_frame(output->surface); + wl_callback_add_listener(frame_callback, &frame_callback_listener, output); + + wl_surface_damage(output->surface, 0, 0, INT32_MAX, INT32_MAX); + wl_surface_commit(output->surface); + + wl_buffer_destroy(buffer); +} + +static void destroy_output(struct chayang_output *output) { + wp_viewport_destroy(output->viewport); + zwlr_layer_surface_v1_destroy(output->layer_surface); + wl_surface_destroy(output->surface); + wl_list_remove(&output->link); + wl_output_destroy(output->wl); + free(output); +} + +static void destroy_seat(struct chayang_seat *seat) { + wl_list_remove(&seat->link); + if (seat->pointer != NULL) { + wl_pointer_destroy(seat->pointer); + } + if (seat->keyboard != NULL) { + wl_keyboard_destroy(seat->keyboard); + } + wl_seat_destroy(seat->wl); + free(seat); +} + +static void layer_surface_handle_configure(void *data, struct zwlr_layer_surface_v1 *surface, uint32_t serial, uint32_t width, uint32_t height) { + struct chayang_output *output = data; + + output->surface_width = width; + output->surface_height = height; + + zwlr_layer_surface_v1_ack_configure(surface, serial); + repaint_output(output); +} + +static void layer_surface_handle_closed(void *data, struct zwlr_layer_surface_v1 *surface) { + struct chayang_output *output = data; + destroy_output(output); +} + +static const struct zwlr_layer_surface_v1_listener layer_surface_listener = { + .configure = layer_surface_handle_configure, + .closed = layer_surface_handle_closed, +}; + +static void pointer_handle_enter(void *data, struct wl_pointer *wl_pointer, uint32_t serial, struct wl_surface *surface, wl_fixed_t surface_x, wl_fixed_t surface_y) { + // No-op +} + +static void pointer_handle_leave(void *data, struct wl_pointer *wl_pointer, uint32_t serial, struct wl_surface *surface) { + // No-op +} + +static void pointer_handle_motion(void *data, struct wl_pointer *wl_pointer, uint32_t time, wl_fixed_t surface_x, wl_fixed_t surface_y) { + struct chayang_seat *seat = data; + seat->chayang->running = false; +} + +static void pointer_handle_button(void *data, struct wl_pointer *wl_pointer, uint32_t serial, uint32_t time, uint32_t button, uint32_t state) { + struct chayang_seat *seat = data; + if (state == WL_POINTER_BUTTON_STATE_PRESSED) { + seat->chayang->running = false; + } +} + +static void pointer_handle_axis(void *data, struct wl_pointer *wl_pointer, uint32_t time, uint32_t axis, wl_fixed_t value) { + struct chayang_seat *output = data; + output->chayang->running = false; +} + +static const struct wl_pointer_listener pointer_listener = { + .enter = pointer_handle_enter, + .leave = pointer_handle_leave, + .motion = pointer_handle_motion, + .button = pointer_handle_button, + .axis = pointer_handle_axis, +}; + +static void keyboard_handle_keymap(void *data, struct wl_keyboard *wl_keyboard, uint32_t format, int fd, uint32_t size) { + close(fd); +} + +static void keyboard_handle_enter(void *data, struct wl_keyboard *wl_keyboard, uint32_t serial, struct wl_surface *wl_surface, struct wl_array *keys) { + // No-op +} + +static void keyboard_handle_leave(void *data, struct wl_keyboard *wl_keyboard, uint32_t serial, struct wl_surface *wl_surface) { + // No-op +} + +static void keyboard_handle_key(void *data, struct wl_keyboard *wl_keyboard, uint32_t serial, uint32_t time, uint32_t key, uint32_t state) { + struct chayang_seat *seat = data; + if (state == WL_KEYBOARD_KEY_STATE_PRESSED) { + seat->chayang->running = false; + } +} + +static void keyboard_handle_modifiers(void *data, struct wl_keyboard *wl_keyboard, uint32_t serial, uint32_t mods_depressed, uint32_t mods_latched, uint32_t mods_locked, uint32_t group) { + // No-op +} + +static const struct wl_keyboard_listener keyboard_listener = { + .keymap = keyboard_handle_keymap, + .enter = keyboard_handle_enter, + .leave = keyboard_handle_leave, + .key = keyboard_handle_key, + .modifiers = keyboard_handle_modifiers, +}; + +static void seat_handle_capabilities(void *data, struct wl_seat *wl_seat, uint32_t caps) { + struct chayang_seat *seat = data; + + uint32_t removed_caps = seat->caps & ~caps; + uint32_t added_caps = caps & ~seat->caps; + + if (removed_caps & WL_SEAT_CAPABILITY_POINTER) { + wl_pointer_destroy(seat->pointer); + seat->pointer = NULL; + } + if (removed_caps & WL_SEAT_CAPABILITY_KEYBOARD) { + wl_keyboard_destroy(seat->keyboard); + seat->keyboard = NULL; + } + + if (added_caps & WL_SEAT_CAPABILITY_POINTER) { + seat->pointer = wl_seat_get_pointer(seat->wl); + wl_pointer_add_listener(seat->pointer, &pointer_listener, seat); + } + if (added_caps & WL_SEAT_CAPABILITY_KEYBOARD) { + seat->keyboard = wl_seat_get_keyboard(seat->wl); + wl_keyboard_add_listener(seat->keyboard, &keyboard_listener, seat); + } + + seat->caps = caps; +} + +static const struct wl_seat_listener seat_listener = { + .capabilities = seat_handle_capabilities, +}; + +static void registry_handle_global(void *data, struct wl_registry *registry, uint32_t name, const char *interface, uint32_t version) { + struct chayang *state = data; + + if (strcmp(interface, wl_compositor_interface.name) == 0) { + state->compositor = wl_registry_bind(registry, name, &wl_compositor_interface, 4); + } else if (strcmp(interface, zwlr_layer_shell_v1_interface.name) == 0) { + state->layer_shell = wl_registry_bind(registry, name, &zwlr_layer_shell_v1_interface, 1); + } else if (strcmp(interface, wp_viewporter_interface.name) == 0) { + state->viewporter = wl_registry_bind(registry, name, &wp_viewporter_interface, 1); + } else if (strcmp(interface, wp_single_pixel_buffer_manager_v1_interface.name) == 0) { + state->single_pixel_buffer_manager = wl_registry_bind(registry, name, &wp_single_pixel_buffer_manager_v1_interface, 1); + } else if (strcmp(interface, wl_output_interface.name) == 0) { + struct chayang_output *output = calloc(1, sizeof(*output)); + output->global_name = name; + output->chayang = state; + output->wl = wl_registry_bind(registry, name, &wl_output_interface, 1); + wl_list_insert(&state->outputs, &output->link); + } else if (strcmp(interface, wl_seat_interface.name) == 0) { + struct chayang_seat *seat = calloc(1, sizeof(*seat)); + seat->global_name = name; + seat->chayang = state; + seat->wl = wl_registry_bind(registry, name, &wl_seat_interface, 1); + wl_seat_add_listener(seat->wl, &seat_listener, seat); + wl_list_insert(&state->seats, &seat->link); + } +} + +static void registry_handle_global_remove(void *data, struct wl_registry *registry, uint32_t name) { + struct chayang *state = data; + + struct chayang_output *output; + wl_list_for_each(output, &state->outputs, link) { + if (output->global_name == name) { + destroy_output(output); + break; + } + } + + struct chayang_seat *seat; + wl_list_for_each(seat, &state->seats, link) { + if (seat->global_name == name) { + destroy_seat(seat); + break; + } + } +} + +static const struct wl_registry_listener registry_listener = { + .global = registry_handle_global, + .global_remove = registry_handle_global_remove, +}; + +int main(int argc, char *argv[]) { + struct chayang state = {0}; + wl_list_init(&state.outputs); + wl_list_init(&state.seats); + + struct wl_display *display = wl_display_connect(NULL); + if (display == NULL) { + fprintf(stderr, "failed to connect to display\n"); + return 1; + } + + struct wl_registry *registry = wl_display_get_registry(display); + wl_registry_add_listener(registry, ®istry_listener, &state); + + if (wl_display_roundtrip(display) < 0) { + fprintf(stderr, "wl_display_roundtrip() failed\n"); + return 1; + } + + struct { + const char *name; + bool found; + } required_globals[] = { + { "wl_compositor", state.compositor != NULL }, + { "zwlr_layer_shell_v1", state.layer_shell != NULL }, + { "wp_viewporter", state.viewporter != NULL }, + { "wp_single_pixel_buffer_manager_v1", state.single_pixel_buffer_manager != NULL }, + }; + for (size_t i = 0; i < sizeof(required_globals) / sizeof(required_globals[0]); i++) { + if (!required_globals[i].found) { + fprintf(stderr, "missing %s global\n", required_globals[i].name); + return 1; + } + } + + struct chayang_output *output; + wl_list_for_each(output, &state.outputs, link) { + output->surface = wl_compositor_create_surface(state.compositor); + + output->layer_surface = zwlr_layer_shell_v1_get_layer_surface(state.layer_shell, output->surface, output->wl, ZWLR_LAYER_SHELL_V1_LAYER_OVERLAY, "dim"); + zwlr_layer_surface_v1_add_listener(output->layer_surface, &layer_surface_listener, output); + + output->viewport = wp_viewporter_get_viewport(state.viewporter, output->surface); + + zwlr_layer_surface_v1_set_anchor(output->layer_surface, + ZWLR_LAYER_SURFACE_V1_ANCHOR_TOP | + ZWLR_LAYER_SURFACE_V1_ANCHOR_LEFT | + ZWLR_LAYER_SURFACE_V1_ANCHOR_RIGHT | + ZWLR_LAYER_SURFACE_V1_ANCHOR_BOTTOM); + zwlr_layer_surface_v1_set_keyboard_interactivity(output->layer_surface, true); + zwlr_layer_surface_v1_set_exclusive_zone(output->layer_surface, -1); + wl_surface_commit(output->surface); + } + + int ret = 0; + state.running = true; + state.start_time_ms = now_ms(); + while (state.running) { + if (wl_display_dispatch(display) < 0) { + fprintf(stderr, "wl_display_dispatch() failed\n"); + ret = 1; + break; + } + } + + struct chayang_output *output_tmp; + wl_list_for_each_safe(output, output_tmp, &state.outputs, link) { + destroy_output(output); + } + + struct chayang_seat *seat, *seat_tmp; + wl_list_for_each_safe(seat, seat_tmp, &state.seats, link) { + destroy_seat(seat); + } + + wl_compositor_destroy(state.compositor); + zwlr_layer_shell_v1_destroy(state.layer_shell); + wp_viewporter_destroy(state.viewporter); + wp_single_pixel_buffer_manager_v1_destroy(state.single_pixel_buffer_manager); + wl_registry_destroy(registry); + wl_display_disconnect(display); + + return ret; +} diff --git a/meson.build b/meson.build new file mode 100644 index 0000000..135c712 --- /dev/null +++ b/meson.build @@ -0,0 +1,27 @@ +project( + 'chayang', + 'c', + default_options: ['c_std=c11', 'warning_level=2', 'werror=true'], +) + +add_project_arguments( + '-D_POSIX_C_SOURCE=200809L', + '-Wno-unused-parameter', + language: 'c', +) + +subdir('protocol') + +cc = meson.get_compiler('c') + +wayland_client = dependency('wayland-client') + +executable( + 'chayang', + ['main.c'] + protos_src, + dependencies: [ + wayland_client, + ], + include_directories: 'include', + install: true, +) diff --git a/protocol/meson.build b/protocol/meson.build new file mode 100644 index 0000000..1debef2 --- /dev/null +++ b/protocol/meson.build @@ -0,0 +1,30 @@ +wayland_scanner = dependency('wayland-scanner', native: true, version: '>=1.14.91') +wayland_scanner = find_program(wayland_scanner.get_variable('wayland_scanner'), native: true) + +wayland_protocols = dependency('wayland-protocols', version: '>=1.14') +wp_dir = wayland_protocols.get_variable('pkgdatadir') + +wayland_scanner_code = generator( + wayland_scanner, + output: '@BASENAME@-protocol.c', + arguments: ['private-code', '@INPUT@', '@OUTPUT@'], +) + +wayland_scanner_client = generator( + wayland_scanner, + output: '@BASENAME@-protocol.h', + arguments: ['client-header', '@INPUT@', '@OUTPUT@'], +) + +client_protocols = [ + wp_dir / 'stable/viewporter/viewporter.xml', + wp_dir / 'stable/xdg-shell/xdg-shell.xml', + wp_dir / 'staging/single-pixel-buffer/single-pixel-buffer-v1.xml', + 'wlr-layer-shell-unstable-v1.xml', +] + +protos_src = [] +foreach xml : client_protocols + protos_src += wayland_scanner_code.process(xml) + protos_src += wayland_scanner_client.process(xml) +endforeach diff --git a/protocol/wlr-layer-shell-unstable-v1.xml b/protocol/wlr-layer-shell-unstable-v1.xml new file mode 100644 index 0000000..d62fd51 --- /dev/null +++ b/protocol/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. + + + + +