XCB  1.13.1
Data Structures | Macros | Typedefs | Functions | Variables
XCB XWM API

XWM XCB Protocol Implementation. More...

Data Structures

struct  xcb_xwm_query_version_cookie_t
 xcb_xwm_query_version_cookie_t More...
 
struct  xcb_xwm_query_version_request_t
 xcb_xwm_query_version_request_t More...
 
struct  xcb_xwm_query_version_reply_t
 xcb_xwm_query_version_reply_t More...
 
struct  xcb_xwm_set_virtual_vblank_interval_request_t
 xcb_xwm_set_virtual_vblank_interval_request_t More...
 
struct  xcb_xwm_add_display_request_t
 xcb_xwm_add_display_request_t More...
 
struct  xcb_xwm_remove_display_request_t
 xcb_xwm_remove_display_request_t More...
 
struct  xcb_xwm_set_mode_request_t
 xcb_xwm_set_mode_request_t More...
 
struct  xcb_xwm_get_client_pid_cookie_t
 xcb_xwm_get_client_pid_cookie_t More...
 
struct  xcb_xwm_get_client_pid_request_t
 xcb_xwm_get_client_pid_request_t More...
 
struct  xcb_xwm_get_client_pid_reply_t
 xcb_xwm_get_client_pid_reply_t More...
 
struct  xcb_xwm_set_app_id_request_t
 xcb_xwm_set_app_id_request_t More...
 

Macros

#define XCB_XWM_MAJOR_VERSION   1
 
#define XCB_XWM_MINOR_VERSION   3
 
#define XCB_XWM_QUERY_VERSION   0
 
#define XCB_XWM_SET_VIRTUAL_VBLANK_INTERVAL   1
 
#define XCB_XWM_ADD_DISPLAY   2
 
#define XCB_XWM_REMOVE_DISPLAY   3
 
#define XCB_XWM_SET_MODE   4
 
#define XCB_XWM_GET_CLIENT_PID   5
 
#define XCB_XWM_SET_APP_ID   6
 

Typedefs

typedef struct xcb_xwm_query_version_cookie_t xcb_xwm_query_version_cookie_t
 xcb_xwm_query_version_cookie_t
 
typedef struct xcb_xwm_query_version_request_t xcb_xwm_query_version_request_t
 xcb_xwm_query_version_request_t
 
typedef struct xcb_xwm_query_version_reply_t xcb_xwm_query_version_reply_t
 xcb_xwm_query_version_reply_t
 
typedef struct xcb_xwm_set_virtual_vblank_interval_request_t xcb_xwm_set_virtual_vblank_interval_request_t
 xcb_xwm_set_virtual_vblank_interval_request_t
 
typedef struct xcb_xwm_add_display_request_t xcb_xwm_add_display_request_t
 xcb_xwm_add_display_request_t
 
typedef struct xcb_xwm_remove_display_request_t xcb_xwm_remove_display_request_t
 xcb_xwm_remove_display_request_t
 
typedef struct xcb_xwm_set_mode_request_t xcb_xwm_set_mode_request_t
 xcb_xwm_set_mode_request_t
 
typedef struct xcb_xwm_get_client_pid_cookie_t xcb_xwm_get_client_pid_cookie_t
 xcb_xwm_get_client_pid_cookie_t
 
typedef struct xcb_xwm_get_client_pid_request_t xcb_xwm_get_client_pid_request_t
 xcb_xwm_get_client_pid_request_t
 
typedef struct xcb_xwm_get_client_pid_reply_t xcb_xwm_get_client_pid_reply_t
 xcb_xwm_get_client_pid_reply_t
 
typedef struct xcb_xwm_set_app_id_request_t xcb_xwm_set_app_id_request_t
 xcb_xwm_set_app_id_request_t
 

Functions

xcb_xwm_query_version_cookie_t xcb_xwm_query_version (xcb_connection_t *c, uint32_t major_version, uint32_t minor_version)
 
xcb_xwm_query_version_cookie_t xcb_xwm_query_version_unchecked (xcb_connection_t *c, uint32_t major_version, uint32_t minor_version)
 
xcb_xwm_query_version_reply_txcb_xwm_query_version_reply (xcb_connection_t *c, xcb_xwm_query_version_cookie_t cookie, xcb_generic_error_t **e)
 
