Hyprland toplevel export
This protocol allows clients to ask for exporting another toplevel's surface(s) to a buffer.
Particularly useful for sharing a single window.
hyprland_toplevel_export_manager_v1
This object is a manager which offers requests to start capturing from a source.
capture_toplevel(frame: new_id<hyprland_toplevel_export_frame_v1>, overlay_cursor: int, handle: uint)
Argument | Type | Description |
|---|---|---|
| frame | new_id<hyprland_toplevel_export_frame_v1> | |
| overlay_cursor | int | composite cursor onto the frame |
| handle | uint | the handle of the toplevel (window) to be captured |
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.
destroy()
All objects created by the manager will still remain valid, until their appropriate destroy request has been called.
capture_toplevel_with_wlr_toplevel_handle(frame: new_id<hyprland_toplevel_export_frame_v1>, overlay_cursor: int, handle: object<zwlr_foreign_toplevel_handle_v1>)
Argument | Type | Description |
|---|---|---|
| frame | new_id<hyprland_toplevel_export_frame_v1> | |
| overlay_cursor | int | composite cursor onto the frame |
| handle | object<zwlr_foreign_toplevel_handle_v1>allow null | the zwlr_foreign_toplevel_handle_v1 handle of the toplevel to be captured |
Same as capture_toplevel, but with a zwlr_foreign_toplevel_handle_v1 handle.
hyprland_toplevel_export_frame_v1
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.
copy(buffer: object<wl_buffer>, ignore_damage: int)
Argument | Type | Description |
|---|---|---|
| buffer | object<wl_buffer> | |
| ignore_damage | int |
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.
destroy()
Destroys the frame. This request can be sent at any time by the client.
buffer(format: uint<wl_shm.format>, width: uint, height: uint, stride: uint)
Argument | Type | Description |
|---|---|---|
| format | uint<wl_shm.format> | buffer format |
| width | uint | buffer width |
| height | uint | buffer height |
| stride | uint | buffer stride |
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.
Argument | Type | Description |
|---|---|---|
| x | uint | damaged x coordinates |
| y | uint | damaged y coordinates |
| width | uint | current width |
| height | uint | current height |
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.
flags(flags: uint<hyprland_toplevel_export_frame_v1.flags>)
Argument | Type | Description |
|---|---|---|
| flags | uint<hyprland_toplevel_export_frame_v1.flags> | frame flags |
Provides flags about the frame. This event is sent once before the "ready" event.
Argument | Type | Description |
|---|---|---|
| tv_sec_hi | uint | high 32 bits of the seconds part of the timestamp |
| tv_sec_lo | uint | low 32 bits of the seconds part of the timestamp |
| tv_nsec | uint | nanoseconds part of the timestamp |
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.
failed()
This event indicates that the attempted frame copy has failed.
After receiving this event, the client should destroy the object.
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.
buffer_done()
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.
error { already_used, invalid_buffer }
Argument | Value | Description |
|---|---|---|
| already_used | 0 | the object has already been used to copy a wl_buffer |
| invalid_buffer | 1 | buffer attributes are invalid |
Compositor Support
Mutter  47.3 | KWin  6.2 | Sway  1.10 | COSMIC  0.1 | Hyprland  0.42.0 | niri 25.01 | Weston  13 | Mir  2.19 | GameScope  3.15.14 | Jay 1.7.0 | |
|---|---|---|---|---|---|---|---|---|---|---|
| hyprland_toplevel_export_manager_v1 | x | x | x | x | 2 | x | x | x | x | x |
Copyright
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.