home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / SLAX 6.0.8 / slax-6.0.8.iso / slax / base / 006-devel.lzm / usr / include / xcb / damage.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-09-17  |  14.8 KB  |  510 lines

  1. /*
  2.  * This file generated automatically from damage.xml by c-client.xsl using XSLT.
  3.  * Edit at your peril.
  4.  */
  5.  
  6. /**
  7.  * @defgroup XCB_Damage_API XCB Damage API
  8.  * @brief Damage XCB Protocol Implementation.
  9.  * @{
  10.  **/
  11.  
  12. #ifndef __DAMAGE_H
  13. #define __DAMAGE_H
  14.  
  15. #include "xcb.h"
  16. #include "xproto.h"
  17. #include "xfixes.h"
  18.  
  19. #define XCB_DAMAGE_MAJOR_VERSION 1
  20. #define XCB_DAMAGE_MINOR_VERSION 1
  21.   
  22. extern xcb_extension_t xcb_damage_id;
  23.  
  24. typedef uint32_t xcb_damage_damage_t;
  25.  
  26. /**
  27.  * @brief xcb_damage_damage_iterator_t
  28.  **/
  29. typedef struct xcb_damage_damage_iterator_t {
  30.     xcb_damage_damage_t *data; /**<  */
  31.     int                  rem; /**<  */
  32.     int                  index; /**<  */
  33. } xcb_damage_damage_iterator_t;
  34.  
  35. typedef enum xcb_damage_report_level_t {
  36.     XCB_DAMAGE_REPORT_LEVEL_RAW_RECTANGLES,
  37.     XCB_DAMAGE_REPORT_LEVEL_DELTA_RECTANGLES,
  38.     XCB_DAMAGE_REPORT_LEVEL_BOUNDING_BOX,
  39.     XCB_DAMAGE_REPORT_LEVEL_NON_EMPTY
  40. } xcb_damage_report_level_t;
  41.  
  42. /** Opcode for xcb_damage_bad_damage. */
  43. #define XCB_DAMAGE_BAD_DAMAGE 0
  44.  
  45. /**
  46.  * @brief xcb_damage_bad_damage_error_t
  47.  **/
  48. typedef struct xcb_damage_bad_damage_error_t {
  49.     uint8_t  response_type; /**<  */
  50.     uint8_t  error_code; /**<  */
  51.     uint16_t sequence; /**<  */
  52. } xcb_damage_bad_damage_error_t;
  53.  
  54. /**
  55.  * @brief xcb_damage_query_version_cookie_t
  56.  **/
  57. typedef struct xcb_damage_query_version_cookie_t {
  58.     unsigned int sequence; /**<  */
  59. } xcb_damage_query_version_cookie_t;
  60.  
  61. /** Opcode for xcb_damage_query_version. */
  62. #define XCB_DAMAGE_QUERY_VERSION 0
  63.  
  64. /**
  65.  * @brief xcb_damage_query_version_request_t
  66.  **/
  67. typedef struct xcb_damage_query_version_request_t {
  68.     uint8_t  major_opcode; /**<  */
  69.     uint8_t  minor_opcode; /**<  */
  70.     uint16_t length; /**<  */
  71.     uint32_t client_major_version; /**<  */
  72.     uint32_t client_minor_version; /**<  */
  73. } xcb_damage_query_version_request_t;
  74.  
  75. /**
  76.  * @brief xcb_damage_query_version_reply_t
  77.  **/
  78. typedef struct xcb_damage_query_version_reply_t {
  79.     uint8_t  response_type; /**<  */
  80.     uint8_t  pad0; /**<  */
  81.     uint16_t sequence; /**<  */
  82.     uint32_t length; /**<  */
  83.     uint32_t major_version; /**<  */
  84.     uint32_t minor_version; /**<  */
  85.     uint8_t  pad1[16]; /**<  */
  86. } xcb_damage_query_version_reply_t;
  87.  
  88. /** Opcode for xcb_damage_create. */
  89. #define XCB_DAMAGE_CREATE 1
  90.  
  91. /**
  92.  * @brief xcb_damage_create_request_t
  93.  **/
  94. typedef struct xcb_damage_create_request_t {
  95.     uint8_t             major_opcode; /**<  */
  96.     uint8_t             minor_opcode; /**<  */
  97.     uint16_t            length; /**<  */
  98.     xcb_damage_damage_t damage; /**<  */
  99.     xcb_drawable_t      drawable; /**<  */
  100.     uint8_t             level; /**<  */
  101.     uint8_t             pad0[3]; /**<  */
  102. } xcb_damage_create_request_t;
  103.  
  104. /** Opcode for xcb_damage_destroy. */
  105. #define XCB_DAMAGE_DESTROY 2
  106.  
  107. /**
  108.  * @brief xcb_damage_destroy_request_t
  109.  **/
  110. typedef struct xcb_damage_destroy_request_t {
  111.     uint8_t             major_opcode; /**<  */
  112.     uint8_t             minor_opcode; /**<  */
  113.     uint16_t            length; /**<  */
  114.     xcb_damage_damage_t damage; /**<  */
  115. } xcb_damage_destroy_request_t;
  116.  
  117. /** Opcode for xcb_damage_subtract. */
  118. #define XCB_DAMAGE_SUBTRACT 3
  119.  
  120. /**
  121.  * @brief xcb_damage_subtract_request_t
  122.  **/
  123. typedef struct xcb_damage_subtract_request_t {
  124.     uint8_t             major_opcode; /**<  */
  125.     uint8_t             minor_opcode; /**<  */
  126.     uint16_t            length; /**<  */
  127.     xcb_damage_damage_t damage; /**<  */
  128.     xcb_xfixes_region_t repair; /**<  */
  129.     xcb_xfixes_region_t parts; /**<  */
  130. } xcb_damage_subtract_request_t;
  131.  
  132. /** Opcode for xcb_damage_add. */
  133. #define XCB_DAMAGE_ADD 4
  134.  
  135. /**
  136.  * @brief xcb_damage_add_request_t
  137.  **/
  138. typedef struct xcb_damage_add_request_t {
  139.     uint8_t             major_opcode; /**<  */
  140.     uint8_t             minor_opcode; /**<  */
  141.     uint16_t            length; /**<  */
  142.     xcb_drawable_t      drawable; /**<  */
  143.     xcb_xfixes_region_t region; /**<  */
  144. } xcb_damage_add_request_t;
  145.  
  146. /** Opcode for xcb_damage_notify. */
  147. #define XCB_DAMAGE_NOTIFY 0
  148.  
  149. /**
  150.  * @brief xcb_damage_notify_event_t
  151.  **/
  152. typedef struct xcb_damage_notify_event_t {
  153.     uint8_t             response_type; /**<  */
  154.     uint8_t             level; /**<  */
  155.     uint16_t            sequence; /**<  */
  156.     xcb_drawable_t      drawable; /**<  */
  157.     xcb_damage_damage_t damage; /**<  */
  158.     xcb_timestamp_t     timestamp; /**<  */
  159.     xcb_rectangle_t     area; /**<  */
  160.     xcb_rectangle_t     geometry; /**<  */
  161. } xcb_damage_notify_event_t;
  162.  
  163. /**
  164.  * Get the next element of the iterator
  165.  * @param i Pointer to a xcb_damage_damage_iterator_t
  166.  *
  167.  * Get the next element in the iterator. The member rem is
  168.  * decreased by one. The member data points to the next
  169.  * element. The member index is increased by sizeof(xcb_damage_damage_t)
  170.  */
  171.  
  172. /*****************************************************************************
  173.  **
  174.  ** void xcb_damage_damage_next
  175.  ** 
  176.  ** @param xcb_damage_damage_iterator_t *i
  177.  ** @returns void
  178.  **
  179.  *****************************************************************************/
  180.  
  181. void
  182. xcb_damage_damage_next (xcb_damage_damage_iterator_t *i  /**< */);
  183.  
  184. /**
  185.  * Return the iterator pointing to the last element
  186.  * @param i An xcb_damage_damage_iterator_t
  187.  * @return  The iterator pointing to the last element
  188.  *
  189.  * Set the current element in the iterator to the last element.
  190.  * The member rem is set to 0. The member data points to the
  191.  * last element.
  192.  */
  193.  
  194. /*****************************************************************************
  195.  **
  196.  ** xcb_generic_iterator_t xcb_damage_damage_end
  197.  ** 
  198.  ** @param xcb_damage_damage_iterator_t i
  199.  ** @returns xcb_generic_iterator_t
  200.  **
  201.  *****************************************************************************/
  202.  
  203. xcb_generic_iterator_t
  204. xcb_damage_damage_end (xcb_damage_damage_iterator_t i  /**< */);
  205.  
  206. /**
  207.  * Delivers a request to the X server
  208.  * @param c The connection
  209.  * @return A cookie
  210.  *
  211.  * Delivers a request to the X server.
  212.  * 
  213.  */
  214.  
  215. /*****************************************************************************
  216.  **
  217.  ** xcb_damage_query_version_cookie_t xcb_damage_query_version
  218.  ** 
  219.  ** @param xcb_connection_t *c
  220.  ** @param uint32_t          client_major_version
  221.  ** @param uint32_t          client_minor_version
  222.  ** @returns xcb_damage_query_version_cookie_t
  223.  **
  224.  *****************************************************************************/
  225.  
  226. xcb_damage_query_version_cookie_t
  227. xcb_damage_query_version (xcb_connection_t *c  /**< */,
  228.                           uint32_t          client_major_version  /**< */,
  229.                           uint32_t          client_minor_version  /**< */);
  230.  
  231. /**
  232.  * Delivers a request to the X server
  233.  * @param c The connection
  234.  * @return A cookie
  235.  *
  236.  * Delivers a request to the X server.
  237.  * 
  238.  * This form can be used only if the request will cause
  239.  * a reply to be generated. Any returned error will be
  240.  * placed in the event queue.
  241.  */
  242.  
  243. /*****************************************************************************
  244.  **
  245.  ** xcb_damage_query_version_cookie_t xcb_damage_query_version_unchecked
  246.  ** 
  247.  ** @param xcb_connection_t *c
  248.  ** @param uint32_t          client_major_version
  249.  ** @param uint32_t          client_minor_version
  250.  ** @returns xcb_damage_query_version_cookie_t
  251.  **
  252.  *****************************************************************************/
  253.  
  254. xcb_damage_query_version_cookie_t
  255. xcb_damage_query_version_unchecked (xcb_connection_t *c  /**< */,
  256.                                     uint32_t          client_major_version  /**< */,
  257.                                     uint32_t          client_minor_version  /**< */);
  258.  
  259. /**
  260.  * Return the reply
  261.  * @param c      The connection
  262.  * @param cookie The cookie
  263.  * @param e      The xcb_generic_error_t supplied
  264.  *
  265.  * Returns the reply of the request asked by
  266.  * 
  267.  * The parameter @p e supplied to this function must be NULL if
  268.  * xcb_damage_query_version_unchecked(). is used.
  269.  * Otherwise, it stores the error if any.
  270.  */
  271.  
  272. /*****************************************************************************
  273.  **
  274.  ** xcb_damage_query_version_reply_t * xcb_damage_query_version_reply
  275.  ** 
  276.  ** @param xcb_connection_t                   *c
  277.  ** @param xcb_damage_query_version_cookie_t   cookie
  278.  ** @param xcb_generic_error_t               **e
  279.  ** @returns xcb_damage_query_version_reply_t *
  280.  **
  281.  *****************************************************************************/
  282.  
  283. xcb_damage_query_version_reply_t *
  284. xcb_damage_query_version_reply (xcb_connection_t                   *c  /**< */,
  285.                                 xcb_damage_query_version_cookie_t   cookie  /**< */,
  286.                                 xcb_generic_error_t               **e  /**< */);
  287.  
  288. /**
  289.  * Delivers a request to the X server
  290.  * @param c The connection
  291.  * @return A cookie
  292.  *
  293.  * Delivers a request to the X server.
  294.  * 
  295.  * This form can be used only if the request will not cause
  296.  * a reply to be generated. Any returned error will be
  297.  * saved for handling by xcb_request_check().
  298.  */
  299.  
  300. /*****************************************************************************
  301.  **
  302.  ** xcb_void_cookie_t xcb_damage_create_checked
  303.  ** 
  304.  ** @param xcb_connection_t    *c
  305.  ** @param xcb_damage_damage_t  damage
  306.  ** @param xcb_drawable_t       drawable
  307.  ** @param uint8_t              level
  308.  ** @returns xcb_void_cookie_t
  309.  **
  310.  *****************************************************************************/
  311.  
  312. xcb_void_cookie_t
  313. xcb_damage_create_checked (xcb_connection_t    *c  /**< */,
  314.                            xcb_damage_damage_t  damage  /**< */,
  315.                            xcb_drawable_t       drawable  /**< */,
  316.                            uint8_t              level  /**< */);
  317.  
  318. /**
  319.  * Delivers a request to the X server
  320.  * @param c The connection
  321.  * @return A cookie
  322.  *
  323.  * Delivers a request to the X server.
  324.  * 
  325.  */
  326.  
  327. /*****************************************************************************
  328.  **
  329.  ** xcb_void_cookie_t xcb_damage_create
  330.  ** 
  331.  ** @param xcb_connection_t    *c
  332.  ** @param xcb_damage_damage_t  damage
  333.  ** @param xcb_drawable_t       drawable
  334.  ** @param uint8_t              level
  335.  ** @returns xcb_void_cookie_t
  336.  **
  337.  *****************************************************************************/
  338.  
  339. xcb_void_cookie_t
  340. xcb_damage_create (xcb_connection_t    *c  /**< */,
  341.                    xcb_damage_damage_t  damage  /**< */,
  342.                    xcb_drawable_t       drawable  /**< */,
  343.                    uint8_t              level  /**< */);
  344.  
  345. /**
  346.  * Delivers a request to the X server
  347.  * @param c The connection
  348.  * @return A cookie
  349.  *
  350.  * Delivers a request to the X server.
  351.  * 
  352.  * This form can be used only if the request will not cause
  353.  * a reply to be generated. Any returned error will be
  354.  * saved for handling by xcb_request_check().
  355.  */
  356.  
  357. /*****************************************************************************
  358.  **
  359.  ** xcb_void_cookie_t xcb_damage_destroy_checked
  360.  ** 
  361.  ** @param xcb_connection_t    *c
  362.  ** @param xcb_damage_damage_t  damage
  363.  ** @returns xcb_void_cookie_t
  364.  **
  365.  *****************************************************************************/
  366.  
  367. xcb_void_cookie_t
  368. xcb_damage_destroy_checked (xcb_connection_t    *c  /**< */,
  369.                             xcb_damage_damage_t  damage  /**< */);
  370.  
  371. /**
  372.  * Delivers a request to the X server
  373.  * @param c The connection
  374.  * @return A cookie
  375.  *
  376.  * Delivers a request to the X server.
  377.  * 
  378.  */
  379.  
  380. /*****************************************************************************
  381.  **
  382.  ** xcb_void_cookie_t xcb_damage_destroy
  383.  ** 
  384.  ** @param xcb_connection_t    *c
  385.  ** @param xcb_damage_damage_t  damage
  386.  ** @returns xcb_void_cookie_t
  387.  **
  388.  *****************************************************************************/
  389.  
  390. xcb_void_cookie_t
  391. xcb_damage_destroy (xcb_connection_t    *c  /**< */,
  392.                     xcb_damage_damage_t  damage  /**< */);
  393.  
  394. /**
  395.  * Delivers a request to the X server
  396.  * @param c The connection
  397.  * @return A cookie
  398.  *
  399.  * Delivers a request to the X server.
  400.  * 
  401.  * This form can be used only if the request will not cause
  402.  * a reply to be generated. Any returned error will be
  403.  * saved for handling by xcb_request_check().
  404.  */
  405.  
  406. /*****************************************************************************
  407.  **
  408.  ** xcb_void_cookie_t xcb_damage_subtract_checked
  409.  ** 
  410.  ** @param xcb_connection_t    *c
  411.  ** @param xcb_damage_damage_t  damage
  412.  ** @param xcb_xfixes_region_t  repair
  413.  ** @param xcb_xfixes_region_t  parts
  414.  ** @returns xcb_void_cookie_t
  415.  **
  416.  *****************************************************************************/
  417.  
  418. xcb_void_cookie_t
  419. xcb_damage_subtract_checked (xcb_connection_t    *c  /**< */,
  420.                              xcb_damage_damage_t  damage  /**< */,
  421.                              xcb_xfixes_region_t  repair  /**< */,
  422.                              xcb_xfixes_region_t  parts  /**< */);
  423.  
  424. /**
  425.  * Delivers a request to the X server
  426.  * @param c The connection
  427.  * @return A cookie
  428.  *
  429.  * Delivers a request to the X server.
  430.  * 
  431.  */
  432.  
  433. /*****************************************************************************
  434.  **
  435.  ** xcb_void_cookie_t xcb_damage_subtract
  436.  ** 
  437.  ** @param xcb_connection_t    *c
  438.  ** @param xcb_damage_damage_t  damage
  439.  ** @param xcb_xfixes_region_t  repair
  440.  ** @param xcb_xfixes_region_t  parts
  441.  ** @returns xcb_void_cookie_t
  442.  **
  443.  *****************************************************************************/
  444.  
  445. xcb_void_cookie_t
  446. xcb_damage_subtract (xcb_connection_t    *c  /**< */,
  447.                      xcb_damage_damage_t  damage  /**< */,
  448.                      xcb_xfixes_region_t  repair  /**< */,
  449.                      xcb_xfixes_region_t  parts  /**< */);
  450.  
  451. /**
  452.  * Delivers a request to the X server
  453.  * @param c The connection
  454.  * @return A cookie
  455.  *
  456.  * Delivers a request to the X server.
  457.  * 
  458.  * This form can be used only if the request will not cause
  459.  * a reply to be generated. Any returned error will be
  460.  * saved for handling by xcb_request_check().
  461.  */
  462.  
  463. /*****************************************************************************
  464.  **
  465.  ** xcb_void_cookie_t xcb_damage_add_checked
  466.  ** 
  467.  ** @param xcb_connection_t    *c
  468.  ** @param xcb_drawable_t       drawable
  469.  ** @param xcb_xfixes_region_t  region
  470.  ** @returns xcb_void_cookie_t
  471.  **
  472.  *****************************************************************************/
  473.  
  474. xcb_void_cookie_t
  475. xcb_damage_add_checked (xcb_connection_t    *c  /**< */,
  476.                         xcb_drawable_t       drawable  /**< */,
  477.                         xcb_xfixes_region_t  region  /**< */);
  478.  
  479. /**
  480.  * Delivers a request to the X server
  481.  * @param c The connection
  482.  * @return A cookie
  483.  *
  484.  * Delivers a request to the X server.
  485.  * 
  486.  */
  487.  
  488. /*****************************************************************************
  489.  **
  490.  ** xcb_void_cookie_t xcb_damage_add
  491.  ** 
  492.  ** @param xcb_connection_t    *c
  493.  ** @param xcb_drawable_t       drawable
  494.  ** @param xcb_xfixes_region_t  region
  495.  ** @returns xcb_void_cookie_t
  496.  **
  497.  *****************************************************************************/
  498.  
  499. xcb_void_cookie_t
  500. xcb_damage_add (xcb_connection_t    *c  /**< */,
  501.                 xcb_drawable_t       drawable  /**< */,
  502.                 xcb_xfixes_region_t  region  /**< */);
  503.  
  504.  
  505. #endif
  506.  
  507. /**
  508.  * @}
  509.  */
  510.