xcb_void_cookie_t xcb_xwm_set_virtual_vblank_interval_checked (xcb_connection_t *c, uint32_t interval_ms)
 
xcb_void_cookie_t xcb_xwm_set_virtual_vblank_interval (xcb_connection_t *c, uint32_t interval_ms)
 
xcb_void_cookie_t xcb_xwm_add_display_checked (xcb_connection_t *c, int32_t id, int16_t x, int16_t y, uint16_t width, uint16_t height, uint16_t rotation)
 
xcb_void_cookie_t xcb_xwm_add_display (xcb_connection_t *c, int32_t id, int16_t x, int16_t y, uint16_t width, uint16_t height, uint16_t rotation)
 
xcb_void_cookie_t xcb_xwm_remove_display_checked (xcb_connection_t *c, int32_t id)
 
xcb_void_cookie_t xcb_xwm_remove_display (xcb_connection_t *c, int32_t id)
 
xcb_void_cookie_t xcb_xwm_set_mode_checked (xcb_connection_t *c, int32_t id, uint16_t width, uint16_t height, uint16_t rotation, uint16_t refreshRate)
 
xcb_void_cookie_t xcb_xwm_set_mode (xcb_connection_t *c, int32_t id, uint16_t width, uint16_t height, uint16_t rotation, uint16_t refreshRate)
 
xcb_xwm_get_client_pid_cookie_t xcb_xwm_get_client_pid (xcb_connection_t *c, uint32_t window)
 
xcb_xwm_get_client_pid_cookie_t xcb_xwm_get_client_pid_unchecked (xcb_connection_t *c, uint32_t window)
 
xcb_xwm_get_client_pid_reply_txcb_xwm_get_client_pid_reply (xcb_connection_t *c, xcb_xwm_get_client_pid_cookie_t cookie, xcb_generic_error_t **e)
 
xcb_void_cookie_t xcb_xwm_set_app_id_checked (xcb_connection_t *c, uint32_t window, uint32_t fileSize, int32_t app_id_fd)
 
xcb_void_cookie_t xcb_xwm_set_app_id (xcb_connection_t *c, uint32_t window, uint32_t fileSize, int32_t app_id_fd)
 

Variables

xcb_extension_t xcb_xwm_id
 

Detailed Description

XWM XCB Protocol Implementation.

Macro Definition Documentation

◆ XCB_XWM_ADD_DISPLAY

#define XCB_XWM_ADD_DISPLAY   2

Opcode for xcb_xwm_add_display.

◆ XCB_XWM_GET_CLIENT_PID

#define XCB_XWM_GET_CLIENT_PID   5

Opcode for xcb_xwm_get_client_pid.

◆ XCB_XWM_QUERY_VERSION

#define XCB_XWM_QUERY_VERSION   0

Opcode for xcb_xwm_query_version.

◆ XCB_XWM_REMOVE_DISPLAY

#define XCB_XWM_REMOVE_DISPLAY   3

Opcode for xcb_xwm_remove_display.

◆ XCB_XWM_SET_APP_ID

#define XCB_XWM_SET_APP_ID   6

Opcode for xcb_xwm_set_app_id.

◆ XCB_XWM_SET_MODE

#define XCB_XWM_SET_MODE   4

Opcode for xcb_xwm_set_mode.

◆ XCB_XWM_SET_VIRTUAL_VBLANK_INTERVAL

#define XCB_XWM_SET_VIRTUAL_VBLANK_INTERVAL   1

Opcode for xcb_xwm_set_virtual_vblank_interval.

Function Documentation

◆ xcb_xwm_add_display()

xcb_void_cookie_t xcb_xwm_add_display ( xcb_connection_t c,
int32_t  id,
int16_t  x,
int16_t  y,
uint16_t  width,
uint16_t  height,
uint16_t  rotation 
)
Parameters
cThe connection
Returns
A cookie

Delivers a request to the X server.

◆ xcb_xwm_add_display_checked()

xcb_void_cookie_t xcb_xwm_add_display_checked ( xcb_connection_t c,
int32_t  id,
int16_t  x,
int16_t  y,
uint16_t  width,
uint16_t  height,
uint16_t  rotation 
)
Parameters
cThe 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().

