diff options
Diffstat (limited to 'libxcb/src/composite.h')
-rw-r--r-- | libxcb/src/composite.h | 728 |
1 files changed, 728 insertions, 0 deletions
diff --git a/libxcb/src/composite.h b/libxcb/src/composite.h new file mode 100644 index 000000000..3c97d27e9 --- /dev/null +++ b/libxcb/src/composite.h @@ -0,0 +1,728 @@ +/* + * This file generated automatically from composite.xml by c-client.xsl using XSLT. + * Edit at your peril. + */ + +/** + * @defgroup XCB_Composite_API XCB Composite API + * @brief Composite XCB Protocol Implementation. + * @{ + **/ + +#ifndef __COMPOSITE_H +#define __COMPOSITE_H + +#include "xcb.h" +#include "xproto.h" +#include "xfixes.h" + +#define XCB_COMPOSITE_MAJOR_VERSION 0 +#define XCB_COMPOSITE_MINOR_VERSION 3 + +extern xcb_extension_t xcb_composite_id; + +typedef enum xcb_composite_redirect_t { + XCB_COMPOSITE_REDIRECT_AUTOMATIC, + XCB_COMPOSITE_REDIRECT_MANUAL +} xcb_composite_redirect_t; + +/** + * @brief xcb_composite_query_version_cookie_t + **/ +typedef struct xcb_composite_query_version_cookie_t { + unsigned int sequence; /**< */ +} xcb_composite_query_version_cookie_t; + +/** Opcode for xcb_composite_query_version. */ +#define XCB_COMPOSITE_QUERY_VERSION 0 + +/** + * @brief xcb_composite_query_version_request_t + **/ +typedef struct xcb_composite_query_version_request_t { + uint8_t major_opcode; /**< */ + uint8_t minor_opcode; /**< */ + uint16_t length; /**< */ + uint32_t client_major_version; /**< */ + uint32_t client_minor_version; /**< */ +} xcb_composite_query_version_request_t; + +/** + * @brief xcb_composite_query_version_reply_t + **/ +typedef struct xcb_composite_query_version_reply_t { + uint8_t response_type; /**< */ + uint8_t pad0; /**< */ + uint16_t sequence; /**< */ + uint32_t length; /**< */ + uint32_t major_version; /**< */ + uint32_t minor_version; /**< */ + uint8_t pad1[16]; /**< */ +} xcb_composite_query_version_reply_t; + +/** Opcode for xcb_composite_redirect_window. */ +#define XCB_COMPOSITE_REDIRECT_WINDOW 1 + +/** + * @brief xcb_composite_redirect_window_request_t + **/ +typedef struct xcb_composite_redirect_window_request_t { + uint8_t major_opcode; /**< */ + uint8_t minor_opcode; /**< */ + uint16_t length; /**< */ + xcb_window_t window; /**< */ + uint8_t update; /**< */ + uint8_t pad0[3]; /**< */ +} xcb_composite_redirect_window_request_t; + +/** Opcode for xcb_composite_redirect_subwindows. */ +#define XCB_COMPOSITE_REDIRECT_SUBWINDOWS 2 + +/** + * @brief xcb_composite_redirect_subwindows_request_t + **/ +typedef struct xcb_composite_redirect_subwindows_request_t { + uint8_t major_opcode; /**< */ + uint8_t minor_opcode; /**< */ + uint16_t length; /**< */ + xcb_window_t window; /**< */ + uint8_t update; /**< */ + uint8_t pad0[3]; /**< */ +} xcb_composite_redirect_subwindows_request_t; + +/** Opcode for xcb_composite_unredirect_window. */ +#define XCB_COMPOSITE_UNREDIRECT_WINDOW 3 + +/** + * @brief xcb_composite_unredirect_window_request_t + **/ +typedef struct xcb_composite_unredirect_window_request_t { + uint8_t major_opcode; /**< */ + uint8_t minor_opcode; /**< */ + uint16_t length; /**< */ + xcb_window_t window; /**< */ + uint8_t update; /**< */ + uint8_t pad0[3]; /**< */ +} xcb_composite_unredirect_window_request_t; + +/** Opcode for xcb_composite_unredirect_subwindows. */ +#define XCB_COMPOSITE_UNREDIRECT_SUBWINDOWS 4 + +/** + * @brief xcb_composite_unredirect_subwindows_request_t + **/ +typedef struct xcb_composite_unredirect_subwindows_request_t { + uint8_t major_opcode; /**< */ + uint8_t minor_opcode; /**< */ + uint16_t length; /**< */ + xcb_window_t window; /**< */ + uint8_t update; /**< */ + uint8_t pad0[3]; /**< */ +} xcb_composite_unredirect_subwindows_request_t; + +/** Opcode for xcb_composite_create_region_from_border_clip. */ +#define XCB_COMPOSITE_CREATE_REGION_FROM_BORDER_CLIP 5 + +/** + * @brief xcb_composite_create_region_from_border_clip_request_t + **/ +typedef struct xcb_composite_create_region_from_border_clip_request_t { + uint8_t major_opcode; /**< */ + uint8_t minor_opcode; /**< */ + uint16_t length; /**< */ + xcb_xfixes_region_t region; /**< */ + xcb_window_t window; /**< */ +} xcb_composite_create_region_from_border_clip_request_t; + +/** Opcode for xcb_composite_name_window_pixmap. */ +#define XCB_COMPOSITE_NAME_WINDOW_PIXMAP 6 + +/** + * @brief xcb_composite_name_window_pixmap_request_t + **/ +typedef struct xcb_composite_name_window_pixmap_request_t { + uint8_t major_opcode; /**< */ + uint8_t minor_opcode; /**< */ + uint16_t length; /**< */ + xcb_window_t window; /**< */ + xcb_pixmap_t pixmap; /**< */ +} xcb_composite_name_window_pixmap_request_t; + +/** + * @brief xcb_composite_get_overlay_window_cookie_t + **/ +typedef struct xcb_composite_get_overlay_window_cookie_t { + unsigned int sequence; /**< */ +} xcb_composite_get_overlay_window_cookie_t; + +/** Opcode for xcb_composite_get_overlay_window. */ +#define XCB_COMPOSITE_GET_OVERLAY_WINDOW 7 + +/** + * @brief xcb_composite_get_overlay_window_request_t + **/ +typedef struct xcb_composite_get_overlay_window_request_t { + uint8_t major_opcode; /**< */ + uint8_t minor_opcode; /**< */ + uint16_t length; /**< */ + xcb_window_t window; /**< */ +} xcb_composite_get_overlay_window_request_t; + +/** + * @brief xcb_composite_get_overlay_window_reply_t + **/ +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; + +/** Opcode for xcb_composite_release_overlay_window. */ +#define XCB_COMPOSITE_RELEASE_OVERLAY_WINDOW 8 + +/** + * @brief xcb_composite_release_overlay_window_request_t + **/ +typedef struct xcb_composite_release_overlay_window_request_t { + uint8_t major_opcode; /**< */ + uint8_t minor_opcode; /**< */ + uint16_t length; /**< */ + xcb_window_t window; /**< */ +} xcb_composite_release_overlay_window_request_t; + +/** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + */ + +/***************************************************************************** + ** + ** xcb_composite_query_version_cookie_t xcb_composite_query_version + ** + ** @param xcb_connection_t *c + ** @param uint32_t client_major_version + ** @param uint32_t client_minor_version + ** @returns xcb_composite_query_version_cookie_t + ** + *****************************************************************************/ + +xcb_composite_query_version_cookie_t +xcb_composite_query_version (xcb_connection_t *c /**< */, + uint32_t client_major_version /**< */, + uint32_t client_minor_version /**< */); + +/** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + * This form can be used only if the request will cause + * a reply to be generated. Any returned error will be + * placed in the event queue. + */ + +/***************************************************************************** + ** + ** xcb_composite_query_version_cookie_t xcb_composite_query_version_unchecked + ** + ** @param xcb_connection_t *c + ** @param uint32_t client_major_version + ** @param uint32_t client_minor_version + ** @returns xcb_composite_query_version_cookie_t + ** + *****************************************************************************/ + +xcb_composite_query_version_cookie_t +xcb_composite_query_version_unchecked (xcb_connection_t *c /**< */, + uint32_t client_major_version /**< */, + uint32_t client_minor_version /**< */); + +/** + * Return the reply + * @param c The connection + * @param cookie The cookie + * @param e The xcb_generic_error_t supplied + * + * Returns the reply of the request asked by + * + * The parameter @p e supplied to this function must be NULL if + * xcb_composite_query_version_unchecked(). is used. + * Otherwise, it stores the error if any. + */ + +/***************************************************************************** + ** + ** xcb_composite_query_version_reply_t * xcb_composite_query_version_reply + ** + ** @param xcb_connection_t *c + ** @param xcb_composite_query_version_cookie_t cookie + ** @param xcb_generic_error_t **e + ** @returns xcb_composite_query_version_reply_t * + ** + *****************************************************************************/ + +xcb_composite_query_version_reply_t * +xcb_composite_query_version_reply (xcb_connection_t *c /**< */, + xcb_composite_query_version_cookie_t cookie /**< */, + xcb_generic_error_t **e /**< */); + +/** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + * This form can be used only if the request will not cause + * a reply to be generated. Any returned error will be + * saved for handling by xcb_request_check(). + */ + +/***************************************************************************** + ** + ** xcb_void_cookie_t xcb_composite_redirect_window_checked + ** + ** @param xcb_connection_t *c + ** @param xcb_window_t window + ** @param uint8_t update + ** @returns xcb_void_cookie_t + ** + *****************************************************************************/ + +xcb_void_cookie_t +xcb_composite_redirect_window_checked (xcb_connection_t *c /**< */, + xcb_window_t window /**< */, + uint8_t update /**< */); + +/** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + */ + +/***************************************************************************** + ** + ** xcb_void_cookie_t xcb_composite_redirect_window + ** + ** @param xcb_connection_t *c + ** @param xcb_window_t window + ** @param uint8_t update + ** @returns xcb_void_cookie_t + ** + *****************************************************************************/ + +xcb_void_cookie_t +xcb_composite_redirect_window (xcb_connection_t *c /**< */, + xcb_window_t window /**< */, + uint8_t update /**< */); + +/** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + * This form can be used only if the request will not cause + * a reply to be generated. Any returned error will be + * saved for handling by xcb_request_check(). + */ + +/***************************************************************************** + ** + ** xcb_void_cookie_t xcb_composite_redirect_subwindows_checked + ** + ** @param xcb_connection_t *c + ** @param xcb_window_t window + ** @param uint8_t update + ** @returns xcb_void_cookie_t + ** + *****************************************************************************/ + +xcb_void_cookie_t +xcb_composite_redirect_subwindows_checked (xcb_connection_t *c /**< */, + xcb_window_t window /**< */, + uint8_t update /**< */); + +/** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + */ + +/***************************************************************************** + ** + ** xcb_void_cookie_t xcb_composite_redirect_subwindows + ** + ** @param xcb_connection_t *c + ** @param xcb_window_t window + ** @param uint8_t update + ** @returns xcb_void_cookie_t + ** + *****************************************************************************/ + +xcb_void_cookie_t +xcb_composite_redirect_subwindows (xcb_connection_t *c /**< */, + xcb_window_t window /**< */, + uint8_t update /**< */); + +/** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + * This form can be used only if the request will not cause + * a reply to be generated. Any returned error will be + * saved for handling by xcb_request_check(). + */ + +/***************************************************************************** + ** + ** xcb_void_cookie_t xcb_composite_unredirect_window_checked + ** + ** @param xcb_connection_t *c + ** @param xcb_window_t window + ** @param uint8_t update + ** @returns xcb_void_cookie_t + ** + *****************************************************************************/ + +xcb_void_cookie_t +xcb_composite_unredirect_window_checked (xcb_connection_t *c /**< */, + xcb_window_t window /**< */, + uint8_t update /**< */); + +/** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + */ + +/***************************************************************************** + ** + ** xcb_void_cookie_t xcb_composite_unredirect_window + ** + ** @param xcb_connection_t *c + ** @param xcb_window_t window + ** @param uint8_t update + ** @returns xcb_void_cookie_t + ** + *****************************************************************************/ + +xcb_void_cookie_t +xcb_composite_unredirect_window (xcb_connection_t *c /**< */, + xcb_window_t window /**< */, + uint8_t update /**< */); + +/** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + * This form can be used only if the request will not cause + * a reply to be generated. Any returned error will be + * saved for handling by xcb_request_check(). + */ + +/***************************************************************************** + ** + ** xcb_void_cookie_t xcb_composite_unredirect_subwindows_checked + ** + ** @param xcb_connection_t *c + ** @param xcb_window_t window + ** @param uint8_t update + ** @returns xcb_void_cookie_t + ** + *****************************************************************************/ + +xcb_void_cookie_t +xcb_composite_unredirect_subwindows_checked (xcb_connection_t *c /**< */, + xcb_window_t window /**< */, + uint8_t update /**< */); + +/** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + */ + +/***************************************************************************** + ** + ** xcb_void_cookie_t xcb_composite_unredirect_subwindows + ** + ** @param xcb_connection_t *c + ** @param xcb_window_t window + ** @param uint8_t update + ** @returns xcb_void_cookie_t + ** + *****************************************************************************/ + +xcb_void_cookie_t +xcb_composite_unredirect_subwindows (xcb_connection_t *c /**< */, + xcb_window_t window /**< */, + uint8_t update /**< */); + +/** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + * This form can be used only if the request will not cause + * a reply to be generated. Any returned error will be + * saved for handling by xcb_request_check(). + */ + +/***************************************************************************** + ** + ** xcb_void_cookie_t xcb_composite_create_region_from_border_clip_checked + ** + ** @param xcb_connection_t *c + ** @param xcb_xfixes_region_t region + ** @param xcb_window_t window + ** @returns xcb_void_cookie_t + ** + *****************************************************************************/ + +xcb_void_cookie_t +xcb_composite_create_region_from_border_clip_checked (xcb_connection_t *c /**< */, + xcb_xfixes_region_t region /**< */, + xcb_window_t window /**< */); + +/** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + */ + +/***************************************************************************** + ** + ** xcb_void_cookie_t xcb_composite_create_region_from_border_clip + ** + ** @param xcb_connection_t *c + ** @param xcb_xfixes_region_t region + ** @param xcb_window_t window + ** @returns xcb_void_cookie_t + ** + *****************************************************************************/ + +xcb_void_cookie_t +xcb_composite_create_region_from_border_clip (xcb_connection_t *c /**< */, + xcb_xfixes_region_t region /**< */, + xcb_window_t window /**< */); + +/** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + * This form can be used only if the request will not cause + * a reply to be generated. Any returned error will be + * saved for handling by xcb_request_check(). + */ + +/***************************************************************************** + ** + ** xcb_void_cookie_t xcb_composite_name_window_pixmap_checked + ** + ** @param xcb_connection_t *c + ** @param xcb_window_t window + ** @param xcb_pixmap_t pixmap + ** @returns xcb_void_cookie_t + ** + *****************************************************************************/ + +xcb_void_cookie_t +xcb_composite_name_window_pixmap_checked (xcb_connection_t *c /**< */, + xcb_window_t window /**< */, + xcb_pixmap_t pixmap /**< */); + +/** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + */ + +/***************************************************************************** + ** + ** xcb_void_cookie_t xcb_composite_name_window_pixmap + ** + ** @param xcb_connection_t *c + ** @param xcb_window_t window + ** @param xcb_pixmap_t pixmap + ** @returns xcb_void_cookie_t + ** + *****************************************************************************/ + +xcb_void_cookie_t +xcb_composite_name_window_pixmap (xcb_connection_t *c /**< */, + xcb_window_t window /**< */, + xcb_pixmap_t pixmap /**< */); + +/** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + */ + +/***************************************************************************** + ** + ** xcb_composite_get_overlay_window_cookie_t xcb_composite_get_overlay_window + ** + ** @param xcb_connection_t *c + ** @param xcb_window_t window + ** @returns xcb_composite_get_overlay_window_cookie_t + ** + *****************************************************************************/ + +xcb_composite_get_overlay_window_cookie_t +xcb_composite_get_overlay_window (xcb_connection_t *c /**< */, + xcb_window_t window /**< */); + +/** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + * This form can be used only if the request will cause + * a reply to be generated. Any returned error will be + * placed in the event queue. + */ + +/***************************************************************************** + ** + ** xcb_composite_get_overlay_window_cookie_t xcb_composite_get_overlay_window_unchecked + ** + ** @param xcb_connection_t *c + ** @param xcb_window_t window + ** @returns xcb_composite_get_overlay_window_cookie_t + ** + *****************************************************************************/ + +xcb_composite_get_overlay_window_cookie_t +xcb_composite_get_overlay_window_unchecked (xcb_connection_t *c /**< */, + xcb_window_t window /**< */); + +/** + * Return the reply + * @param c The connection + * @param cookie The cookie + * @param e The xcb_generic_error_t supplied + * + * Returns the reply of the request asked by + * + * The parameter @p e supplied to this function must be NULL if + * xcb_composite_get_overlay_window_unchecked(). is used. + * Otherwise, it stores the error if any. + */ + +/***************************************************************************** + ** + ** xcb_composite_get_overlay_window_reply_t * xcb_composite_get_overlay_window_reply + ** + ** @param xcb_connection_t *c + ** @param xcb_composite_get_overlay_window_cookie_t cookie + ** @param xcb_generic_error_t **e + ** @returns xcb_composite_get_overlay_window_reply_t * + ** + *****************************************************************************/ + +xcb_composite_get_overlay_window_reply_t * +xcb_composite_get_overlay_window_reply (xcb_connection_t *c /**< */, + xcb_composite_get_overlay_window_cookie_t cookie /**< */, + xcb_generic_error_t **e /**< */); + +/** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + * This form can be used only if the request will not cause + * a reply to be generated. Any returned error will be + * saved for handling by xcb_request_check(). + */ + +/***************************************************************************** + ** + ** xcb_void_cookie_t xcb_composite_release_overlay_window_checked + ** + ** @param xcb_connection_t *c + ** @param xcb_window_t window + ** @returns xcb_void_cookie_t + ** + *****************************************************************************/ + +xcb_void_cookie_t +xcb_composite_release_overlay_window_checked (xcb_connection_t *c /**< */, + xcb_window_t window /**< */); + +/** + * Delivers a request to the X server + * @param c The connection + * @return A cookie + * + * Delivers a request to the X server. + * + */ + +/***************************************************************************** + ** + ** xcb_void_cookie_t xcb_composite_release_overlay_window + ** + ** @param xcb_connection_t *c + ** @param xcb_window_t window + ** @returns xcb_void_cookie_t + ** + *****************************************************************************/ + +xcb_void_cookie_t +xcb_composite_release_overlay_window (xcb_connection_t *c /**< */, + xcb_window_t window /**< */); + + +#endif + +/** + * @} + */ |