Skip to content

hyprland_toplevel_export_manager_v1¤

wayland.hyprland_toplevel_export_manager_v1 ¤

Manager to inform clients and begin capturing

This object is a manager which offers requests to start capturing from a source.

Methods:

capture_toplevel ¤

capture_toplevel(overlay_cursor: int, handle: int) -> hyprland_toplevel_export_frame_v1

Capture a toplevel

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.

Parameters:

  • overlay_cursor ¤

    (int) –

    Composite cursor onto the frame

  • handle ¤

    (int) –

    The handle of the toplevel (window) to be captured

Returns:

destroy ¤

destroy() -> None

Destroy the manager

All objects created by the manager will still remain valid, until their appropriate destroy request has been called.

capture_toplevel_with_wlr_toplevel_handle ¤

capture_toplevel_with_wlr_toplevel_handle(
    overlay_cursor: int, handle: zwlr_foreign_toplevel_handle_v1
) -> hyprland_toplevel_export_frame_v1

Capture a toplevel

Same as capture_toplevel, but with a zwlr_foreign_toplevel_handle_v1 handle.

Parameters:

Returns: