xcbgetimage(3) XCB Requests xcbgetimage(3)

NAME
       xcbgetimage -

SYNOPSIS
       #include 

   Request function
       xcbgetimagecookiet xcbgetimage(xcbconnectiont *conn,
              uint8t format, xcbdrawablet drawable, int16t x, int16t y,
              uint16t width, uint16t height, uint32t planemask);

   Reply datastructure
       typedef struct xcbgetimagereplyt {
           uint8t        responsetype;
           uint8t        depth;
           uint16t       sequence;
           uint32t       length;
           xcbvisualidt visual;
           uint8t        pad0[20];
       } xcbgetimagereplyt;

   Reply function
       xcbgetimagereplyt *xcbgetimagereply(xcbconnectiont *conn,
              xcbgetimagecookiet cookie, xcbgenericerrort **e);

   Reply accessors
       uint8t *xcbgetimagedata(const xcbgetimagerequestt *reply);

       int xcbgetimagedatalength(const xcbgetimagereplyt *reply);

       xcbgenericiteratort xcbgetimagedataend(const
              xcbgetimagereplyt *reply);

REQUEST ARGUMENTS
       conn      The XCB connection to X11.

       format    One of the following values:

                 XCBIMAGEFORMATXYBITMAP
                           TODO: NOT YET DOCUMENTED.

                 XCBIMAGEFORMATXYPIXMAP
                           TODO: NOT YET DOCUMENTED.

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

       planemask
                 TODO: NOT YET DOCUMENTED.

REPLY FIELDS
       responsetype
                 The type of this reply, in this case XCBGETIMAGE. This
                 field is also present in the xcbgenericreplyt 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.

DESCRIPTION
RETURN VALUE
       Returns an xcbgetimagecookiet. Errors have to be handled when call‐
       ing the reply function xcbgetimagereply.

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

ERRORS
       This request does never generate any errors.

SEE ALSO
AUTHOR
       Generated from xproto.xml. Contact xcb@lists.freedesktop.org for cor‐
       rections and improvements.



X Version 11                      libxcb 1.13                 xcbgetimage(3)