XCB Damage API

Damage XCB Protocol Implementation. More...

Data Structures
struct	xcb_damage_damage_iterator_t
	xcb_damage_damage_iterator_t More...
struct	xcb_damage_bad_damage_error_t
	xcb_damage_bad_damage_error_t More...
struct	xcb_damage_query_version_cookie_t
	xcb_damage_query_version_cookie_t More...
struct	xcb_damage_query_version_request_t
	xcb_damage_query_version_request_t More...
struct	xcb_damage_query_version_reply_t
	xcb_damage_query_version_reply_t More...
struct	xcb_damage_create_request_t
	xcb_damage_create_request_t More...
struct	xcb_damage_destroy_request_t
	xcb_damage_destroy_request_t More...
struct	xcb_damage_subtract_request_t
	xcb_damage_subtract_request_t More...
struct	xcb_damage_add_request_t
	xcb_damage_add_request_t More...
struct	xcb_damage_notify_event_t
	xcb_damage_notify_event_t More...

Macros
#define	XCB_DAMAGE_MAJOR_VERSION   1
#define	XCB_DAMAGE_MINOR_VERSION   1
#define	XCB_DAMAGE_BAD_DAMAGE   0
#define	XCB_DAMAGE_QUERY_VERSION   0
#define	XCB_DAMAGE_CREATE   1
#define	XCB_DAMAGE_DESTROY   2
#define	XCB_DAMAGE_SUBTRACT   3
#define	XCB_DAMAGE_ADD   4
#define	XCB_DAMAGE_NOTIFY   0

Typedefs
typedef uint32_t	xcb_damage_damage_t
typedef struct xcb_damage_damage_iterator_t	xcb_damage_damage_iterator_t
	xcb_damage_damage_iterator_t
typedef enum xcb_damage_report_level_t	xcb_damage_report_level_t
typedef struct xcb_damage_bad_damage_error_t	xcb_damage_bad_damage_error_t
	xcb_damage_bad_damage_error_t
typedef struct xcb_damage_query_version_cookie_t	xcb_damage_query_version_cookie_t
	xcb_damage_query_version_cookie_t
typedef struct xcb_damage_query_version_request_t	xcb_damage_query_version_request_t
	xcb_damage_query_version_request_t
typedef struct xcb_damage_query_version_reply_t	xcb_damage_query_version_reply_t
	xcb_damage_query_version_reply_t
typedef struct xcb_damage_create_request_t	xcb_damage_create_request_t
	xcb_damage_create_request_t
typedef struct xcb_damage_destroy_request_t	xcb_damage_destroy_request_t
	xcb_damage_destroy_request_t
typedef struct xcb_damage_subtract_request_t	xcb_damage_subtract_request_t
	xcb_damage_subtract_request_t
typedef struct xcb_damage_add_request_t	xcb_damage_add_request_t
	xcb_damage_add_request_t
typedef struct xcb_damage_notify_event_t	xcb_damage_notify_event_t
	xcb_damage_notify_event_t

Enumerations
enum	xcb_damage_report_level_t { XCB_DAMAGE_REPORT_LEVEL_RAW_RECTANGLES = 0, XCB_DAMAGE_REPORT_LEVEL_DELTA_RECTANGLES = 1, XCB_DAMAGE_REPORT_LEVEL_BOUNDING_BOX = 2, XCB_DAMAGE_REPORT_LEVEL_NON_EMPTY = 3 }

Functions
void	xcb_damage_damage_next (xcb_damage_damage_iterator_t *i)
xcb_generic_iterator_t	xcb_damage_damage_end (xcb_damage_damage_iterator_t i)
xcb_damage_query_version_cookie_t	xcb_damage_query_version (xcb_connection_t *c, uint32_t client_major_version, uint32_t client_minor_version)
xcb_damage_query_version_cookie_t	xcb_damage_query_version_unchecked (xcb_connection_t *c, uint32_t client_major_version, uint32_t client_minor_version)
xcb_damage_query_version_reply_t *	xcb_damage_query_version_reply (xcb_connection_t *c, xcb_damage_query_version_cookie_t cookie, xcb_generic_error_t **e)
xcb_void_cookie_t	xcb_damage_create_checked (xcb_connection_t *c, xcb_damage_damage_t damage, xcb_drawable_t drawable, uint8_t level)
xcb_void_cookie_t	xcb_damage_create (xcb_connection_t *c, xcb_damage_damage_t damage, xcb_drawable_t drawable, uint8_t level)
xcb_void_cookie_t	xcb_damage_destroy_checked (xcb_connection_t *c, xcb_damage_damage_t damage)
xcb_void_cookie_t	xcb_damage_destroy (xcb_connection_t *c, xcb_damage_damage_t damage)
xcb_void_cookie_t	xcb_damage_subtract_checked (xcb_connection_t *c, xcb_damage_damage_t damage, xcb_xfixes_region_t repair, xcb_xfixes_region_t parts)
xcb_void_cookie_t	xcb_damage_subtract (xcb_connection_t *c, xcb_damage_damage_t damage, xcb_xfixes_region_t repair, xcb_xfixes_region_t parts)
xcb_void_cookie_t	xcb_damage_add_checked (xcb_connection_t *c, xcb_drawable_t drawable, xcb_xfixes_region_t region)
xcb_void_cookie_t	xcb_damage_add (xcb_connection_t *c, xcb_drawable_t drawable, xcb_xfixes_region_t region)

Variables
xcb_extension_t	xcb_damage_id

Detailed Description