◆ xcb_xwm_get_client_pid()

xcb_xwm_get_client_pid_cookie_t xcb_xwm_get_client_pid ( xcb_connection_t c,
uint32_t  window 
)
Parameters
cThe connection
Returns
A cookie

Delivers a request to the X server.

◆ xcb_xwm_get_client_pid_reply()

xcb_xwm_get_client_pid_reply_t* xcb_xwm_get_client_pid_reply ( xcb_connection_t c,
xcb_xwm_get_client_pid_cookie_t  cookie,
xcb_generic_error_t **  e 
)

Return the reply

Parameters
cThe connection
cookieThe cookie
eThe 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_xwm_get_client_pid_unchecked(). is used. Otherwise, it stores the error if any.

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

◆ xcb_xwm_get_client_pid_unchecked()

xcb_xwm_get_client_pid_cookie_t xcb_xwm_get_client_pid_unchecked ( xcb_connection_t c,
uint32_t  window 
)
Parameters
cThe 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.

◆ xcb_xwm_query_version()

xcb_xwm_query_version_cookie_t xcb_xwm_query_version ( xcb_connection_t c,
uint32_t  major_version,
uint32_t  minor_version 
)
Parameters
cThe connection
Returns
A cookie

Delivers a request to the X server.

◆ xcb_xwm_query_version_reply()

xcb_xwm_query_version_reply_t* xcb_xwm_query_version_reply ( xcb_connection_t c,
xcb_xwm_query_version_cookie_t  cookie,
xcb_generic_error_t **  e 
)

Return the reply

Parameters
cThe connection
cookieThe cookie
eThe 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_xwm_query_version_unchecked(). is used. Otherwise, it stores the error if any.

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

◆ xcb_xwm_query_version_unchecked()

xcb_xwm_query_version_cookie_t xcb_xwm_query_version_unchecked ( xcb_connection_t c,
uint32_t  major_version,
uint32_t  minor_version 
)
Parameters
cThe 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.

◆ xcb_xwm_remove_display()

xcb_void_cookie_t xcb_xwm_remove_display ( xcb_connection_t c,
int32_t  id 
)
Parameters
cThe connection
Returns
A cookie

Delivers a request to the X server.

◆ xcb_xwm_remove_display_checked()

xcb_void_cookie_t xcb_xwm_remove_display_checked ( xcb_connection_t c,
int32_t  id 
)
Parameters
cThe 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().

◆ xcb_xwm_set_app_id()

xcb_void_cookie_t xcb_xwm_set_app_id ( xcb_connection_t c,
uint32_t  window,
uint32_t  fileSize,
int32_t  app_id_fd 
)
Parameters
cThe connection
Returns
A cookie

Delivers a request to the X server.

◆ xcb_xwm_set_app_id_checked()

xcb_void_cookie_t xcb_xwm_set_app_id_checked ( xcb_connection_t c,
uint32_t  window,
uint32_t  fileSize,
int32_t  app_id_fd 
)
Parameters
cThe 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().

◆ xcb_xwm_set_mode()

xcb_void_cookie_t xcb_xwm_set_mode ( xcb_connection_t c,
int32_t  id,
uint16_t  width,
uint16_t  height,
uint16_t  rotation,
uint16_t  refreshRate 
)
Parameters
cThe connection
Returns
A cookie

Delivers a request to the X server.

◆ xcb_xwm_set_mode_checked()

xcb_void_cookie_t xcb_xwm_set_mode_checked ( xcb_connection_t c,
int32_t  id,
uint16_t  width,
uint16_t  height,
uint16_t  rotation,
uint16_t  refreshRate 
)
Parameters
cThe 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().

◆ xcb_xwm_set_virtual_vblank_interval()

xcb_void_cookie_t xcb_xwm_set_virtual_vblank_interval ( xcb_connection_t c,
uint32_t  interval_ms 
)
Parameters
cThe connection
Returns
A cookie

Delivers a request to the X server.

◆ xcb_xwm_set_virtual_vblank_interval_checked()

xcb_void_cookie_t xcb_xwm_set_virtual_vblank_interval_checked ( xcb_connection_t c,
uint32_t  interval_ms 
)
Parameters
cThe 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().