Hyprland workspace image capture source
This protocol is a Hyprland extension for capturing workspace contents.
This manager can create ICC capture sources from ext-workspace handles.
create_source(source: new_id<ext_image_capture_source_v1>, workspace: object<ext_workspace_handle_v1>, mode: uint<hyprland_workspace_image_capture_source_manager_v1.capture_mode>)
Argument | Type | Description |
|---|---|---|
| source | new_id<ext_image_capture_source_v1> | new workspace image capture source |
| workspace | object<ext_workspace_handle_v1> | workspace to capture |
| mode | uint<hyprland_workspace_image_capture_source_manager_v1.capture_mode> | content to include in the source image |
Create an ICC capture source from a given workspace handle.
This source does not own the workspace handle. If the workspace is removed, further attempts to share this source's contents will produce a transparent, empty image.
destroy()
Destroy this manager. Sources and capture sessions created through this manager remain valid after its destruction.
capture_mode { windows_only, everything }
Argument | Value | Description |
|---|---|---|
| windows_only | 0 | workspace windows only Include only the selected workspace's windows and their associated surfaces and decorations. The background will be transparent. |
| everything | 1 | workspace windows and output-global desktop elements Include the selected workspace's windows together with wallpaper, panels, pinned windows, and other output-global surfaces, including layer-shell surfaces, associated with its output. |
This enum describes the allowed capture modes.
error { invalid_mode }
Argument | Value | Description |
|---|---|---|
| invalid_mode | 0 | unknown capture mode |
Compositor Support
Copyright
Copyright © 2026 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.