Skip to content

zwlr_screencopy_frame_v1¤

wayland.zwlr_screencopy_frame_v1 ¤

A 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" event 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.

Methods:

error ¤

flags ¤

events

buffer ¤

buffer(format: format, width: int, height: int, stride: int) -> None

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

Parameters:

  • format ¤

    (format) –

    Buffer format

  • width ¤

    (int) –

    Buffer width

  • height ¤

    (int) –

    Buffer height

  • stride ¤

    (int) –

    Buffer stride

flags ¤

flags(flags: flags) -> None

Frame flags

Provides flags about the frame. This event is sent once before the "ready" event.

Parameters:

ready ¤

ready(tv_sec_hi: int, tv_sec_lo: int, tv_nsec: int) -> None

Indicates 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 the presentation took place.

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.

Parameters:

  • tv_sec_hi ¤

    (int) –

    High 32 bits of the seconds part of the timestamp

  • tv_sec_lo ¤

    (int) –

    Low 32 bits of the seconds part of the timestamp

  • tv_nsec ¤

    (int) –

    Nanoseconds part of the timestamp

failed ¤

failed() -> None

Frame copy failed

This event indicates that the attempted frame copy has failed.

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

damage ¤

damage(x: int, y: int, width: int, height: int) -> None

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

Parameters:

  • x ¤

    (int) –

    Damaged x coordinates

  • y ¤

    (int) –

    Damaged y coordinates

  • width ¤

    (int) –

    Current width

  • height ¤

    (int) –

    Current height

linux_dmabuf ¤

linux_dmabuf(format: int, width: int, height: int) -> None

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

Parameters:

  • format ¤

    (int) –

    Fourcc pixel format

  • width ¤

    (int) –

    Buffer width

  • height ¤

    (int) –

    Buffer height

buffer_done ¤

buffer_done() -> None

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

copy ¤

copy(buffer: wl_buffer) -> None

Copy the frame

Copy the frame to the supplied buffer. The buffer must have the correct size, see zwlr_screencopy_frame_v1.buffer and zwlr_screencopy_frame_v1.linux_dmabuf. The buffer needs to have a supported format.

If the frame is successfully copied, "flags" and "ready" events are sent. Otherwise, a "failed" event is sent.

destroy ¤

destroy() -> None

Delete this object, used or not

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

copy_with_damage ¤

copy_with_damage(buffer: wl_buffer) -> None

Copy the frame when it's damaged

Same as copy, except it waits until there is damage to copy.

on_buffer ¤

on_buffer(format: format, width: int, height: int, stride: int) -> None

wl_shm buffer information.

Override to handle wayland.zwlr_screencopy_frame_v1.events.buffer.

on_flags ¤

on_flags(flags: flags) -> None

Frame flags.

Override to handle wayland.zwlr_screencopy_frame_v1.events.flags.

on_ready ¤

on_ready(tv_sec_hi: int, tv_sec_lo: int, tv_nsec: int) -> None

Indicates frame is available for reading.

Override to handle wayland.zwlr_screencopy_frame_v1.events.ready.

on_failed ¤

on_failed() -> None

Frame copy failed.

Override to handle wayland.zwlr_screencopy_frame_v1.events.failed.

on_damage ¤

on_damage(x: int, y: int, width: int, height: int) -> None

Carries the coordinates of the damaged region.

Override to handle wayland.zwlr_screencopy_frame_v1.events.damage.

on_linux_dmabuf ¤

on_linux_dmabuf(format: int, width: int, height: int) -> None

Linux-dmabuf buffer information.

Override to handle wayland.zwlr_screencopy_frame_v1.events.linux_dmabuf.

on_buffer_done ¤

on_buffer_done() -> None

All buffer types reported.

Override to handle wayland.zwlr_screencopy_frame_v1.events.buffer_done.