xcb_shape_get_rectangles_unchecked(3)

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

NAME

6       xcb_shape_get_rectangles -
7

SYNOPSIS

9       #include <xcb/shape.h>
10
11   Request function
12       xcb_shape_get_rectangles_cookie_t
13              xcb_shape_get_rectangles(xcb_connection_t *conn,
14              xcb_window_t window, xcb_shape_kind_t source_kind);
15
16   Reply datastructure
17       typedef struct xcb_shape_get_rectangles_reply_t {
18           uint8_t  response_type;
19           uint8_t  ordering;
20           uint16_t sequence;
21           uint32_t length;
22           uint32_t rectangles_len;
23           uint8_t  pad0[20];
24       } xcb_shape_get_rectangles_reply_t;
25
26   Reply function
27       xcb_shape_get_rectangles_reply_t
28              *xcb_shape_get_rectangles_reply(xcb_connection_t *conn,
29              xcb_shape_get_rectangles_cookie_t cookie,
30              xcb_generic_error_t **e);
31
32   Reply accessors
33       xcb_rectangle_t *xcb_shape_get_rectangles_rectangles(const
34              xcb_shape_get_rectangles_request_t *reply);
35
36       int xcb_shape_get_rectangles_rectangles_length(const
37              xcb_shape_get_rectangles_reply_t *reply);
38
39       xcb_rectangle_iterator_t
40              xcb_shape_get_rectangles_rectangles_iterator(const
41              xcb_shape_get_rectangles_reply_t *reply);
42

REQUEST ARGUMENTS

44       conn      The XCB connection to X11.
45
46       window    TODO: NOT YET DOCUMENTED.
47
48       source_kind
49                 TODO: NOT YET DOCUMENTED.
50

REPLY FIELDS

52       response_type
53                 The type of this reply, in this case XCB_SHAPE_GET_RECTAN‐
54                 GLES. This field is also present in the xcb_generic_reply_t
55                 and can be used to tell replies apart from each other.
56
57       sequence  The sequence number of the last request processed by the X11
58                 server.
59
60       length    The length of the reply, in words (a word is 4 bytes).
61
62       ordering  TODO: NOT YET DOCUMENTED.
63
64       rectangles_len
65                 TODO: NOT YET DOCUMENTED.
66

DESCRIPTION

RETURN VALUE

69       Returns an xcb_shape_get_rectangles_cookie_t. Errors have to be handled
70       when calling the reply function xcb_shape_get_rectangles_reply.
71
72       If you want to handle errors in the event loop instead, use
73       xcb_shape_get_rectangles_unchecked. See xcb-requests(3) for details.
74

ERRORS

76       This request does never generate any errors.
77

AUTHOR

80       Generated from shape.xml. Contact xcb@lists.freedesktop.org for correc‐
81       tions and improvements.
82
83
84
85X Version 11                      libxcb 1.13      xcb_shape_get_rectangles(3)