www.LinuxHowtos.org
xcb_shape_get_rectangles
Section: XCB Requests (3)Updated: libxcb 1.12
Index Return to Main Contents
NAME
xcb_shape_get_rectangles -SYNOPSIS
#include <xcb/shape.h>Request function
- xcb_shape_get_rectangles_cookie_t xcb_shape_get_rectangles(xcb_connection_t *conn, xcb_window_t window, xcb_shape_kind_t source_kind);
Reply datastructure
typedef struct xcb_shape_get_rectangles_reply_t {
uint8_t response_type;
uint8_t ordering;
uint16_t sequence;
uint32_t length;
uint32_t rectangles_len;
uint8_t pad0[20];
} xcb_shape_get_rectangles_reply_t;
Reply function
- xcb_shape_get_rectangles_reply_t *xcb_shape_get_rectangles_reply(xcb_connection_t *conn, xcb_shape_get_rectangles_cookie_t cookie, xcb_generic_error_t **e);
Reply accessors
- xcb_rectangle_t *xcb_shape_get_rectangles_rectangles(const xcb_shape_get_rectangles_request_t *reply);
- int xcb_shape_get_rectangles_rectangles_length(const xcb_shape_get_rectangles_reply_t *reply);
- xcb_rectangle_iterator_t xcb_shape_get_rectangles_rectangles_iterator(const xcb_shape_get_rectangles_reply_t *reply);
REQUEST ARGUMENTS
- conn
- The XCB connection to X11.
- window
- TODO: NOT YET DOCUMENTED.
- source_kind
- TODO: NOT YET DOCUMENTED.
REPLY FIELDS
- response_type
- The type of this reply, in this case XCB_SHAPE_GET_RECTANGLES. This field is also present in the xcb_generic_reply_t and can be used to tell replies apart from each other.
- sequence
- The sequence number of the last request processed by the X11 server.
- length
- The length of the reply, in words (a word is 4 bytes).
- ordering
- TODO: NOT YET DOCUMENTED.
- rectangles_len
- TODO: NOT YET DOCUMENTED.
DESCRIPTION
RETURN VALUE
Returns an xcb_shape_get_rectangles_cookie_t. Errors have to be handled when calling the reply function xcb_shape_get_rectangles_reply.If you want to handle errors in the event loop instead, use xcb_shape_get_rectangles_unchecked. See xcb-requests(3) for details.
ERRORS
This request does never generate any errors.SEE ALSO
AUTHOR
Generated from shape.xml. Contact xcb@lists.freedesktop.org for corrections and improvements.