xcb_shm_get_image(3)

NAME
xcb_shm_get_image - Copies data from the specified drawable to the shared memory segment.

SYNOPSIS
#include <xcb/shm.h>

  Request function

xcb_shm_get_image_cookie_t xcb_shm_get_image(xcb_connection_t *conn, xcb_drawable_t drawable, int16_t x, int16_t y, uint16_t width, uint16_t height, uint32_t plane_mask, uint8_t format, xcb_shm_seg_t shmseg, uint32_t offset);

  Reply datastructure

typedef struct xcb_shm_get_image_reply_t {
    uint8_t        response_type;
    uint8_t        depth;
    uint16_t       sequence;
    uint32_t       length;
    xcb_visualid_t visual;
    uint32_t       size;
} xcb_shm_get_image_reply_t;

  Reply function

xcb_shm_get_image_reply_t *xcb_shm_get_image_reply(xcb_connection_t *conn, xcb_shm_get_image_cookie_t cookie, xcb_generic_error_t **e);

REQUEST ARGUMENTS

conn
    The XCB connection to X11.

drawable
    The drawable to copy the image out of.

x   The X coordinate in the drawable to begin copying at.

y   The Y coordinate in the drawable to begin copying at.

width
    The width of the image to copy.

height
    The height of the image to copy.

plane_mask
    A mask that determines which planes are used.

format
    The format to use for the copy (???).

shmseg
    The destination shared memory segment.

offset
    The offset in the shared memory segment to copy data to.

REPLY FIELDS

response_type
    The type of this reply, in this case XCB_SHM_GET_IMAGE. This field is also present in the xcb_generic_reply_t and can be used to tell replies apart from each other.

sequence
    The sequence number of the last request processed by the X11 server.

length
    The length of the reply, in words (a word is 4 bytes).

depth
    The depth of the source drawable.

visual
    The visual ID of the source drawable.

size
    The number of bytes copied.

DESCRIPTION
Copy data from the specified drawable to the shared memory segment. The amount of bytes written to the destination image is always equal to the number of bytes read from the shared memory segment.

RETURN VALUE
Returns an xcb_shm_get_image_cookie_t. Errors have to be handled when calling the reply function xcb_shm_get_image_reply. If you want to handle errors in the event loop instead, use xcb_shm_get_image_unchecked. See xcb-requests(3) for details.

ERRORS
This request does never generate any errors.

SEE ALSO
xcb-requests(3)

AUTHOR
Generated from shm.xml. Contact xcb@lists.freedesktop.org for corrections and improvements.