xcb_shm_get_image_unchecked(3)

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

NAME

6       xcb_shm_get_image -
7

SYNOPSIS

9       #include <xcb/shm.h>
10
11   Request function
12       xcb_shm_get_image_cookie_t xcb_shm_get_image(xcb_connection_t *conn,
13              xcb_drawable_t drawable, int16_t x, int16_t y, uint16_t width,
14              uint16_t height, uint32_t plane_mask, uint8_t format,
15              xcb_shm_seg_t shmseg, uint32_t offset);
16
17   Reply datastructure
18       typedef struct xcb_shm_get_image_reply_t {
19           uint8_t        response_type;
20           uint8_t        depth;
21           uint16_t       sequence;
22           uint32_t       length;
23           xcb_visualid_t visual;
24           uint32_t       size;
25       } xcb_shm_get_image_reply_t;
26
27   Reply function
28       xcb_shm_get_image_reply_t
29              *xcb_shm_get_image_reply(xcb_connection_t *conn,
30              xcb_shm_get_image_cookie_t cookie, xcb_generic_error_t **e);
31

REQUEST ARGUMENTS

33       conn      The XCB connection to X11.
34
35       drawable  TODO: NOT YET DOCUMENTED.
36
37       x         TODO: NOT YET DOCUMENTED.
38
39       y         TODO: NOT YET DOCUMENTED.
40
41       width     TODO: NOT YET DOCUMENTED.
42
43       height    TODO: NOT YET DOCUMENTED.
44
45       plane_mask
46                 TODO: NOT YET DOCUMENTED.
47
48       format    TODO: NOT YET DOCUMENTED.
49
50       shmseg    TODO: NOT YET DOCUMENTED.
51
52       offset    TODO: NOT YET DOCUMENTED.
53

REPLY FIELDS

55       response_type
56                 The type of this reply, in this case XCB_SHM_GET_IMAGE. This
57                 field is also present in the xcb_generic_reply_t and can be
58                 used to tell replies apart from each other.
59
60       sequence  The sequence number of the last request processed by the X11
61                 server.
62
63       length    The length of the reply, in words (a word is 4 bytes).
64
65       depth     TODO: NOT YET DOCUMENTED.
66
67       visual    TODO: NOT YET DOCUMENTED.
68
69       size      TODO: NOT YET DOCUMENTED.
70

DESCRIPTION

RETURN VALUE

73       Returns an xcb_shm_get_image_cookie_t. Errors have to be handled when
74       calling the reply function xcb_shm_get_image_reply.
75
76       If you want to handle errors in the event loop instead, use
77       xcb_shm_get_image_unchecked. See xcb-requests(3) for details.
78

ERRORS

80       This request does never generate any errors.
81

AUTHOR

84       Generated from shm.xml. Contact xcb@lists.freedesktop.org for correc‐
85       tions and improvements.
86
87
88
89X Version 11                      libxcb 1.12             xcb_shm_get_image(3)