annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/xcb/composite.h @ 69:33d812a61356

planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
rev   line source
jpayne@69 1 /*
jpayne@69 2 * This file generated automatically from composite.xml by c_client.py.
jpayne@69 3 * Edit at your peril.
jpayne@69 4 */
jpayne@69 5
jpayne@69 6 /**
jpayne@69 7 * @defgroup XCB_Composite_API XCB Composite API
jpayne@69 8 * @brief Composite XCB Protocol Implementation.
jpayne@69 9 * @{
jpayne@69 10 **/
jpayne@69 11
jpayne@69 12 #ifndef __COMPOSITE_H
jpayne@69 13 #define __COMPOSITE_H
jpayne@69 14
jpayne@69 15 #include "xcb.h"
jpayne@69 16 #include "xproto.h"
jpayne@69 17 #include "xfixes.h"
jpayne@69 18
jpayne@69 19 #ifdef __cplusplus
jpayne@69 20 extern "C" {
jpayne@69 21 #endif
jpayne@69 22
jpayne@69 23 #define XCB_COMPOSITE_MAJOR_VERSION 0
jpayne@69 24 #define XCB_COMPOSITE_MINOR_VERSION 4
jpayne@69 25
jpayne@69 26 extern xcb_extension_t xcb_composite_id;
jpayne@69 27
jpayne@69 28 typedef enum xcb_composite_redirect_t {
jpayne@69 29 XCB_COMPOSITE_REDIRECT_AUTOMATIC = 0,
jpayne@69 30 XCB_COMPOSITE_REDIRECT_MANUAL = 1
jpayne@69 31 } xcb_composite_redirect_t;
jpayne@69 32
jpayne@69 33 /**
jpayne@69 34 * @brief xcb_composite_query_version_cookie_t
jpayne@69 35 **/
jpayne@69 36 typedef struct xcb_composite_query_version_cookie_t {
jpayne@69 37 unsigned int sequence;
jpayne@69 38 } xcb_composite_query_version_cookie_t;
jpayne@69 39
jpayne@69 40 /** Opcode for xcb_composite_query_version. */
jpayne@69 41 #define XCB_COMPOSITE_QUERY_VERSION 0
jpayne@69 42
jpayne@69 43 /**
jpayne@69 44 * @brief xcb_composite_query_version_request_t
jpayne@69 45 **/
jpayne@69 46 typedef struct xcb_composite_query_version_request_t {
jpayne@69 47 uint8_t major_opcode;
jpayne@69 48 uint8_t minor_opcode;
jpayne@69 49 uint16_t length;
jpayne@69 50 uint32_t client_major_version;
jpayne@69 51 uint32_t client_minor_version;
jpayne@69 52 } xcb_composite_query_version_request_t;
jpayne@69 53
jpayne@69 54 /**
jpayne@69 55 * @brief xcb_composite_query_version_reply_t
jpayne@69 56 **/
jpayne@69 57 typedef struct xcb_composite_query_version_reply_t {
jpayne@69 58 uint8_t response_type;
jpayne@69 59 uint8_t pad0;
jpayne@69 60 uint16_t sequence;
jpayne@69 61 uint32_t length;
jpayne@69 62 uint32_t major_version;
jpayne@69 63 uint32_t minor_version;
jpayne@69 64 uint8_t pad1[16];
jpayne@69 65 } xcb_composite_query_version_reply_t;
jpayne@69 66
jpayne@69 67 /** Opcode for xcb_composite_redirect_window. */
jpayne@69 68 #define XCB_COMPOSITE_REDIRECT_WINDOW 1
jpayne@69 69
jpayne@69 70 /**
jpayne@69 71 * @brief xcb_composite_redirect_window_request_t
jpayne@69 72 **/
jpayne@69 73 typedef struct xcb_composite_redirect_window_request_t {
jpayne@69 74 uint8_t major_opcode;
jpayne@69 75 uint8_t minor_opcode;
jpayne@69 76 uint16_t length;
jpayne@69 77 xcb_window_t window;
jpayne@69 78 uint8_t update;
jpayne@69 79 uint8_t pad0[3];
jpayne@69 80 } xcb_composite_redirect_window_request_t;
jpayne@69 81
jpayne@69 82 /** Opcode for xcb_composite_redirect_subwindows. */
jpayne@69 83 #define XCB_COMPOSITE_REDIRECT_SUBWINDOWS 2
jpayne@69 84
jpayne@69 85 /**
jpayne@69 86 * @brief xcb_composite_redirect_subwindows_request_t
jpayne@69 87 **/
jpayne@69 88 typedef struct xcb_composite_redirect_subwindows_request_t {
jpayne@69 89 uint8_t major_opcode;
jpayne@69 90 uint8_t minor_opcode;
jpayne@69 91 uint16_t length;
jpayne@69 92 xcb_window_t window;
jpayne@69 93 uint8_t update;
jpayne@69 94 uint8_t pad0[3];
jpayne@69 95 } xcb_composite_redirect_subwindows_request_t;
jpayne@69 96
jpayne@69 97 /** Opcode for xcb_composite_unredirect_window. */
jpayne@69 98 #define XCB_COMPOSITE_UNREDIRECT_WINDOW 3
jpayne@69 99
jpayne@69 100 /**
jpayne@69 101 * @brief xcb_composite_unredirect_window_request_t
jpayne@69 102 **/
jpayne@69 103 typedef struct xcb_composite_unredirect_window_request_t {
jpayne@69 104 uint8_t major_opcode;
jpayne@69 105 uint8_t minor_opcode;
jpayne@69 106 uint16_t length;
jpayne@69 107 xcb_window_t window;
jpayne@69 108 uint8_t update;
jpayne@69 109 uint8_t pad0[3];
jpayne@69 110 } xcb_composite_unredirect_window_request_t;
jpayne@69 111
jpayne@69 112 /** Opcode for xcb_composite_unredirect_subwindows. */
jpayne@69 113 #define XCB_COMPOSITE_UNREDIRECT_SUBWINDOWS 4
jpayne@69 114
jpayne@69 115 /**
jpayne@69 116 * @brief xcb_composite_unredirect_subwindows_request_t
jpayne@69 117 **/
jpayne@69 118 typedef struct xcb_composite_unredirect_subwindows_request_t {
jpayne@69 119 uint8_t major_opcode;
jpayne@69 120 uint8_t minor_opcode;
jpayne@69 121 uint16_t length;
jpayne@69 122 xcb_window_t window;
jpayne@69 123 uint8_t update;
jpayne@69 124 uint8_t pad0[3];
jpayne@69 125 } xcb_composite_unredirect_subwindows_request_t;
jpayne@69 126
jpayne@69 127 /** Opcode for xcb_composite_create_region_from_border_clip. */
jpayne@69 128 #define XCB_COMPOSITE_CREATE_REGION_FROM_BORDER_CLIP 5
jpayne@69 129
jpayne@69 130 /**
jpayne@69 131 * @brief xcb_composite_create_region_from_border_clip_request_t
jpayne@69 132 **/
jpayne@69 133 typedef struct xcb_composite_create_region_from_border_clip_request_t {
jpayne@69 134 uint8_t major_opcode;
jpayne@69 135 uint8_t minor_opcode;
jpayne@69 136 uint16_t length;
jpayne@69 137 xcb_xfixes_region_t region;
jpayne@69 138 xcb_window_t window;
jpayne@69 139 } xcb_composite_create_region_from_border_clip_request_t;
jpayne@69 140
jpayne@69 141 /** Opcode for xcb_composite_name_window_pixmap. */
jpayne@69 142 #define XCB_COMPOSITE_NAME_WINDOW_PIXMAP 6
jpayne@69 143
jpayne@69 144 /**
jpayne@69 145 * @brief xcb_composite_name_window_pixmap_request_t
jpayne@69 146 **/
jpayne@69 147 typedef struct xcb_composite_name_window_pixmap_request_t {
jpayne@69 148 uint8_t major_opcode;
jpayne@69 149 uint8_t minor_opcode;
jpayne@69 150 uint16_t length;
jpayne@69 151 xcb_window_t window;
jpayne@69 152 xcb_pixmap_t pixmap;
jpayne@69 153 } xcb_composite_name_window_pixmap_request_t;
jpayne@69 154
jpayne@69 155 /**
jpayne@69 156 * @brief xcb_composite_get_overlay_window_cookie_t
jpayne@69 157 **/
jpayne@69 158 typedef struct xcb_composite_get_overlay_window_cookie_t {
jpayne@69 159 unsigned int sequence;
jpayne@69 160 } xcb_composite_get_overlay_window_cookie_t;
jpayne@69 161
jpayne@69 162 /** Opcode for xcb_composite_get_overlay_window. */
jpayne@69 163 #define XCB_COMPOSITE_GET_OVERLAY_WINDOW 7
jpayne@69 164
jpayne@69 165 /**
jpayne@69 166 * @brief xcb_composite_get_overlay_window_request_t
jpayne@69 167 **/
jpayne@69 168 typedef struct xcb_composite_get_overlay_window_request_t {
jpayne@69 169 uint8_t major_opcode;
jpayne@69 170 uint8_t minor_opcode;
jpayne@69 171 uint16_t length;
jpayne@69 172 xcb_window_t window;
jpayne@69 173 } xcb_composite_get_overlay_window_request_t;
jpayne@69 174
jpayne@69 175 /**
jpayne@69 176 * @brief xcb_composite_get_overlay_window_reply_t
jpayne@69 177 **/
jpayne@69 178 typedef struct xcb_composite_get_overlay_window_reply_t {
jpayne@69 179 uint8_t response_type;
jpayne@69 180 uint8_t pad0;
jpayne@69 181 uint16_t sequence;
jpayne@69 182 uint32_t length;
jpayne@69 183 xcb_window_t overlay_win;
jpayne@69 184 uint8_t pad1[20];
jpayne@69 185 } xcb_composite_get_overlay_window_reply_t;
jpayne@69 186
jpayne@69 187 /** Opcode for xcb_composite_release_overlay_window. */
jpayne@69 188 #define XCB_COMPOSITE_RELEASE_OVERLAY_WINDOW 8
jpayne@69 189
jpayne@69 190 /**
jpayne@69 191 * @brief xcb_composite_release_overlay_window_request_t
jpayne@69 192 **/
jpayne@69 193 typedef struct xcb_composite_release_overlay_window_request_t {
jpayne@69 194 uint8_t major_opcode;
jpayne@69 195 uint8_t minor_opcode;
jpayne@69 196 uint16_t length;
jpayne@69 197 xcb_window_t window;
jpayne@69 198 } xcb_composite_release_overlay_window_request_t;
jpayne@69 199
jpayne@69 200 /**
jpayne@69 201 * @brief Negotiate the version of Composite
jpayne@69 202 *
jpayne@69 203 * @param c The connection
jpayne@69 204 * @param client_major_version The major version supported by the client.
jpayne@69 205 * @param client_minor_version The minor version supported by the client.
jpayne@69 206 * @return A cookie
jpayne@69 207 *
jpayne@69 208 * This negotiates the version of the Composite extension. It must be precede all
jpayne@69 209 * other requests using Composite. Failure to do so will cause a BadRequest error.
jpayne@69 210 *
jpayne@69 211 */
jpayne@69 212 xcb_composite_query_version_cookie_t
jpayne@69 213 xcb_composite_query_version (xcb_connection_t *c,
jpayne@69 214 uint32_t client_major_version,
jpayne@69 215 uint32_t client_minor_version);
jpayne@69 216
jpayne@69 217 /**
jpayne@69 218 * @brief Negotiate the version of Composite
jpayne@69 219 *
jpayne@69 220 * @param c The connection
jpayne@69 221 * @param client_major_version The major version supported by the client.
jpayne@69 222 * @param client_minor_version The minor version supported by the client.
jpayne@69 223 * @return A cookie
jpayne@69 224 *
jpayne@69 225 * This negotiates the version of the Composite extension. It must be precede all
jpayne@69 226 * other requests using Composite. Failure to do so will cause a BadRequest error.
jpayne@69 227 *
jpayne@69 228 * This form can be used only if the request will cause
jpayne@69 229 * a reply to be generated. Any returned error will be
jpayne@69 230 * placed in the event queue.
jpayne@69 231 */
jpayne@69 232 xcb_composite_query_version_cookie_t
jpayne@69 233 xcb_composite_query_version_unchecked (xcb_connection_t *c,
jpayne@69 234 uint32_t client_major_version,
jpayne@69 235 uint32_t client_minor_version);
jpayne@69 236
jpayne@69 237 /**
jpayne@69 238 * Return the reply
jpayne@69 239 * @param c The connection
jpayne@69 240 * @param cookie The cookie
jpayne@69 241 * @param e The xcb_generic_error_t supplied
jpayne@69 242 *
jpayne@69 243 * Returns the reply of the request asked by
jpayne@69 244 *
jpayne@69 245 * The parameter @p e supplied to this function must be NULL if
jpayne@69 246 * xcb_composite_query_version_unchecked(). is used.
jpayne@69 247 * Otherwise, it stores the error if any.
jpayne@69 248 *
jpayne@69 249 * The returned value must be freed by the caller using free().
jpayne@69 250 */
jpayne@69 251 xcb_composite_query_version_reply_t *
jpayne@69 252 xcb_composite_query_version_reply (xcb_connection_t *c,
jpayne@69 253 xcb_composite_query_version_cookie_t cookie /**< */,
jpayne@69 254 xcb_generic_error_t **e);
jpayne@69 255
jpayne@69 256 /**
jpayne@69 257 * @brief Redirect the hierarchy starting at "window" to off-screen storage.
jpayne@69 258 *
jpayne@69 259 * @param c The connection
jpayne@69 260 * @param window The root of the hierarchy to redirect to off-screen storage.
jpayne@69 261 * @param update A bitmask of #xcb_composite_redirect_t values.
jpayne@69 262 * @param update Whether contents are automatically mirrored to the parent window. If one client
jpayne@69 263 * already specifies an update type of Manual, any attempt by another to specify a
jpayne@69 264 * mode of Manual so will result in an Access error.
jpayne@69 265 * @return A cookie
jpayne@69 266 *
jpayne@69 267 * The hierarchy starting at 'window' is directed to off-screen
jpayne@69 268 * storage. When all clients enabling redirection terminate,
jpayne@69 269 * the redirection will automatically be disabled.
jpayne@69 270 *
jpayne@69 271 * The root window may not be redirected. Doing so results in a Match
jpayne@69 272 * error.
jpayne@69 273 *
jpayne@69 274 * This form can be used only if the request will not cause
jpayne@69 275 * a reply to be generated. Any returned error will be
jpayne@69 276 * saved for handling by xcb_request_check().
jpayne@69 277 */
jpayne@69 278 xcb_void_cookie_t
jpayne@69 279 xcb_composite_redirect_window_checked (xcb_connection_t *c,
jpayne@69 280 xcb_window_t window,
jpayne@69 281 uint8_t update);
jpayne@69 282
jpayne@69 283 /**
jpayne@69 284 * @brief Redirect the hierarchy starting at "window" to off-screen storage.
jpayne@69 285 *
jpayne@69 286 * @param c The connection
jpayne@69 287 * @param window The root of the hierarchy to redirect to off-screen storage.
jpayne@69 288 * @param update A bitmask of #xcb_composite_redirect_t values.
jpayne@69 289 * @param update Whether contents are automatically mirrored to the parent window. If one client
jpayne@69 290 * already specifies an update type of Manual, any attempt by another to specify a
jpayne@69 291 * mode of Manual so will result in an Access error.
jpayne@69 292 * @return A cookie
jpayne@69 293 *
jpayne@69 294 * The hierarchy starting at 'window' is directed to off-screen
jpayne@69 295 * storage. When all clients enabling redirection terminate,
jpayne@69 296 * the redirection will automatically be disabled.
jpayne@69 297 *
jpayne@69 298 * The root window may not be redirected. Doing so results in a Match
jpayne@69 299 * error.
jpayne@69 300 *
jpayne@69 301 */
jpayne@69 302 xcb_void_cookie_t
jpayne@69 303 xcb_composite_redirect_window (xcb_connection_t *c,
jpayne@69 304 xcb_window_t window,
jpayne@69 305 uint8_t update);
jpayne@69 306
jpayne@69 307 /**
jpayne@69 308 * @brief Redirect all current and future children of ‘window’
jpayne@69 309 *
jpayne@69 310 * @param c The connection
jpayne@69 311 * @param window The root of the hierarchy to redirect to off-screen storage.
jpayne@69 312 * @param update A bitmask of #xcb_composite_redirect_t values.
jpayne@69 313 * @param update Whether contents are automatically mirrored to the parent window. If one client
jpayne@69 314 * already specifies an update type of Manual, any attempt by another to specify a
jpayne@69 315 * mode of Manual so will result in an Access error.
jpayne@69 316 * @return A cookie
jpayne@69 317 *
jpayne@69 318 * Hierarchies starting at all current and future children of window
jpayne@69 319 * will be redirected as in RedirectWindow. If update is Manual,
jpayne@69 320 * then painting of the window background during window manipulation
jpayne@69 321 * and ClearArea requests is inhibited.
jpayne@69 322 *
jpayne@69 323 * This form can be used only if the request will not cause
jpayne@69 324 * a reply to be generated. Any returned error will be
jpayne@69 325 * saved for handling by xcb_request_check().
jpayne@69 326 */
jpayne@69 327 xcb_void_cookie_t
jpayne@69 328 xcb_composite_redirect_subwindows_checked (xcb_connection_t *c,
jpayne@69 329 xcb_window_t window,
jpayne@69 330 uint8_t update);
jpayne@69 331
jpayne@69 332 /**
jpayne@69 333 * @brief Redirect all current and future children of ‘window’
jpayne@69 334 *
jpayne@69 335 * @param c The connection
jpayne@69 336 * @param window The root of the hierarchy to redirect to off-screen storage.
jpayne@69 337 * @param update A bitmask of #xcb_composite_redirect_t values.
jpayne@69 338 * @param update Whether contents are automatically mirrored to the parent window. If one client
jpayne@69 339 * already specifies an update type of Manual, any attempt by another to specify a
jpayne@69 340 * mode of Manual so will result in an Access error.
jpayne@69 341 * @return A cookie
jpayne@69 342 *
jpayne@69 343 * Hierarchies starting at all current and future children of window
jpayne@69 344 * will be redirected as in RedirectWindow. If update is Manual,
jpayne@69 345 * then painting of the window background during window manipulation
jpayne@69 346 * and ClearArea requests is inhibited.
jpayne@69 347 *
jpayne@69 348 */
jpayne@69 349 xcb_void_cookie_t
jpayne@69 350 xcb_composite_redirect_subwindows (xcb_connection_t *c,
jpayne@69 351 xcb_window_t window,
jpayne@69 352 uint8_t update);
jpayne@69 353
jpayne@69 354 /**
jpayne@69 355 * @brief Terminate redirection of the specified window.
jpayne@69 356 *
jpayne@69 357 * @param c The connection
jpayne@69 358 * @param window The window to terminate redirection of. Must be redirected by the
jpayne@69 359 * current client, or a Value error results.
jpayne@69 360 * @param update A bitmask of #xcb_composite_redirect_t values.
jpayne@69 361 * @param update The update type passed to RedirectWindows. If this does not match the
jpayne@69 362 * previously requested update type, a Value error results.
jpayne@69 363 * @return A cookie
jpayne@69 364 *
jpayne@69 365 * Redirection of the specified window will be terminated. This cannot be
jpayne@69 366 * used if the window was redirected with RedirectSubwindows.
jpayne@69 367 *
jpayne@69 368 * This form can be used only if the request will not cause
jpayne@69 369 * a reply to be generated. Any returned error will be
jpayne@69 370 * saved for handling by xcb_request_check().
jpayne@69 371 */
jpayne@69 372 xcb_void_cookie_t
jpayne@69 373 xcb_composite_unredirect_window_checked (xcb_connection_t *c,
jpayne@69 374 xcb_window_t window,
jpayne@69 375 uint8_t update);
jpayne@69 376
jpayne@69 377 /**
jpayne@69 378 * @brief Terminate redirection of the specified window.
jpayne@69 379 *
jpayne@69 380 * @param c The connection
jpayne@69 381 * @param window The window to terminate redirection of. Must be redirected by the
jpayne@69 382 * current client, or a Value error results.
jpayne@69 383 * @param update A bitmask of #xcb_composite_redirect_t values.
jpayne@69 384 * @param update The update type passed to RedirectWindows. If this does not match the
jpayne@69 385 * previously requested update type, a Value error results.
jpayne@69 386 * @return A cookie
jpayne@69 387 *
jpayne@69 388 * Redirection of the specified window will be terminated. This cannot be
jpayne@69 389 * used if the window was redirected with RedirectSubwindows.
jpayne@69 390 *
jpayne@69 391 */
jpayne@69 392 xcb_void_cookie_t
jpayne@69 393 xcb_composite_unredirect_window (xcb_connection_t *c,
jpayne@69 394 xcb_window_t window,
jpayne@69 395 uint8_t update);
jpayne@69 396
jpayne@69 397 /**
jpayne@69 398 * @brief Terminate redirection of the specified window’s children
jpayne@69 399 *
jpayne@69 400 * @param c The connection
jpayne@69 401 * @param window The window to terminate redirection of. Must have previously been
jpayne@69 402 * selected for sub-redirection by the current client, or a Value error
jpayne@69 403 * results.
jpayne@69 404 * @param update A bitmask of #xcb_composite_redirect_t values.
jpayne@69 405 * @param update The update type passed to RedirectSubWindows. If this does not match
jpayne@69 406 * the previously requested update type, a Value error results.
jpayne@69 407 * @return A cookie
jpayne@69 408 *
jpayne@69 409 * Redirection of all children of window will be terminated.
jpayne@69 410 *
jpayne@69 411 * This form can be used only if the request will not cause
jpayne@69 412 * a reply to be generated. Any returned error will be
jpayne@69 413 * saved for handling by xcb_request_check().
jpayne@69 414 */
jpayne@69 415 xcb_void_cookie_t
jpayne@69 416 xcb_composite_unredirect_subwindows_checked (xcb_connection_t *c,
jpayne@69 417 xcb_window_t window,
jpayne@69 418 uint8_t update);
jpayne@69 419
jpayne@69 420 /**
jpayne@69 421 * @brief Terminate redirection of the specified window’s children
jpayne@69 422 *
jpayne@69 423 * @param c The connection
jpayne@69 424 * @param window The window to terminate redirection of. Must have previously been
jpayne@69 425 * selected for sub-redirection by the current client, or a Value error
jpayne@69 426 * results.
jpayne@69 427 * @param update A bitmask of #xcb_composite_redirect_t values.
jpayne@69 428 * @param update The update type passed to RedirectSubWindows. If this does not match
jpayne@69 429 * the previously requested update type, a Value error results.
jpayne@69 430 * @return A cookie
jpayne@69 431 *
jpayne@69 432 * Redirection of all children of window will be terminated.
jpayne@69 433 *
jpayne@69 434 */
jpayne@69 435 xcb_void_cookie_t
jpayne@69 436 xcb_composite_unredirect_subwindows (xcb_connection_t *c,
jpayne@69 437 xcb_window_t window,
jpayne@69 438 uint8_t update);
jpayne@69 439
jpayne@69 440 /**
jpayne@69 441 *
jpayne@69 442 * @param c The connection
jpayne@69 443 * @return A cookie
jpayne@69 444 *
jpayne@69 445 * Delivers a request to the X server.
jpayne@69 446 *
jpayne@69 447 * This form can be used only if the request will not cause
jpayne@69 448 * a reply to be generated. Any returned error will be
jpayne@69 449 * saved for handling by xcb_request_check().
jpayne@69 450 */
jpayne@69 451 xcb_void_cookie_t
jpayne@69 452 xcb_composite_create_region_from_border_clip_checked (xcb_connection_t *c,
jpayne@69 453 xcb_xfixes_region_t region,
jpayne@69 454 xcb_window_t window);
jpayne@69 455
jpayne@69 456 /**
jpayne@69 457 *
jpayne@69 458 * @param c The connection
jpayne@69 459 * @return A cookie
jpayne@69 460 *
jpayne@69 461 * Delivers a request to the X server.
jpayne@69 462 *
jpayne@69 463 */
jpayne@69 464 xcb_void_cookie_t
jpayne@69 465 xcb_composite_create_region_from_border_clip (xcb_connection_t *c,
jpayne@69 466 xcb_xfixes_region_t region,
jpayne@69 467 xcb_window_t window);
jpayne@69 468
jpayne@69 469 /**
jpayne@69 470 *
jpayne@69 471 * @param c The connection
jpayne@69 472 * @return A cookie
jpayne@69 473 *
jpayne@69 474 * Delivers a request to the X server.
jpayne@69 475 *
jpayne@69 476 * This form can be used only if the request will not cause
jpayne@69 477 * a reply to be generated. Any returned error will be
jpayne@69 478 * saved for handling by xcb_request_check().
jpayne@69 479 */
jpayne@69 480 xcb_void_cookie_t
jpayne@69 481 xcb_composite_name_window_pixmap_checked (xcb_connection_t *c,
jpayne@69 482 xcb_window_t window,
jpayne@69 483 xcb_pixmap_t pixmap);
jpayne@69 484
jpayne@69 485 /**
jpayne@69 486 *
jpayne@69 487 * @param c The connection
jpayne@69 488 * @return A cookie
jpayne@69 489 *
jpayne@69 490 * Delivers a request to the X server.
jpayne@69 491 *
jpayne@69 492 */
jpayne@69 493 xcb_void_cookie_t
jpayne@69 494 xcb_composite_name_window_pixmap (xcb_connection_t *c,
jpayne@69 495 xcb_window_t window,
jpayne@69 496 xcb_pixmap_t pixmap);
jpayne@69 497
jpayne@69 498 /**
jpayne@69 499 *
jpayne@69 500 * @param c The connection
jpayne@69 501 * @return A cookie
jpayne@69 502 *
jpayne@69 503 * Delivers a request to the X server.
jpayne@69 504 *
jpayne@69 505 */
jpayne@69 506 xcb_composite_get_overlay_window_cookie_t
jpayne@69 507 xcb_composite_get_overlay_window (xcb_connection_t *c,
jpayne@69 508 xcb_window_t window);
jpayne@69 509
jpayne@69 510 /**
jpayne@69 511 *
jpayne@69 512 * @param c The connection
jpayne@69 513 * @return A cookie
jpayne@69 514 *
jpayne@69 515 * Delivers a request to the X server.
jpayne@69 516 *
jpayne@69 517 * This form can be used only if the request will cause
jpayne@69 518 * a reply to be generated. Any returned error will be
jpayne@69 519 * placed in the event queue.
jpayne@69 520 */
jpayne@69 521 xcb_composite_get_overlay_window_cookie_t
jpayne@69 522 xcb_composite_get_overlay_window_unchecked (xcb_connection_t *c,
jpayne@69 523 xcb_window_t window);
jpayne@69 524
jpayne@69 525 /**
jpayne@69 526 * Return the reply
jpayne@69 527 * @param c The connection
jpayne@69 528 * @param cookie The cookie
jpayne@69 529 * @param e The xcb_generic_error_t supplied
jpayne@69 530 *
jpayne@69 531 * Returns the reply of the request asked by
jpayne@69 532 *
jpayne@69 533 * The parameter @p e supplied to this function must be NULL if
jpayne@69 534 * xcb_composite_get_overlay_window_unchecked(). is used.
jpayne@69 535 * Otherwise, it stores the error if any.
jpayne@69 536 *
jpayne@69 537 * The returned value must be freed by the caller using free().
jpayne@69 538 */
jpayne@69 539 xcb_composite_get_overlay_window_reply_t *
jpayne@69 540 xcb_composite_get_overlay_window_reply (xcb_connection_t *c,
jpayne@69 541 xcb_composite_get_overlay_window_cookie_t cookie /**< */,
jpayne@69 542 xcb_generic_error_t **e);
jpayne@69 543
jpayne@69 544 /**
jpayne@69 545 *
jpayne@69 546 * @param c The connection
jpayne@69 547 * @return A cookie
jpayne@69 548 *
jpayne@69 549 * Delivers a request to the X server.
jpayne@69 550 *
jpayne@69 551 * This form can be used only if the request will not cause
jpayne@69 552 * a reply to be generated. Any returned error will be
jpayne@69 553 * saved for handling by xcb_request_check().
jpayne@69 554 */
jpayne@69 555 xcb_void_cookie_t
jpayne@69 556 xcb_composite_release_overlay_window_checked (xcb_connection_t *c,
jpayne@69 557 xcb_window_t window);
jpayne@69 558
jpayne@69 559 /**
jpayne@69 560 *
jpayne@69 561 * @param c The connection
jpayne@69 562 * @return A cookie
jpayne@69 563 *
jpayne@69 564 * Delivers a request to the X server.
jpayne@69 565 *
jpayne@69 566 */
jpayne@69 567 xcb_void_cookie_t
jpayne@69 568 xcb_composite_release_overlay_window (xcb_connection_t *c,
jpayne@69 569 xcb_window_t window);
jpayne@69 570
jpayne@69 571
jpayne@69 572 #ifdef __cplusplus
jpayne@69 573 }
jpayne@69 574 #endif
jpayne@69 575
jpayne@69 576 #endif
jpayne@69 577
jpayne@69 578 /**
jpayne@69 579 * @}
jpayne@69 580 */