xcb_glx_read_pixels(3)

1xcb_glx_read_pixels(3)           XCB Requests           xcb_glx_read_pixels(3)
2
3
4

NAME

6       xcb_glx_read_pixels -
7

SYNOPSIS

9       #include <xcb/glx.h>
10
11   Request function
12       xcb_glx_read_pixels_cookie_t
13              xcb_glx_read_pixels(xcb_connection_t *conn,
14              xcb_glx_context_tag_t context_tag, int32_t x, int32_t y,
15              int32_t width, int32_t height, uint32_t format, uint32_t type,
16              uint8_t swap_bytes, uint8_t lsb_first);
17
18   Reply datastructure
19       typedef struct xcb_glx_read_pixels_reply_t {
20           uint8_t  response_type;
21           uint8_t  pad0;
22           uint16_t sequence;
23           uint32_t length;
24           uint8_t  pad1[24];
25       } xcb_glx_read_pixels_reply_t;
26
27   Reply function
28       xcb_glx_read_pixels_reply_t
29              *xcb_glx_read_pixels_reply(xcb_connection_t *conn,
30              xcb_glx_read_pixels_cookie_t cookie, xcb_generic_error_t **e);
31
32   Reply accessors
33       uint8_t *xcb_glx_read_pixels_data(const xcb_glx_read_pixels_request_t
34              *reply);
35
36       int xcb_glx_read_pixels_data_length(const xcb_glx_read_pixels_reply_t
37              *reply);
38
39       xcb_generic_iterator_t xcb_glx_read_pixels_data_end(const
40              xcb_glx_read_pixels_reply_t *reply);
41

REQUEST ARGUMENTS

43       conn      The XCB connection to X11.
44
45       context_tag
46                 TODO: NOT YET DOCUMENTED.
47
48       x         TODO: NOT YET DOCUMENTED.
49
50       y         TODO: NOT YET DOCUMENTED.
51
52       width     TODO: NOT YET DOCUMENTED.
53
54       height    TODO: NOT YET DOCUMENTED.
55
56       format    TODO: NOT YET DOCUMENTED.
57
58       type      TODO: NOT YET DOCUMENTED.
59
60       swap_bytes
61                 TODO: NOT YET DOCUMENTED.
62
63       lsb_first TODO: NOT YET DOCUMENTED.
64

REPLY FIELDS

66       response_type
67                 The type of this reply, in this case XCB_GLX_READ_PIXELS.
68                 This field is also present in the xcb_generic_reply_t and can
69                 be used to tell replies apart from each other.
70
71       sequence  The sequence number of the last request processed by the X11
72                 server.
73
74       length    The length of the reply, in words (a word is 4 bytes).
75

DESCRIPTION

RETURN VALUE

78       Returns an xcb_glx_read_pixels_cookie_t. Errors have to be handled when
79       calling the reply function xcb_glx_read_pixels_reply.
80
81       If you want to handle errors in the event loop instead, use
82       xcb_glx_read_pixels_unchecked. See xcb-requests(3) for details.
83

ERRORS

85       This request does never generate any errors.
86

AUTHOR

89       Generated from glx.xml. Contact xcb@lists.freedesktop.org for correc‐
90       tions and improvements.
91
92
93
94X Version 11                      libxcb 1.13           xcb_glx_read_pixels(3)