pax_global_header00006660000000000000000000000064147607747640014540gustar00rootroot0000000000000052 comment=9c8ff1ca38051348c8e45c173f75cca7917980f1 hyprland-protocols-0.6.2/000077500000000000000000000000001476077476400154105ustar00rootroot00000000000000hyprland-protocols-0.6.2/LICENSE000066400000000000000000000027641476077476400164260ustar00rootroot00000000000000BSD 3-Clause License Copyright (c) 2022, Hypr Development All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. hyprland-protocols-0.6.2/README.md000066400000000000000000000030141476077476400166650ustar00rootroot00000000000000# hyprland-protocols Wayland protocol extensions for Hyprland. This repository exists in an effort to bridge the gap between Hyprland and KDE/Gnome's functionality, as well as allow apps for some extra neat functionality under Hyprland. Since `wayland-protocols` is slow to change (on top of Hyprland not being allowed to contribute), we have to maintain a set of protocols Hyprland uses to plumb some things / add some useful features. Some of the protocols here also do not belong in w-p, as they are specific to Hyprland. # Finished protocols - `hyprland_toplevel_export` -> for exporting toplevel buffers (aka. windows) for screensharing - `hyprland_global_keybindings` -> for managing global keybinds via D-Bus. - `hyprland_focus_grab` -> for grabbing input focus, primarily for complex context menus. - `hyprland_ctm_control` -> for managing CTMs of displays. See [hyprsunset](https://github.com/hyprwm/hyprsunset) - `hyprland_surface` -> for setting hyprland specific wl_surface properties. - `hyprland_lock_notify` -> for notifying a client about the screen being locked and unlocked. # Contributing Adding new protocols is *discouraged*, as most things you think of can already be done one way or another. However, if the protocol has a good reason to be, and you have an impl ready, feel free to make a PR. We're always up for a discussion to improve things! Fixing typos / adding explanations to existing protocols - welcome. Adding functionality to protocols / new revisions - welcome, if accompanied with a reason and an impl. hyprland-protocols-0.6.2/VERSION000066400000000000000000000000061476077476400164540ustar00rootroot000000000000000.6.2 hyprland-protocols-0.6.2/flake.lock000066400000000000000000000020011476077476400173350ustar00rootroot00000000000000{ "nodes": { "nixpkgs": { "locked": { "lastModified": 1721138476, "narHash": "sha256-+W5eZOhhemLQxelojLxETfbFbc19NWawsXBlapYpqIA=", "owner": "NixOS", "repo": "nixpkgs", "rev": "ad0b5eed1b6031efaed382844806550c3dcb4206", "type": "github" }, "original": { "owner": "NixOS", "ref": "nixos-unstable", "repo": "nixpkgs", "type": "github" } }, "root": { "inputs": { "nixpkgs": "nixpkgs", "systems": "systems" } }, "systems": { "locked": { "lastModified": 1689347949, "narHash": "sha256-12tWmuL2zgBgZkdoB6qXZsgJEH9LR3oUgpaQq2RbI80=", "owner": "nix-systems", "repo": "default-linux", "rev": "31732fcf5e8fea42e59c2488ad31a0e651500f68", "type": "github" }, "original": { "owner": "nix-systems", "repo": "default-linux", "type": "github" } } }, "root": "root", "version": 7 } hyprland-protocols-0.6.2/flake.nix000066400000000000000000000025011476077476400172100ustar00rootroot00000000000000{ description = "Hyprland Protocols"; inputs = { nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; # systems.url = "github:nix-systems/default-linux"; }; outputs = { self, nixpkgs, systems, ... }: let inherit (nixpkgs) lib; eachSystem = lib.genAttrs (import systems); pkgsFor = eachSystem (system: import nixpkgs { localSystem = system; overlays = [self.overlays.hyprland-protocols]; }); mkDate = longDate: (lib.concatStringsSep "-" [ (builtins.substring 0 4 longDate) (builtins.substring 4 2 longDate) (builtins.substring 6 2 longDate) ]); version = lib.removeSuffix "\n" (builtins.readFile ./VERSION); in { overlays = { default = self.overlays.hyprland-protocols; hyprland-protocols = final: prev: { hyprland-protocols = final.callPackage ./nix/default.nix { version = version + "+date=" + (mkDate (self.lastModifiedDate or "19700101")) + "_" + (self.shortRev or "dirty"); }; }; }; packages = eachSystem (system: { inherit (pkgsFor.${system}) hyprland-protocols; default = self.packages.${system}.hyprland-protocols; }); formatter = eachSystem (system: nixpkgs.legacyPackages.${system}.alejandra); }; } hyprland-protocols-0.6.2/hyprland-protocols.pc.in000066400000000000000000000003031476077476400222000ustar00rootroot00000000000000prefix=@prefix@ datarootdir=@datarootdir@ pkgdatadir=${pc_sysrootdir}${datarootdir}/@PACKAGE@ Name: Hyprland Protocols Description: Hyprland protocol files Version: @HYPRLAND_PROTOCOLS_VERSION@ hyprland-protocols-0.6.2/meson.build000066400000000000000000000033061476077476400175540ustar00rootroot00000000000000project('hyprland-protocols', version: run_command('cat', 'VERSION', check: true).stdout().strip(), meson_version: '>= 0.60.3', ) hyprland_protocols_version = meson.project_version() fs = import('fs') protocols = { 'hyprland-toplevel-export': ['v1'], 'hyprland-global-shortcuts': ['v1'], 'hyprland-focus-grab': ['v1'], 'hyprland-ctm-control': ['v1'], 'hyprland-surface': ['v1'], 'hyprland-lock-notify': ['v1'], } protocol_files = [] foreach name : protocols.keys() foreach version : protocols.get(name) protocol_files += [ 'protocols/@0@-@1@.xml'.format(name, version) ] endforeach endforeach foreach protocol_file : protocol_files protocol_install_dir = fs.parent(join_paths( get_option('datadir'), 'hyprland-protocols', protocol_file, )) install_data( protocol_file, install_dir: protocol_install_dir, ) endforeach hyprland_protocols_srcdir = meson.current_source_dir() pkgconfig_configuration = configuration_data() pkgconfig_configuration.set('prefix', get_option('prefix')) pkgconfig_configuration.set('datarootdir', '${prefix}/@0@'.format(get_option('datadir'))) pkgconfig_configuration.set('abs_top_srcdir', hyprland_protocols_srcdir) pkgconfig_configuration.set('PACKAGE', 'hyprland-protocols') pkgconfig_configuration.set('HYPRLAND_PROTOCOLS_VERSION', hyprland_protocols_version) pkg_install_dir = join_paths(get_option('datadir'), 'pkgconfig') configure_file( input: 'hyprland-protocols.pc.in', output: 'hyprland-protocols.pc', configuration: pkgconfig_configuration, install_dir: pkg_install_dir, ) hyprland_protocols = declare_dependency( variables: { 'pkgdatadir': hyprland_protocols_srcdir, }, ) meson.override_dependency('hyprland-protocols', hyprland_protocols) hyprland-protocols-0.6.2/nix/000077500000000000000000000000001476077476400162065ustar00rootroot00000000000000hyprland-protocols-0.6.2/nix/default.nix000066400000000000000000000006071476077476400203550ustar00rootroot00000000000000{ lib, stdenv, meson, ninja, version, }: stdenv.mkDerivation { pname = "hyprland-protocols"; inherit version; src = ../.; nativeBuildInputs = [meson ninja]; meta = { homepage = "https://github.com/hyprwm/hyprland-protocols"; description = "Wayland protocol extensions for Hyprland"; license = lib.licenses.bsd3; platforms = lib.platforms.linux; }; } hyprland-protocols-0.6.2/protocols/000077500000000000000000000000001476077476400174345ustar00rootroot00000000000000hyprland-protocols-0.6.2/protocols/hyprland-ctm-control-v1.xml000066400000000000000000000105111476077476400245600ustar00rootroot00000000000000 Copyright © 2024 Vaxry All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This protocol allows a client to control outputs' color transform matrix (CTM). This protocol is privileged and should not be exposed to unprivileged clients. This object is a manager which offers requests to control CTMs. If any changes are done, once this object is destroyed, CTMs are reset back to an identity matrix. Set a CTM for a wl_output. This state is not applied immediately; clients must call .commit to apply any pending changes. The provided values describe a 3x3 Row-Major CTM with values in the range of [0, ∞) Passing values outside of the range will raise an invalid_matrix error. The default value of the CTM is an identity matrix. If an output doesn't get a CTM set with set_ctm_for_output and commit is called, that output will get its CTM reset to an identity matrix. Commits the pending state(s) set by set_ctm_for_output. All objects created by the manager will still remain valid, until their appropriate destroy request has been called. The CTMs of all outputs will be reset to an identity matrix. This event is sent if another manager was bound by any client at the time the current manager was bound. Any set_ctm_for_output requests from a blocked manager will be silently ignored by the compositor. The client should destroy the manager after receiving this event. hyprland-protocols-0.6.2/protocols/hyprland-focus-grab-v1.xml000066400000000000000000000125071476077476400243560ustar00rootroot00000000000000 Copyright © 2024 outfoxxed All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This protocol allows clients to limit input focus to a specific set of surfaces and receive a notification when the limiter is removed as detailed below. This interface allows a client to create surface grab objects. Create a surface grab object. Destroy the focus grab manager. This doesn't destroy existing focus grab objects. This interface restricts input focus to a specified whitelist of surfaces as long as the focus grab object exists and has at least one comitted surface. Mouse and touch events inside a whitelisted surface will be passed to the surface normally, while events outside of a whitelisted surface will clear the grab object. Keyboard events will be passed to the client and a compositor-picked surface in the whitelist will receive a wl_keyboard::enter event if a whitelisted surface is not already entered. Upon meeting implementation-defined criteria usually meaning a mouse or touch input outside of any whitelisted surfaces, the compositor will clear the whitelist, rendering the grab inert and sending the cleared event. The same will happen if another focus grab or similar action is started at the compositor's discretion. Add a surface to the whitelist. Destroying the surface is treated the same as an explicit call to remove_surface and duplicate additions are ignored. Does not take effect until commit is called. Remove a surface from the whitelist. Destroying the surface is treated the same as an explicit call to this function. If the grab was active and the removed surface was entered by the keyboard, another surface will be entered on commit. Does not take effect until commit is called. Commit pending changes to the surface whitelist. If the list previously had no entries and now has at least one, the grab will start. If it previously had entries and now has none, the grab will become inert. Destroy the grab object and remove the grab if active. Sent when an active grab is cancelled by the compositor, regardless of cause. hyprland-protocols-0.6.2/protocols/hyprland-global-shortcuts-v1.xml000066400000000000000000000115441476077476400256220ustar00rootroot00000000000000 Copyright © 2022 Vaxry All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This protocol allows a client to register triggerable actions, meant to be global shortcuts. This object is a manager which offers requests to create global shortcuts. Register a new global shortcut. A global shortcut is anonymous, meaning the app does not know what key(s) trigger it. The shortcut's keybinding shall be dealt with by the compositor. In the case of a duplicate app_id + id combination, the already_taken protocol error is raised. All objects created by the manager will still remain valid, until their appropriate destroy request has been called. This object represents a single shortcut. The keystroke was pressed. tv_ values hold the timestamp of the occurrence. The keystroke was released. tv_ values hold the timestamp of the occurrence. Destroys the shortcut. Can be sent at any time by the client. hyprland-protocols-0.6.2/protocols/hyprland-lock-notify-v1.xml000066400000000000000000000102701476077476400245570ustar00rootroot00000000000000 Copyright © 2025 Maximilian Seidler All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This interface allows clients to monitor whether the wayland session is locked or unlocked. Destroy the manager object. All objects created via this interface remain valid. Create a new lock notification object. If the session is already locked when calling this method, the locked event shall be sent immediately. This interface is used by the compositor to send lock notification events to clients. Typically the "locked" and "unlocked" events are emitted when a client locks/unlocks the session via ext-session-lock, but the compositor may choose to send notifications for any other locking mechanisms. The compositor must notfiy after possible transition periods between locked and unlocked states of the session. In the context of ext-session-lock, that means the "locked" event is expected to be sent after the session-lock client has presented a lock screen frame on every output, which corresponds to the "locked" event of ext-session-lock. Destroy the notification object. This event is sent when the wayland session is locked. It's a compositor protocol error to send this event twice without an unlock event in-between. This event is sent when the wayland session is unlocked. It's a compositor protocol error to send this event twice without an locked event in-between. It's a compositor protocol error to send this event prior to any locked event. hyprland-protocols-0.6.2/protocols/hyprland-surface-v1.xml000066400000000000000000000132101476077476400237460ustar00rootroot00000000000000 Copyright © 2025 outfoxxed All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This protocol exposes hyprland-specific wl_surface properties. This interface allows a client to create hyprland surface objects. Create a hyprland surface object for the given wayland surface. If the wl_surface already has an associated hyprland_surface_v1 object, even from a different manager, creation is a protocol error. Destroy the surface manager. This does not destroy existing surface objects. This interface allows access to hyprland-specific properties of a wl_surface. Once the wl_surface has been destroyed, the hyprland surface object must be destroyed as well. All other operations are a protocol error. Sets a multiplier for the overall opacity of the surface. This multiplier applies to visual effects such as blur behind the surface in addition to the surface's content. The default value is 1.0. Setting a value outside of the range 0.0 - 1.0 (inclusive) is a protocol error. Does not take effect until wl_surface.commit is called. Destroy the hyprland surface object, resetting properties provided by this interface to their default values on the next wl_surface.commit. This request sets the region of the surface that contains visible content. Visible content refers to content that has an alpha value greater than zero. The visible region is an optimization hint for the compositor that lets it avoid drawing parts of the surface that are not visible. Setting a visible region that does not contain all content in the surface may result in missing content not being drawn. The visible region is specified in buffer-local coordinates. The compositor ignores the parts of the visible region that fall outside of the surface. When all parts of the region fall outside of the buffer geometry, the compositor may avoid rendering the surface entirely. The initial value for the visible region is empty. Setting the visible region has copy semantics, and the wl_region object can be destroyed immediately. A NULL wl_region causes the visible region to be set to empty. Does not take effect until wl_surface.commit is called. hyprland-protocols-0.6.2/protocols/hyprland-toplevel-export-v1.xml000066400000000000000000000240051476077476400254730ustar00rootroot00000000000000 Copyright © 2022 Vaxry All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This protocol allows clients to ask for exporting another toplevel's surface(s) to a buffer. Particularly useful for sharing a single window. This object is a manager which offers requests to start capturing from a source. Capture the next frame of a toplevel. (window) The captured frame will not contain any server-side decorations and will ignore the compositor-set geometry, like e.g. rounded corners. It will contain all the subsurfaces and popups, however the latter will be clipped to the geometry of the base surface. The handle parameter refers to the address of the window as seen in `hyprctl clients`. For example, for d161e7b0 it would be 3512854448. All objects created by the manager will still remain valid, until their appropriate destroy request has been called. Same as capture_toplevel, but with a zwlr_foreign_toplevel_handle_v1 handle. 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. 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 the correct size, see hyprland_toplevel_export_frame_v1.buffer and hyprland_toplevel_export_frame_v1.linux_dmabuf. The buffer needs to have a supported format. If the frame is successfully copied, a "flags" and a "ready" event is sent. Otherwise, a "failed" event is sent. This event will wait for appropriate damage to be copied, unless the ignore_damage arg is set to a non-zero value. This event is sent right before the ready event when ignore_damage was not set. It may be generated multiple times for each copy 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 and a ready event is the total damage since the prior ready event. 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. 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.