xcb\_glx\_read\_pixels(3) XCB Requests xcb\_glx\_read\_pixels(3)

# [NAME](#NAME)

xcb\_glx\_read\_pixels -

# [SYNOPSIS](#SYNOPSIS)

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

## [Request function](#Request_function)

xcb\_glx\_read\_pixels\_cookie\_t **xcb\_glx\_read\_pixels**(xcb\_connection\_t \**conn*, xcb\_glx\_context\_tag\_t *context\_tag*, int32\_t *x*, int32\_t *y*, int32\_t *width*, int32\_t *height*, uint32\_t *format*, uint32\_t *type*, uint8\_t *swap\_bytes*, uint8\_t *lsb\_first*);

## [Reply datastructure](#Reply_datastructure)

```
typedef struct xcb_glx_read_pixels_reply_t {


    uint8_t  response_type;


    uint8_t  pad0;


    uint16_t sequence;


    uint32_t length;


    uint8_t  pad1[24];
} xcb_glx_read_pixels_reply_t;
```

## [Reply function](#Reply_function)

xcb\_glx\_read\_pixels\_reply\_t \***xcb\_glx\_read\_pixels\_reply**(xcb\_connection\_t \**conn*, xcb\_glx\_read\_pixels\_cookie\_t *cookie*, xcb\_generic\_error\_t \*\**e*);

## [Reply accessors](#Reply_accessors)

uint8\_t \***xcb\_glx\_read\_pixels\_data**(const xcb\_glx\_read\_pixels\_request\_t \**reply*);

int **xcb\_glx\_read\_pixels\_data\_length**(const xcb\_glx\_read\_pixels\_reply\_t \**reply*);

xcb\_generic\_iterator\_t **xcb\_glx\_read\_pixels\_data\_end**(const xcb\_glx\_read\_pixels\_reply\_t \**reply*);

# [REQUEST ARGUMENTS](#REQUEST_ARGUMENTS)

[*conn*](#conn)

The XCB connection to X11.

[*context\_tag*](#context_tag)

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.

[*format*](#format)

TODO: NOT YET DOCUMENTED.

[*type*](#type)

TODO: NOT YET DOCUMENTED.

[*swap\_bytes*](#swap_bytes)

TODO: NOT YET DOCUMENTED.

[*lsb\_first*](#lsb_first)

TODO: NOT YET DOCUMENTED.

# [REPLY FIELDS](#REPLY_FIELDS)

[*response\_type*](#response_type)

The type of this reply, in this case *XCB\_GLX\_READ\_PIXELS*. 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).

# [DESCRIPTION](#DESCRIPTION)

# [RETURN VALUE](#RETURN_VALUE)

Returns an *xcb\_glx\_read\_pixels\_cookie\_t*. Errors have to be handled when calling the reply function *xcb\_glx\_read\_pixels\_reply*.

If you want to handle errors in the event loop instead, use *xcb\_glx\_read\_pixels\_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 glx.xml. Contact xcb@lists.freedesktop.org for corrections and improvements.

libxcb 1.17.0 X Version 11

---

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