XCB Shm API

Shm XCB Protocol Implementation. More...

Data Structures

struct  xcb_shm_seg_iterator_t
 xcb_shm_seg_iterator_t More...
struct  xcb_shm_completion_event_t
 xcb_shm_completion_event_t More...
struct  xcb_shm_query_version_cookie_t
 xcb_shm_query_version_cookie_t More...
struct  xcb_shm_query_version_request_t
 xcb_shm_query_version_request_t More...
struct  xcb_shm_query_version_reply_t
 xcb_shm_query_version_reply_t More...
struct  xcb_shm_attach_request_t
 xcb_shm_attach_request_t More...
struct  xcb_shm_detach_request_t
 xcb_shm_detach_request_t More...
struct  xcb_shm_put_image_request_t
 xcb_shm_put_image_request_t More...
struct  xcb_shm_get_image_cookie_t
 xcb_shm_get_image_cookie_t More...
struct  xcb_shm_get_image_request_t
 xcb_shm_get_image_request_t More...
struct  xcb_shm_get_image_reply_t
 xcb_shm_get_image_reply_t More...
struct  xcb_shm_create_pixmap_request_t
 xcb_shm_create_pixmap_request_t More...

Defines

#define XCB_SHM_MAJOR_VERSION   1
#define XCB_SHM_MINOR_VERSION   1
#define XCB_SHM_COMPLETION   0
#define XCB_SHM_BAD_SEG   0
#define XCB_SHM_QUERY_VERSION   0
#define XCB_SHM_ATTACH   1
#define XCB_SHM_DETACH   2
#define XCB_SHM_PUT_IMAGE   3
#define XCB_SHM_GET_IMAGE   4
#define XCB_SHM_CREATE_PIXMAP   5

Typedefs

typedef uint32_t xcb_shm_seg_t
typedef xcb_value_error_t xcb_shm_bad_seg_error_t

Functions

void xcb_shm_seg_next (xcb_shm_seg_iterator_t *i)
xcb_generic_iterator_t xcb_shm_seg_end (xcb_shm_seg_iterator_t i)
xcb_shm_query_version_cookie_t xcb_shm_query_version (xcb_connection_t *c)
xcb_shm_query_version_cookie_t xcb_shm_query_version_unchecked (xcb_connection_t *c)
xcb_shm_query_version_reply_txcb_shm_query_version_reply (xcb_connection_t *c, xcb_shm_query_version_cookie_t cookie, xcb_generic_error_t **e)
xcb_void_cookie_t xcb_shm_attach_checked (xcb_connection_t *c, xcb_shm_seg_t shmseg, uint32_t shmid, uint8_t read_only)
xcb_void_cookie_t xcb_shm_attach (xcb_connection_t *c, xcb_shm_seg_t shmseg, uint32_t shmid, uint8_t read_only)
xcb_void_cookie_t xcb_shm_detach_checked (xcb_connection_t *c, xcb_shm_seg_t shmseg)
xcb_void_cookie_t xcb_shm_detach (xcb_connection_t *c, xcb_shm_seg_t shmseg)
xcb_void_cookie_t xcb_shm_put_image_checked (xcb_connection_t *c, xcb_drawable_t drawable, xcb_gcontext_t gc, uint16_t total_width, uint16_t total_height, uint16_t src_x, uint16_t src_y, uint16_t src_width, uint16_t src_height, int16_t dst_x, int16_t dst_y, uint8_t depth, uint8_t format, uint8_t send_event, xcb_shm_seg_t shmseg, uint32_t offset)
xcb_void_cookie_t xcb_shm_put_image (xcb_connection_t *c, xcb_drawable_t drawable, xcb_gcontext_t gc, uint16_t total_width, uint16_t total_height, uint16_t src_x, uint16_t src_y, uint16_t src_width, uint16_t src_height, int16_t dst_x, int16_t dst_y, uint8_t depth, uint8_t format, uint8_t send_event, xcb_shm_seg_t shmseg, uint32_t offset)
xcb_shm_get_image_cookie_t xcb_shm_get_image (xcb_connection_t *c, xcb_drawable_t drawable, int16_t x, int16_t y, uint16_t width, uint16_t height, uint32_t plane_mask, uint8_t format, xcb_shm_seg_t shmseg, uint32_t offset)
xcb_shm_get_image_cookie_t xcb_shm_get_image_unchecked (xcb_connection_t *c, xcb_drawable_t drawable, int16_t x, int16_t y, uint16_t width, uint16_t height, uint32_t plane_mask, uint8_t format, xcb_shm_seg_t shmseg, uint32_t offset)
xcb_shm_get_image_reply_txcb_shm_get_image_reply (xcb_connection_t *c, xcb_shm_get_image_cookie_t cookie, xcb_generic_error_t **e)
xcb_void_cookie_t xcb_shm_create_pixmap_checked (xcb_connection_t *c, xcb_pixmap_t pid, xcb_drawable_t drawable, uint16_t width, uint16_t height, uint8_t depth, xcb_shm_seg_t shmseg, uint32_t offset)
xcb_void_cookie_t xcb_shm_create_pixmap (xcb_connection_t *c, xcb_pixmap_t pid, xcb_drawable_t drawable, uint16_t width, uint16_t height, uint8_t depth, xcb_shm_seg_t shmseg, uint32_t offset)

