Wlr_screencopy_unstable_v1_server.Zwlr_screencopy_frame_v1A frame ready for copy.
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.
For objects version 2 or lower, 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.
type 'v t = ([ `Zwlr_screencopy_frame_v1 ], 'v, [ `Server ]) Wayland.Proxy.tval failed : [< `V1 | `V2 | `V3 ] t -> unitFrame copy failed.
This event indicates that the attempted frame copy has failed.
After receiving this event, the client should destroy the object.
val ready :
[< `V1 | `V2 | `V3 ] t ->
tv_sec_hi:int32 ->
tv_sec_lo:int32 ->
tv_nsec:int32 ->
unitIndicates frame is available for reading.
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.
val flags : [< `V1 | `V2 | `V3 ] t -> flags:int32 -> unitFrame flags.
Provides flags about the frame. This event is sent once before the "ready" event.
val buffer :
[< `V1 | `V2 | `V3 ] t ->
format:{Imports}1.Wl_shm.Format.t ->
width:int32 ->
height:int32 ->
stride:int32 ->
unitWl_shm buffer information.
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.
val damage :
[< `V2 | `V3 ] t ->
x:int32 ->
y:int32 ->
width:int32 ->
height:int32 ->
unitCarries the coordinates of the damaged region.
This event is sent right before the ready event when copy_with_damage is requested. It may be generated multiple times for each copy_with_damage 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_with_damage and a ready event is the total damage since the prior ready event.
val buffer_done : [< `V3 ] t -> unitAll buffer types reported.
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.
val linux_dmabuf :
[< `V3 ] t ->
format:int32 ->
width:int32 ->
height:int32 ->
unitLinux-dmabuf buffer information.
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.
Note: Servers will always want to use v1.
class virtual +'a v1 : object ... endHandler for a proxy with version >= 1.
class virtual +'a v2 : object ... endHandler for a proxy with version >= 2.
class virtual +'a v3 : object ... endHandler for a proxy with version >= 3.