xcb_composite_get_overlay_window - Man Page

#include <xcb/composite.h>

typedef struct xcb_composite_get_overlay_window_reply_t {
    uint8_t      response_type;
    uint8_t      pad0;
    uint16_t     sequence;
    uint32_t     length;
    xcb_window_t overlay_win;
    uint8_t      pad1[20];
} xcb_composite_get_overlay_window_reply_t;

conn

The XCB connection to X11.

window

TODO: NOT YET DOCUMENTED.

response_type

The type of this reply, in this case XCB_COMPOSITE_GET_OVERLAY_WINDOW. 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).

overlay_win

TODO: NOT YET DOCUMENTED.

Returns an xcb_composite_get_overlay_window_cookie_t. Errors have to be handled when calling the reply function xcb_composite_get_overlay_window_reply.

If you want to handle errors in the event loop instead, use xcb_composite_get_overlay_window_unchecked. See xcb-requests(3) for details.

This request does never generate any errors.

Generated from composite.xml. Contact xcb@lists.freedesktop.org for corrections and improvements.

The man pages xcb_composite_get_overlay_window_reply(3) and xcb_composite_get_overlay_window_unchecked(3) are aliases of xcb_composite_get_overlay_window(3).