wlr_screencopy_unstable_v1

• # zwlr_screencopy_manager_v1

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

  Requests

  • #

    capture_output

    capture an output
    struct zwlr_screencopy_frame_v1* zwlr_screencopy_manager_v1_capture_output(

    struct zwlr_screencopy_manager_v1* zwlr_screencopy_manager_v1,

    int32_t overlay_cursor, /* composite cursor onto the frame */

    struct wl_output* output

    )
    Capture the next frame of an entire output.
  • #

    capture_output_region

    capture an output's region
    struct zwlr_screencopy_frame_v1* zwlr_screencopy_manager_v1_capture_output_region(

    struct zwlr_screencopy_manager_v1* zwlr_screencopy_manager_v1,

    int32_t overlay_cursor, /* composite cursor onto the frame */

    struct wl_output* output,

    int32_t x,

    int32_t y,

    int32_t width,

    int32_t height

    )
    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.
  • #

    destroy

    destroy the manager
    void zwlr_screencopy_manager_v1_destroy(

    struct zwlr_screencopy_manager_v1* zwlr_screencopy_manager_v1

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

• # zwlr_screencopy_frame_v1

  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.

  Requests

  • #

    copy

    copy the frame
    void zwlr_screencopy_frame_v1_copy(

    struct zwlr_screencopy_frame_v1* zwlr_screencopy_frame_v1,

    struct wl_buffer* buffer

    )
    Copy the frame to the supplied buffer. The buffer must have a 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, a "flags" and a "ready" events are sent. Otherwise, a "failed" event is sent.
  • #

    destroy

    delete this object, used or not
    void zwlr_screencopy_frame_v1_destroy(

    struct zwlr_screencopy_frame_v1* zwlr_screencopy_frame_v1

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

    copy_with_damage

    copy the frame when it's damaged
    void zwlr_screencopy_frame_v1_copy_with_damage(

    struct zwlr_screencopy_frame_v1* zwlr_screencopy_frame_v1,

    struct wl_buffer* buffer

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

  Events

  • #

    buffer

    wl_shm buffer information
    uint32_t format /* buffer format */
    uint32_t width /* buffer width */
    uint32_t height /* buffer height */
    uint32_t stride /* buffer stride */
    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.
  • #

    flags

    frame flags
    uint32_t flags /* frame flags */
    Provides flags about the frame. This event is sent once before the "ready" event.
  • #

    ready

    indicates frame is available for reading
    uint32_t tv_sec_hi /* high 32 bits of the seconds part of the timestamp */
    uint32_t tv_sec_lo /* low 32 bits of the seconds part of the timestamp */
    uint32_t tv_nsec /* nanoseconds part of the timestamp */
    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.
  • #

    failed

    frame copy failed
    This event indicates that the attempted frame copy has failed. After receiving this event, the client should destroy the object.
  • #

    damage

    carries the coordinates of the damaged region
    uint32_t x /* damaged x coordinates */
    uint32_t y /* damaged y coordinates */
    uint32_t width /* current width */
    uint32_t height /* current height */
    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.
  • #

    linux_dmabuf

    linux-dmabuf buffer information
    uint32_t format /* fourcc pixel format */
    uint32_t width /* buffer width */
    uint32_t height /* buffer height */
    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.
  • #

    buffer_done

    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.

  Enums

  • #

    error
    ZWLR_SCREENCOPY_FRAME_V1_ERROR_ALREADY_USED /* the object has already been used to copy a wl_buffer */
    ZWLR_SCREENCOPY_FRAME_V1_ERROR_INVALID_BUFFER /* buffer attributes are invalid */
  • #

    flags
    ZWLR_SCREENCOPY_FRAME_V1_FLAGS_Y_INVERT /* contents are y-inverted */

Copyright Info