Variables

xcb_extension_t xcb_shm_id

Detailed Description

Shm XCB Protocol Implementation.


Define Documentation

#define XCB_SHM_ATTACH   1

Opcode for xcb_shm_attach.

Referenced by xcb_shm_attach(), and xcb_shm_attach_checked().

#define XCB_SHM_BAD_SEG   0

Opcode for xcb_shm_bad_seg.

#define XCB_SHM_COMPLETION   0

Opcode for xcb_shm_completion.

#define XCB_SHM_CREATE_PIXMAP   5

Opcode for xcb_shm_create_pixmap.

Referenced by xcb_shm_create_pixmap(), and xcb_shm_create_pixmap_checked().

#define XCB_SHM_DETACH   2

Opcode for xcb_shm_detach.

Referenced by xcb_shm_detach(), and xcb_shm_detach_checked().

#define XCB_SHM_GET_IMAGE   4

Opcode for xcb_shm_get_image.

Referenced by xcb_shm_get_image(), and xcb_shm_get_image_unchecked().

#define XCB_SHM_PUT_IMAGE   3

Opcode for xcb_shm_put_image.

Referenced by xcb_shm_put_image(), and xcb_shm_put_image_checked().

#define XCB_SHM_QUERY_VERSION   0

Opcode for xcb_shm_query_version.

Referenced by xcb_shm_query_version(), and xcb_shm_query_version_unchecked().


Function Documentation

xcb_void_cookie_t xcb_shm_attach ( xcb_connection_t c,
xcb_shm_seg_t  shmseg,
uint32_t  shmid,
uint8_t  read_only 
)

Delivers a request to the X server

Parameters:
c The connection
Returns:
A cookie
Delivers a request to the X server.

References xcb_shm_attach_request_t::read_only, xcb_shm_attach_request_t::shmid, xcb_shm_attach_request_t::shmseg, and XCB_SHM_ATTACH.

xcb_void_cookie_t xcb_shm_attach_checked ( xcb_connection_t c,
xcb_shm_seg_t  shmseg,
uint32_t  shmid,
uint8_t  read_only 
)

Delivers a request to the X server

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_shm_attach_request_t::read_only, xcb_shm_attach_request_t::shmid, xcb_shm_attach_request_t::shmseg, and XCB_SHM_ATTACH.

xcb_void_cookie_t xcb_shm_create_pixmap ( xcb_connection_t c,
xcb_pixmap_t  pid,
xcb_drawable_t  drawable,
uint16_t  width,
uint16_t  height,
uint8_t  depth,
xcb_shm_seg_t  shmseg,
uint32_t  offset 
)

xcb_void_cookie_t xcb_shm_create_pixmap_checked ( xcb_connection_t c,
xcb_pixmap_t  pid,
xcb_drawable_t  drawable,
uint16_t  width,
uint16_t  height,
uint8_t  depth,
xcb_shm_seg_t  shmseg,
uint32_t  offset 
)

Delivers a request to the X server

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_shm_create_pixmap_request_t::depth, xcb_shm_create_pixmap_request_t::drawable, xcb_shm_create_pixmap_request_t::height, xcb_shm_create_pixmap_request_t::offset, xcb_shm_create_pixmap_request_t::pad0, xcb_shm_create_pixmap_request_t::pid, xcb_shm_create_pixmap_request_t::shmseg, xcb_shm_create_pixmap_request_t::width, and XCB_SHM_CREATE_PIXMAP.

xcb_void_cookie_t xcb_shm_detach ( xcb_connection_t c,
xcb_shm_seg_t  shmseg 
)

Delivers a request to the X server

