package wayland

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Manager to inform clients and begin capturing.

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

type 'v t = ([ `Zwlr_screencopy_manager_v1 ], 'v, [ `Client ]) Wayland.Proxy.t

Version 1, 2, 3

val destroy : [< `V1 | `V2 | `V3 ] t -> unit

Destroy the manager.

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

val capture_output_region : [< `V1 | `V2 | `V3 ] as 'a t -> [[ `Zwlr_screencopy_frame_v1 ], 'b, [ `Client ]] Wayland.Proxy.Handler.t -> overlay_cursor:int32 -> output:([ `Wl_output ], 'c, [ `Client ]) Wayland.Proxy.t -> x:int32 -> y:int32 -> width:int32 -> height:int32 -> ([ `Zwlr_screencopy_frame_v1 ], 'd, [ `Client ]) Wayland.Proxy.t

Capture an output's region.

Capture the next frame of an output's region.

The region is given in output logical coordinates, see xdg_output.logical_size. The region will be clipped to the output's extents.

val capture_output : [< `V1 | `V2 | `V3 ] as 'a t -> [[ `Zwlr_screencopy_frame_v1 ], 'b, [ `Client ]] Wayland.Proxy.Handler.t -> overlay_cursor:int32 -> output:([ `Wl_output ], 'c, [ `Client ]) Wayland.Proxy.t -> ([ `Zwlr_screencopy_frame_v1 ], 'd, [ `Client ]) Wayland.Proxy.t

Capture an output.

Capture the next frame of an entire output.

Handlers

Note: Servers will always want to use v1.

class +'a v1 : object ... end

Handler for a proxy with version >= 1.

class +'a v2 : object ... end

Handler for a proxy with version >= 2.

class +'a v3 : object ... end

Handler for a proxy with version >= 3.