COSMIC screencopy v1

Create a capturing session for an output.

It is a protocol error to request a cursor mode that was not previously advertised by the compositor (see `supported_cursor_mode` event).

Create a capturing session for an entire workspace.

An output must be provided that has previously been associated with the given workspace through an `output_enter` event (see cosmic-workspace-unstable-v1).

If the provided output is not associated with the workspace at the time this request is send, the capture will failed with `invalid_output` until a new association is established.

It is a protocol error to request a cursor mode that was not previously advertised by the compositor (see `supported_cursor_mode` event).

Create a capturing session for a toplevel.

It is a protocol error to request a cursor mode that was not previously advertised by the compositor (see `supported_cursor_mode` event).

Immediately after initialization of the zcosmic_screencopy_manager_v1 global, it will send supported_cursor_mode events to notify the client about supported cursor modes.

Creates a sub-session used to capture the cursor of a given seat. Using this request, when the server did not indicate support through a `supported_cursor_mode` event with the value `capture` is a protocol error.

The sub-session will not generate cursor_enter or cursor_leave events. It will generate a single cursor_info event for the captured seat, if the cursor previously entered the session, or no cursor_info event. The event will be identical to the matching cursor_info event generated on the main session.

The buffer_info provided by the compositor can be different to the supported buffers for the main session and can also be different for each captured seat.

Sub-session will never send a `commit_time` or `ready` event, but are considered ready and displayed in tandem with their main-session.

Attach a buffer to the surface.

Commit the screencopy session.

The frame will be copied to the session. A ready event is generated when the buffer is ready.

If the "on_damage" flag is set, the compositor should wait sending new frames to the client until there is damage.

Destroys the surface. This request can be sent at any time by the client.

Provides information about buffer parameters that need to be used for the main image. This event is sent for every supported buffer type after the session is created.

The stride parameter is invalid for dmabuf and may be set to 0.

This event is sent once when all buffer info events have been sent.

This event is sent before the ready event and holds transformations of the source buffer.

This event is sent before the ready event. It may be generated multiple times for each commit.

The arguments describe a box around an area that has changed since the last ready event.

These coordinates originate in the upper left corner of the buffer.

Sent when a cursor enters the captured surface. It shall be generated before the "cursor_info" event when and only when a cursor enters the surface.

Sent when a cursor leaves the captured surface. No "cursor_info" event is generated for for the given cursor.

This event is generated for each cursor buffer that was attached to the session and for which the cursor is currently focused in the session. It is generated once for each cursor buffer before the ready event.

Cursors outside the surface do not get captured and no event will be generated for them.

If the cursor image has changed, the cursor buffer will have been updated and the "has_damage" argument will be set to 1; otherwise 0.

The given position is the position of the cursor's hotspot and it is relative to the main buffer's top left corner in transformed buffer pixel coordinates.

The hotspot coordinates are relative to the cursor buffers upper left corner.

This event indicates that the attempted frame copy has failed.

After receiving this event, the client must destroy the object.

This event indicates the time at which the frame is committed to be scanned out in system monotonic time.

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].

Called as soon as the frame is copied, indicating it is available for reading.