Parameters:
c The connection
Returns:
A cookie
Delivers a request to the X server.

References xcb_shm_detach_request_t::shmseg, and XCB_SHM_DETACH.

xcb_void_cookie_t xcb_shm_detach_checked ( xcb_connection_t c,
xcb_shm_seg_t  shmseg 
)

Delivers a request to the X server

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_shm_detach_request_t::shmseg, and XCB_SHM_DETACH.

xcb_shm_get_image_cookie_t xcb_shm_get_image ( xcb_connection_t c,
xcb_drawable_t  drawable,
int16_t  x,
int16_t  y,
uint16_t  width,
uint16_t  height,
uint32_t  plane_mask,
uint8_t  format,
xcb_shm_seg_t  shmseg,
uint32_t  offset 
)

xcb_shm_get_image_reply_t* xcb_shm_get_image_reply ( xcb_connection_t c,
xcb_shm_get_image_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_shm_get_image_unchecked(). is used. Otherwise, it stores the error if any.

References xcb_shm_get_image_cookie_t::sequence.

xcb_shm_get_image_cookie_t xcb_shm_get_image_unchecked ( xcb_connection_t c,
xcb_drawable_t  drawable,
int16_t  x,
int16_t  y,
uint16_t  width,
uint16_t  height,
uint32_t  plane_mask,
uint8_t  format,
xcb_shm_seg_t  shmseg,
uint32_t  offset 
)

Delivers a request to the X server

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_shm_get_image_request_t::drawable, xcb_shm_get_image_request_t::format, xcb_shm_get_image_request_t::height, xcb_shm_get_image_request_t::offset, xcb_shm_get_image_request_t::pad0, xcb_shm_get_image_request_t::plane_mask, xcb_shm_get_image_request_t::shmseg, xcb_shm_get_image_request_t::width, xcb_shm_get_image_request_t::x, XCB_SHM_GET_IMAGE, and xcb_shm_get_image_request_t::y.

xcb_void_cookie_t xcb_shm_put_image ( xcb_connection_t c,
xcb_drawable_t  drawable,
xcb_gcontext_t  gc,
uint16_t  total_width,
uint16_t  total_height,
uint16_t  src_x,
uint16_t  src_y,
uint16_t  src_width,
uint16_t  src_height,
int16_t  dst_x,
int16_t  dst_y,
uint8_t  depth,
uint8_t  format,
uint8_t  send_event,
xcb_shm_seg_t  shmseg,
uint32_t  offset 
)

xcb_void_cookie_t xcb_shm_put_image_checked ( xcb_connection_t c,
xcb_drawable_t  drawable,
xcb_gcontext_t  gc,
uint16_t  total_width,
uint16_t  total_height,
uint16_t  src_x,
uint16_t  src_y,
uint16_t  src_width,
uint16_t  src_height,
int16_t  dst_x,
int16_t  dst_y,
uint8_t  depth,
uint8_t  format,
uint8_t  send_event,
xcb_shm_seg_t  shmseg,
uint32_t  offset 
)

xcb_shm_query_version_cookie_t xcb_shm_query_version ( xcb_connection_t c  ) 

Delivers a request to the X server

Parameters:
c The connection
Returns:
A cookie
Delivers a request to the X server.

References XCB_SHM_QUERY_VERSION.

xcb_shm_query_version_reply_t* xcb_shm_query_version_reply ( xcb_connection_t c,
xcb_shm_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_shm_query_version_unchecked(). is used. Otherwise, it stores the error if any.

References xcb_shm_query_version_cookie_t::sequence.

xcb_shm_query_version_cookie_t xcb_shm_query_version_unchecked ( xcb_connection_t c  ) 

Delivers a request to the X server

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_SHM_QUERY_VERSION.

xcb_generic_iterator_t xcb_shm_seg_end ( xcb_shm_seg_iterator_t  i  ) 

Return the iterator pointing to the last element

Parameters:
i An xcb_shm_seg_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_shm_seg_iterator_t::data, xcb_generic_iterator_t::data, xcb_shm_seg_iterator_t::index, xcb_generic_iterator_t::index, xcb_generic_iterator_t::rem, and xcb_shm_seg_iterator_t::rem.

void xcb_shm_seg_next ( xcb_shm_seg_iterator_t i  ) 

Get the next element of the iterator

Parameters:
i Pointer to a xcb_shm_seg_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_shm_seg_t)

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


Generated on Sun Jul 27 21:19:01 2008 for XCB by  doxygen 1.5.6