xcb\_get\_image(3) XCB Requests xcb\_get\_image(3)

# [NAME](#NAME)

xcb\_get\_image -

# [SYNOPSIS](#SYNOPSIS)

**#include <xcb/xproto.h>**

## [Request function](#Request_function)

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*);

## [Reply datastructure](#Reply_datastructure)

```
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;
```

## [Reply function](#Reply_function)

xcb\_get\_image\_reply\_t \***xcb\_get\_image\_reply**(xcb\_connection\_t \**conn*, xcb\_get\_image\_cookie\_t *cookie*, xcb\_generic\_error\_t \*\**e*);

## [Reply accessors](#Reply_accessors)

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*);

# [REQUEST ARGUMENTS](#REQUEST_ARGUMENTS)

[*conn*](#conn)

The XCB connection to X11.

[*format*](#format)

One of the following values:

[*XCB\_IMAGE\_FORMAT\_XY\_BITMAP*](#XCB_IMAGE_FORMAT_XY_BITMAP)

TODO: NOT YET DOCUMENTED.

[*XCB\_IMAGE\_FORMAT\_XY\_PIXMAP*](#XCB_IMAGE_FORMAT_XY_PIXMAP)

TODO: NOT YET DOCUMENTED.

[*XCB\_IMAGE\_FORMAT\_Z\_PIXMAP*](#XCB_IMAGE_FORMAT_Z_PIXMAP)

TODO: NOT YET DOCUMENTED.

TODO: NOT YET DOCUMENTED.

[*drawable*](#drawable)

TODO: NOT YET DOCUMENTED.

[*x*](#x)

TODO: NOT YET DOCUMENTED.

[*y*](#y)

TODO: NOT YET DOCUMENTED.

[*width*](#width)

TODO: NOT YET DOCUMENTED.

[*height*](#height)

TODO: NOT YET DOCUMENTED.

[*plane\_mask*](#plane_mask)

TODO: NOT YET DOCUMENTED.

# [REPLY FIELDS](#REPLY_FIELDS)

[*response\_type*](#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*](#sequence)

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

[*length*](#length)

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

[*depth*](#depth)

TODO: NOT YET DOCUMENTED.

[*visual*](#visual)

TODO: NOT YET DOCUMENTED.

# [DESCRIPTION](#DESCRIPTION)

# [RETURN VALUE](#RETURN_VALUE)

Returns an *xcb\_get\_image\_cookie\_t*. Errors have to be handled when calling the reply function *xcb\_get\_image\_reply*.

If you want to handle errors in the event loop instead, use *xcb\_get\_image\_unchecked*. See [**xcb-requests(3)**](/man/os/libxcb/xcb-requests.3) for details.

# [ERRORS](#ERRORS)

This request does never generate any errors.

# [SEE ALSO](#SEE_ALSO)

# [AUTHOR](#AUTHOR)

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

libxcb 1.17.0 X Version 11

---

Document: xcb_get_image_unchecked(3) from libxcb 1.17.0-r16 (Chainguard OS)
Source: https://gitlab.freedesktop.org/xorg/lib/libxcb.git