composite.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504
  1. /*
  2. * This file generated automatically from composite.xml by c_client.py.
  3. * Edit at your peril.
  4. */
  5. /**
  6. * @defgroup XCB_Composite_API XCB Composite API
  7. * @brief Composite XCB Protocol Implementation.
  8. * @{
  9. **/
  10. #ifndef __COMPOSITE_H
  11. #define __COMPOSITE_H
  12. #include "xcb.h"
  13. #include "xproto.h"
  14. #include "xfixes.h"
  15. #ifdef __cplusplus
  16. extern "C" {
  17. #endif
  18. #define XCB_COMPOSITE_MAJOR_VERSION 0
  19. #define XCB_COMPOSITE_MINOR_VERSION 4
  20. extern xcb_extension_t xcb_composite_id;
  21. typedef enum xcb_composite_redirect_t {
  22. XCB_COMPOSITE_REDIRECT_AUTOMATIC = 0,
  23. XCB_COMPOSITE_REDIRECT_MANUAL = 1
  24. } xcb_composite_redirect_t;
  25. /**
  26. * @brief xcb_composite_query_version_cookie_t
  27. **/
  28. typedef struct xcb_composite_query_version_cookie_t {
  29. unsigned int sequence;
  30. } xcb_composite_query_version_cookie_t;
  31. /** Opcode for xcb_composite_query_version. */
  32. #define XCB_COMPOSITE_QUERY_VERSION 0
  33. /**
  34. * @brief xcb_composite_query_version_request_t
  35. **/
  36. typedef struct xcb_composite_query_version_request_t {
  37. uint8_t major_opcode;
  38. uint8_t minor_opcode;
  39. uint16_t length;
  40. uint32_t client_major_version;
  41. uint32_t client_minor_version;
  42. } xcb_composite_query_version_request_t;
  43. /**
  44. * @brief xcb_composite_query_version_reply_t
  45. **/
  46. typedef struct xcb_composite_query_version_reply_t {
  47. uint8_t response_type;
  48. uint8_t pad0;
  49. uint16_t sequence;
  50. uint32_t length;
  51. uint32_t major_version;
  52. uint32_t minor_version;
  53. uint8_t pad1[16];
  54. } xcb_composite_query_version_reply_t;
  55. /** Opcode for xcb_composite_redirect_window. */
  56. #define XCB_COMPOSITE_REDIRECT_WINDOW 1
  57. /**
  58. * @brief xcb_composite_redirect_window_request_t
  59. **/
  60. typedef struct xcb_composite_redirect_window_request_t {
  61. uint8_t major_opcode;
  62. uint8_t minor_opcode;
  63. uint16_t length;
  64. xcb_window_t window;
  65. uint8_t update;
  66. uint8_t pad0[3];
  67. } xcb_composite_redirect_window_request_t;
  68. /** Opcode for xcb_composite_redirect_subwindows. */
  69. #define XCB_COMPOSITE_REDIRECT_SUBWINDOWS 2
  70. /**
  71. * @brief xcb_composite_redirect_subwindows_request_t
  72. **/
  73. typedef struct xcb_composite_redirect_subwindows_request_t {
  74. uint8_t major_opcode;
  75. uint8_t minor_opcode;
  76. uint16_t length;
  77. xcb_window_t window;
  78. uint8_t update;
  79. uint8_t pad0[3];
  80. } xcb_composite_redirect_subwindows_request_t;
  81. /** Opcode for xcb_composite_unredirect_window. */
  82. #define XCB_COMPOSITE_UNREDIRECT_WINDOW 3
  83. /**
  84. * @brief xcb_composite_unredirect_window_request_t
  85. **/
  86. typedef struct xcb_composite_unredirect_window_request_t {
  87. uint8_t major_opcode;
  88. uint8_t minor_opcode;
  89. uint16_t length;
  90. xcb_window_t window;
  91. uint8_t update;
  92. uint8_t pad0[3];
  93. } xcb_composite_unredirect_window_request_t;
  94. /** Opcode for xcb_composite_unredirect_subwindows. */
  95. #define XCB_COMPOSITE_UNREDIRECT_SUBWINDOWS 4
  96. /**
  97. * @brief xcb_composite_unredirect_subwindows_request_t
  98. **/
  99. typedef struct xcb_composite_unredirect_subwindows_request_t {
  100. uint8_t major_opcode;
  101. uint8_t minor_opcode;
  102. uint16_t length;
  103. xcb_window_t window;
  104. uint8_t update;
  105. uint8_t pad0[3];
  106. } xcb_composite_unredirect_subwindows_request_t;
  107. /** Opcode for xcb_composite_create_region_from_border_clip. */
  108. #define XCB_COMPOSITE_CREATE_REGION_FROM_BORDER_CLIP 5
  109. /**
  110. * @brief xcb_composite_create_region_from_border_clip_request_t
  111. **/
  112. typedef struct xcb_composite_create_region_from_border_clip_request_t {
  113. uint8_t major_opcode;
  114. uint8_t minor_opcode;
  115. uint16_t length;
  116. xcb_xfixes_region_t region;
  117. xcb_window_t window;
  118. } xcb_composite_create_region_from_border_clip_request_t;
  119. /** Opcode for xcb_composite_name_window_pixmap. */
  120. #define XCB_COMPOSITE_NAME_WINDOW_PIXMAP 6
  121. /**
  122. * @brief xcb_composite_name_window_pixmap_request_t
  123. **/
  124. typedef struct xcb_composite_name_window_pixmap_request_t {
  125. uint8_t major_opcode;
  126. uint8_t minor_opcode;
  127. uint16_t length;
  128. xcb_window_t window;
  129. xcb_pixmap_t pixmap;
  130. } xcb_composite_name_window_pixmap_request_t;
  131. /**
  132. * @brief xcb_composite_get_overlay_window_cookie_t
  133. **/
  134. typedef struct xcb_composite_get_overlay_window_cookie_t {
  135. unsigned int sequence;
  136. } xcb_composite_get_overlay_window_cookie_t;
  137. /** Opcode for xcb_composite_get_overlay_window. */
  138. #define XCB_COMPOSITE_GET_OVERLAY_WINDOW 7
  139. /**
  140. * @brief xcb_composite_get_overlay_window_request_t
  141. **/
  142. typedef struct xcb_composite_get_overlay_window_request_t {
  143. uint8_t major_opcode;
  144. uint8_t minor_opcode;
  145. uint16_t length;
  146. xcb_window_t window;
  147. } xcb_composite_get_overlay_window_request_t;
  148. /**
  149. * @brief xcb_composite_get_overlay_window_reply_t
  150. **/
  151. typedef struct xcb_composite_get_overlay_window_reply_t {
  152. uint8_t response_type;
  153. uint8_t pad0;
  154. uint16_t sequence;
  155. uint32_t length;
  156. xcb_window_t overlay_win;
  157. uint8_t pad1[20];
  158. } xcb_composite_get_overlay_window_reply_t;
  159. /** Opcode for xcb_composite_release_overlay_window. */
  160. #define XCB_COMPOSITE_RELEASE_OVERLAY_WINDOW 8
  161. /**
  162. * @brief xcb_composite_release_overlay_window_request_t
  163. **/
  164. typedef struct xcb_composite_release_overlay_window_request_t {
  165. uint8_t major_opcode;
  166. uint8_t minor_opcode;
  167. uint16_t length;
  168. xcb_window_t window;
  169. } xcb_composite_release_overlay_window_request_t;
  170. /**
  171. *
  172. * @param c The connection
  173. * @return A cookie
  174. *
  175. * Delivers a request to the X server.
  176. *
  177. */
  178. xcb_composite_query_version_cookie_t
  179. xcb_composite_query_version (xcb_connection_t *c,
  180. uint32_t client_major_version,
  181. uint32_t client_minor_version);
  182. /**
  183. *
  184. * @param c The connection
  185. * @return A cookie
  186. *
  187. * Delivers a request to the X server.
  188. *
  189. * This form can be used only if the request will cause
  190. * a reply to be generated. Any returned error will be
  191. * placed in the event queue.
  192. */
  193. xcb_composite_query_version_cookie_t
  194. xcb_composite_query_version_unchecked (xcb_connection_t *c,
  195. uint32_t client_major_version,
  196. uint32_t client_minor_version);
  197. /**
  198. * Return the reply
  199. * @param c The connection
  200. * @param cookie The cookie
  201. * @param e The xcb_generic_error_t supplied
  202. *
  203. * Returns the reply of the request asked by
  204. *
  205. * The parameter @p e supplied to this function must be NULL if
  206. * xcb_composite_query_version_unchecked(). is used.
  207. * Otherwise, it stores the error if any.
  208. *
  209. * The returned value must be freed by the caller using free().
  210. */
  211. xcb_composite_query_version_reply_t *
  212. xcb_composite_query_version_reply (xcb_connection_t *c,
  213. xcb_composite_query_version_cookie_t cookie /**< */,
  214. xcb_generic_error_t **e);
  215. /**
  216. *
  217. * @param c The connection
  218. * @return A cookie
  219. *
  220. * Delivers a request to the X server.
  221. *
  222. * This form can be used only if the request will not cause
  223. * a reply to be generated. Any returned error will be
  224. * saved for handling by xcb_request_check().
  225. */
  226. xcb_void_cookie_t
  227. xcb_composite_redirect_window_checked (xcb_connection_t *c,
  228. xcb_window_t window,
  229. uint8_t update);
  230. /**
  231. *
  232. * @param c The connection
  233. * @return A cookie
  234. *
  235. * Delivers a request to the X server.
  236. *
  237. */
  238. xcb_void_cookie_t
  239. xcb_composite_redirect_window (xcb_connection_t *c,
  240. xcb_window_t window,
  241. uint8_t update);
  242. /**
  243. *
  244. * @param c The connection
  245. * @return A cookie
  246. *
  247. * Delivers a request to the X server.
  248. *
  249. * This form can be used only if the request will not cause
  250. * a reply to be generated. Any returned error will be
  251. * saved for handling by xcb_request_check().
  252. */
  253. xcb_void_cookie_t
  254. xcb_composite_redirect_subwindows_checked (xcb_connection_t *c,
  255. xcb_window_t window,
  256. uint8_t update);
  257. /**
  258. *
  259. * @param c The connection
  260. * @return A cookie
  261. *
  262. * Delivers a request to the X server.
  263. *
  264. */
  265. xcb_void_cookie_t
  266. xcb_composite_redirect_subwindows (xcb_connection_t *c,
  267. xcb_window_t window,
  268. uint8_t update);
  269. /**
  270. *
  271. * @param c The connection
  272. * @return A cookie
  273. *
  274. * Delivers a request to the X server.
  275. *
  276. * This form can be used only if the request will not cause
  277. * a reply to be generated. Any returned error will be
  278. * saved for handling by xcb_request_check().
  279. */
  280. xcb_void_cookie_t
  281. xcb_composite_unredirect_window_checked (xcb_connection_t *c,
  282. xcb_window_t window,
  283. uint8_t update);
  284. /**
  285. *
  286. * @param c The connection
  287. * @return A cookie
  288. *
  289. * Delivers a request to the X server.
  290. *
  291. */
  292. xcb_void_cookie_t
  293. xcb_composite_unredirect_window (xcb_connection_t *c,
  294. xcb_window_t window,
  295. uint8_t update);
  296. /**
  297. *
  298. * @param c The connection
  299. * @return A cookie
  300. *
  301. * Delivers a request to the X server.
  302. *
  303. * This form can be used only if the request will not cause
  304. * a reply to be generated. Any returned error will be
  305. * saved for handling by xcb_request_check().
  306. */
  307. xcb_void_cookie_t
  308. xcb_composite_unredirect_subwindows_checked (xcb_connection_t *c,
  309. xcb_window_t window,
  310. uint8_t update);
  311. /**
  312. *
  313. * @param c The connection
  314. * @return A cookie
  315. *
  316. * Delivers a request to the X server.
  317. *
  318. */
  319. xcb_void_cookie_t
  320. xcb_composite_unredirect_subwindows (xcb_connection_t *c,
  321. xcb_window_t window,
  322. uint8_t update);
  323. /**
  324. *
  325. * @param c The connection
  326. * @return A cookie
  327. *
  328. * Delivers a request to the X server.
  329. *
  330. * This form can be used only if the request will not cause
  331. * a reply to be generated. Any returned error will be
  332. * saved for handling by xcb_request_check().
  333. */
  334. xcb_void_cookie_t
  335. xcb_composite_create_region_from_border_clip_checked (xcb_connection_t *c,
  336. xcb_xfixes_region_t region,
  337. xcb_window_t window);
  338. /**
  339. *
  340. * @param c The connection
  341. * @return A cookie
  342. *
  343. * Delivers a request to the X server.
  344. *
  345. */
  346. xcb_void_cookie_t
  347. xcb_composite_create_region_from_border_clip (xcb_connection_t *c,
  348. xcb_xfixes_region_t region,
  349. xcb_window_t window);
  350. /**
  351. *
  352. * @param c The connection
  353. * @return A cookie
  354. *
  355. * Delivers a request to the X server.
  356. *
  357. * This form can be used only if the request will not cause
  358. * a reply to be generated. Any returned error will be
  359. * saved for handling by xcb_request_check().
  360. */
  361. xcb_void_cookie_t
  362. xcb_composite_name_window_pixmap_checked (xcb_connection_t *c,
  363. xcb_window_t window,
  364. xcb_pixmap_t pixmap);
  365. /**
  366. *
  367. * @param c The connection
  368. * @return A cookie
  369. *
  370. * Delivers a request to the X server.
  371. *
  372. */
  373. xcb_void_cookie_t
  374. xcb_composite_name_window_pixmap (xcb_connection_t *c,
  375. xcb_window_t window,
  376. xcb_pixmap_t pixmap);
  377. /**
  378. *
  379. * @param c The connection
  380. * @return A cookie
  381. *
  382. * Delivers a request to the X server.
  383. *
  384. */
  385. xcb_composite_get_overlay_window_cookie_t
  386. xcb_composite_get_overlay_window (xcb_connection_t *c,
  387. xcb_window_t window);
  388. /**
  389. *
  390. * @param c The connection
  391. * @return A cookie
  392. *
  393. * Delivers a request to the X server.
  394. *
  395. * This form can be used only if the request will cause
  396. * a reply to be generated. Any returned error will be
  397. * placed in the event queue.
  398. */
  399. xcb_composite_get_overlay_window_cookie_t
  400. xcb_composite_get_overlay_window_unchecked (xcb_connection_t *c,
  401. xcb_window_t window);
  402. /**
  403. * Return the reply
  404. * @param c The connection
  405. * @param cookie The cookie
  406. * @param e The xcb_generic_error_t supplied
  407. *
  408. * Returns the reply of the request asked by
  409. *
  410. * The parameter @p e supplied to this function must be NULL if
  411. * xcb_composite_get_overlay_window_unchecked(). is used.
  412. * Otherwise, it stores the error if any.
  413. *
  414. * The returned value must be freed by the caller using free().
  415. */
  416. xcb_composite_get_overlay_window_reply_t *
  417. xcb_composite_get_overlay_window_reply (xcb_connection_t *c,
  418. xcb_composite_get_overlay_window_cookie_t cookie /**< */,
  419. xcb_generic_error_t **e);
  420. /**
  421. *
  422. * @param c The connection
  423. * @return A cookie
  424. *
  425. * Delivers a request to the X server.
  426. *
  427. * This form can be used only if the request will not cause
  428. * a reply to be generated. Any returned error will be
  429. * saved for handling by xcb_request_check().
  430. */
  431. xcb_void_cookie_t
  432. xcb_composite_release_overlay_window_checked (xcb_connection_t *c,
  433. xcb_window_t window);
  434. /**
  435. *
  436. * @param c The connection
  437. * @return A cookie
  438. *
  439. * Delivers a request to the X server.
  440. *
  441. */
  442. xcb_void_cookie_t
  443. xcb_composite_release_overlay_window (xcb_connection_t *c,
  444. xcb_window_t window);
  445. #ifdef __cplusplus
  446. }
  447. #endif
  448. #endif
  449. /**
  450. * @}
  451. */