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