logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Author

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

X Version 11                                      libxcb 1.17.0                                 xcb_get_image(3)

Description

Errors

       This request does never generate any errors.

Name

       xcb_get_image -

Reply Fields

response_type
                 The  type  of  this  reply,  in  this  case  XCB_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     TODO: NOT YET DOCUMENTED.

       visual    TODO: NOT YET DOCUMENTED.

Request Arguments

conn      The XCB connection to X11.

       format    One of the following values:

                 XCB_IMAGE_FORMAT_XY_BITMAP
                           TODO: NOT YET DOCUMENTED.

                 XCB_IMAGE_FORMAT_XY_PIXMAP
                           TODO: NOT YET DOCUMENTED.

                 XCB_IMAGE_FORMAT_Z_PIXMAP
                           TODO: NOT YET DOCUMENTED.
                 TODO: NOT YET DOCUMENTED.

       drawable  TODO: NOT YET DOCUMENTED.

       x         TODO: NOT YET DOCUMENTED.

       y         TODO: NOT YET DOCUMENTED.

       width     TODO: NOT YET DOCUMENTED.

       height    TODO: NOT YET DOCUMENTED.

       plane_mask
                 TODO: NOT YET DOCUMENTED.

Return Value

       Returns an xcb_get_image_cookie_t. Errors have to be handled when calling the reply function  xcb_get_im‐age_reply.

       If  you want to handle errors in the event loop instead, use xcb_get_image_unchecked. See xcb-requests(3)
       for details.

See Also

Synopsis

#include<xcb/xproto.h>Requestfunction

       xcb_get_image_cookie_t xcb_get_image(xcb_connection_t *conn, uint8_t format, xcb_drawable_t drawable,
              int16_t x, int16_t y, uint16_t width, uint16_t height, uint32_t plane_mask);

   Replydatastructure
       typedef struct xcb_get_image_reply_t {
           uint8_t        response_type;
           uint8_t        depth;
           uint16_t       sequence;
           uint32_t       length;
           xcb_visualid_t visual;
           uint8_t        pad0[20];
       } xcb_get_image_reply_t;

   Replyfunction

       xcb_get_image_reply_t *xcb_get_image_reply(xcb_connection_t *conn, xcb_get_image_cookie_t cookie,
              xcb_generic_error_t **e);

   Replyaccessors

       uint8_t *xcb_get_image_data(const xcb_get_image_request_t *reply);

       int xcb_get_image_data_length(const xcb_get_image_reply_t *reply);

       xcb_generic_iterator_t xcb_get_image_data_end(const xcb_get_image_reply_t *reply);

See Also