Damage XCB Protocol Implementation.

Macro Definition Documentation

#define XCB_DAMAGE_ADD   4

Opcode for xcb_damage_add.

Referenced by xcb_damage_add(), and xcb_damage_add_checked().

#define XCB_DAMAGE_BAD_DAMAGE   0

Opcode for xcb_damage_bad_damage.

#define XCB_DAMAGE_CREATE   1

Opcode for xcb_damage_create.

Referenced by xcb_damage_create(), and xcb_damage_create_checked().

#define XCB_DAMAGE_DESTROY   2

Opcode for xcb_damage_destroy.

Referenced by xcb_damage_destroy(), and xcb_damage_destroy_checked().

#define XCB_DAMAGE_NOTIFY   0

Opcode for xcb_damage_notify.

#define XCB_DAMAGE_QUERY_VERSION   0

Opcode for xcb_damage_query_version.

Referenced by xcb_damage_query_version(), and xcb_damage_query_version_unchecked().

#define XCB_DAMAGE_SUBTRACT   3

Opcode for xcb_damage_subtract.

Referenced by xcb_damage_subtract(), and xcb_damage_subtract_checked().

Function Documentation

xcb_void_cookie_t xcb_damage_add	(	xcb_connection_t *	c,
		xcb_drawable_t	drawable,
		xcb_xfixes_region_t	region
	)

Parameters

c	The connection

Returns

A cookie

Delivers a request to the X server.

References XCB_DAMAGE_ADD.

xcb_void_cookie_t xcb_damage_add_checked	(	xcb_connection_t *	c,
		xcb_drawable_t	drawable,
		xcb_xfixes_region_t	region
	)

Parameters

c	The connection

Returns

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().

References XCB_DAMAGE_ADD.

xcb_void_cookie_t xcb_damage_create	(	xcb_connection_t *	c,
		xcb_damage_damage_t	damage,
		xcb_drawable_t	drawable,
		uint8_t	level
	)

Parameters

c	The connection

Returns

A cookie

Delivers a request to the X server.

References XCB_DAMAGE_CREATE.

xcb_void_cookie_t xcb_damage_create_checked	(	xcb_connection_t *	c,
		xcb_damage_damage_t	damage,
		xcb_drawable_t	drawable,
		uint8_t	level
	)

Parameters

c	The connection

Returns

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().

References XCB_DAMAGE_CREATE.

xcb_generic_iterator_t xcb_damage_damage_end

(

xcb_damage_damage_iterator_t

i

)

Return the iterator pointing to the last element

Parameters

i	An xcb_damage_damage_iterator_t

Returns

The iterator pointing to the last element

Set the current element in the iterator to the last element. The member rem is set to 0. The member data points to the last element.

References xcb_generic_iterator_t::data, xcb_generic_iterator_t::index, and xcb_generic_iterator_t::rem.

void xcb_damage_damage_next

(

xcb_damage_damage_iterator_t *

i

)

Get the next element of the iterator

Parameters

i	Pointer to a xcb_damage_damage_iterator_t

Get the next element in the iterator. The member rem is decreased by one. The member data points to the next element. The member index is increased by sizeof(xcb_damage_damage_t)

xcb_void_cookie_t xcb_damage_destroy	(	xcb_connection_t *	c,
		xcb_damage_damage_t	damage
	)

Parameters

c	The connection

Returns

A cookie

Delivers a request to the X server.

References XCB_DAMAGE_DESTROY.

xcb_void_cookie_t xcb_damage_destroy_checked	(	xcb_connection_t *	c,
		xcb_damage_damage_t	damage
	)

Parameters

c	The connection

Returns

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().

References XCB_DAMAGE_DESTROY.

xcb_damage_query_version_cookie_t xcb_damage_query_version	(	xcb_connection_t *	c,
		uint32_t	client_major_version,
		uint32_t	client_minor_version
	)

Parameters

c	The connection

Returns

A cookie

Delivers a request to the X server.

References XCB_DAMAGE_QUERY_VERSION.

xcb_damage_query_version_reply_t* xcb_damage_query_version_reply	(	xcb_connection_t *	c,
		xcb_damage_query_version_cookie_t	cookie,
		xcb_generic_error_t **	e
	)

Return the reply

Parameters

c	The connection
cookie	The cookie
e	The xcb_generic_error_t supplied

Returns the reply of the request asked by

The parameter e supplied to this function must be NULL if xcb_damage_query_version_unchecked(). is used. Otherwise, it stores the error if any.

The returned value must be freed by the caller using free().

xcb_damage_query_version_cookie_t xcb_damage_query_version_unchecked	(	xcb_connection_t *	c,
		uint32_t	client_major_version,
		uint32_t	client_minor_version
	)

Parameters

c	The connection

Returns

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.

References XCB_DAMAGE_QUERY_VERSION.

xcb_void_cookie_t xcb_damage_subtract	(	xcb_connection_t *	c,
		xcb_damage_damage_t	damage,
		xcb_xfixes_region_t	repair,
		xcb_xfixes_region_t	parts
	)

Parameters

c	The connection

Returns

A cookie

Delivers a request to the X server.

References XCB_DAMAGE_SUBTRACT.

xcb_void_cookie_t xcb_damage_subtract_checked	(	xcb_connection_t *	c,
		xcb_damage_damage_t	damage,
		xcb_xfixes_region_t	repair,
		xcb_xfixes_region_t	parts
	)

Parameters

c	The connection

Returns

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().

References XCB_DAMAGE_SUBTRACT.