Data Structures | |
struct | xcb_generic_iterator_t |
Generic iterator. More... | |
struct | xcb_generic_reply_t |
Generic reply. More... | |
struct | xcb_generic_event_t |
Generic event. More... | |
struct | xcb_generic_error_t |
Generic error. More... | |
struct | xcb_void_cookie_t |
Generic cookie. More... | |
struct | xcb_auth_info_t |
Container for authorization information. More... | |
Defines | |
#define | X_PROTOCOL 11 |
#define | X_PROTOCOL_REVISION 0 |
#define | X_TCP_PORT 6000 |
#define | XCB_TYPE_PAD(T, I) (-(I) & (sizeof(T) > 4 ? 3 : sizeof(T) - 1)) |
#define | XCB_NONE 0L |
#define | XCB_COPY_FROM_PARENT 0L |
#define | XCB_CURRENT_TIME 0L |
#define | XCB_NO_SYMBOL 0L |
Typedefs | |
typedef struct xcb_connection_t | xcb_connection_t |
XCB Connection structure. | |
typedef struct xcb_extension_t | xcb_extension_t |
Functions | |
int | xcb_flush (xcb_connection_t *c) |
Forces any buffered output to be written to the server. | |
uint32_t | xcb_get_maximum_request_length (xcb_connection_t *c) |
Returns the maximum request length that this server accepts. | |
void | xcb_prefetch_maximum_request_length (xcb_connection_t *c) |
Prefetch the maximum request length without blocking. | |
xcb_generic_event_t * | xcb_wait_for_event (xcb_connection_t *c) |
Returns the next event or error from the server. | |
xcb_generic_event_t * | xcb_poll_for_event (xcb_connection_t *c) |
Returns the next event or error from the server. | |
xcb_generic_error_t * | xcb_request_check (xcb_connection_t *c, xcb_void_cookie_t cookie) |
Return the error for a request, or NULL if none can ever arrive. | |
const xcb_query_extension_reply_t * | xcb_get_extension_data (xcb_connection_t *c, xcb_extension_t *ext) |
Caches reply information from QueryExtension requests. | |
void | xcb_prefetch_extension_data (xcb_connection_t *c, xcb_extension_t *ext) |
Prefetch of extension data into the extension cache. | |
const xcb_setup_t * | xcb_get_setup (xcb_connection_t *c) |
Access the data returned by the server. | |
int | xcb_get_file_descriptor (xcb_connection_t *c) |
Access the file descriptor of the connection. | |
int | xcb_connection_has_error (xcb_connection_t *c) |
Test whether the connection has shut down due to a fatal error. | |
xcb_connection_t * | xcb_connect_to_fd (int fd, xcb_auth_info_t *auth_info) |
Connects to the X server. | |
void | xcb_disconnect (xcb_connection_t *c) |
Closes the connection. | |
int | xcb_parse_display (const char *name, char **host, int *display, int *screen) |
Parses a display string name in the form documented by X(7x). | |
xcb_connection_t * | xcb_connect (const char *displayname, int *screenp) |
Connects to the X server. | |
xcb_connection_t * | xcb_connect_to_display_with_auth_info (const char *display, xcb_auth_info_t *auth, int *screen) |
Connects to the X server, using an authorization information. | |
uint32_t | xcb_generate_id (xcb_connection_t *c) |
Allocates an XID for a new object. |
#define X_PROTOCOL 11 |
Current protocol version
#define X_PROTOCOL_REVISION 0 |
Current minor version
#define X_TCP_PORT 6000 |
X_TCP_PORT + display number = server port for TCP transport
#define XCB_COPY_FROM_PARENT 0L |
XCB_COPY_FROM_PARENT can be used for many xcb_create_window parameters
#define XCB_CURRENT_TIME 0L |
XCB_CURRENT_TIME can be used in most requests that take an xcb_timestamp_t
#define XCB_NO_SYMBOL 0L |
XCB_NO_SYMBOL fills in unused entries in xcb_keysym_t tables
#define XCB_NONE 0L |
XCB_NONE is the universal null resource or null atom parameter value for many core X requests
typedef struct xcb_connection_t xcb_connection_t |
XCB Connection structure.
A structure that contain all data that XCB needs to communicate with an X server. Opaque structure containing all data that XCB needs to communicate with an X server.
typedef struct xcb_extension_t xcb_extension_t |
Opaque structure used as key for xcb_get_extension_data_t.
xcb_connection_t* xcb_connect | ( | const char * | displayname, | |
int * | screenp | |||
) |
Connects to the X server.
displayname,: | The name of the display. | |
screenp,: | A pointer to a preferred screen number. |
displayname
. If displayname
is NULL
, uses the value of the DISPLAY environment variable. If a particular screen on that server is preferred, the int pointed to by screenp
(if not NULL
) will be set to that screen; otherwise the screen will be set to 0.
References xcb_auth_info_t::data, xcb_auth_info_t::name, and xcb_connect_to_fd().
xcb_connection_t* xcb_connect_to_display_with_auth_info | ( | const char * | display, | |
xcb_auth_info_t * | auth, | |||
int * | screen | |||
) |
Connects to the X server, using an authorization information.
display,: | The name of the display. | |
auth,: | The authorization information. | |
screen,: | A pointer to a preferred screen number. |
displayname
, using the authorization auth
. If a particular screen on that server is preferred, the int pointed to by screenp
(if not NULL
) will be set to that screen; otherwise screenp
will be set to 0.
References xcb_connect_to_fd().
xcb_connection_t* xcb_connect_to_fd | ( | int | fd, | |
xcb_auth_info_t * | auth_info | |||
) |
Connects to the X server.
fd,: | The file descriptor. | |
auth_info,: | Authentication data. |
fd
and the xcb_auth_info_t auth_info
. The file descriptor fd
is bidirectionally connected to an X server. If the connection should be unauthenticated, auth_info
must be NULL
.
References xcb_disconnect().
Referenced by xcb_connect(), and xcb_connect_to_display_with_auth_info().
int xcb_connection_has_error | ( | xcb_connection_t * | c | ) |
Test whether the connection has shut down due to a fatal error.
c,: | The connection. |
void xcb_disconnect | ( | xcb_connection_t * | c | ) |
Closes the connection.
c,: | The connection. |
c
.
Referenced by xcb_connect_to_fd().
int xcb_flush | ( | xcb_connection_t * | c | ) |
Forces any buffered output to be written to the server.
c,: | The connection to the X server. |
0
on success, <= 0
otherwise.uint32_t xcb_generate_id | ( | xcb_connection_t * | c | ) |
Allocates an XID for a new object.
c,: | The connection. |
References xcb_xc_misc_get_xid_range_reply_t::count, xcb_xc_misc_get_xid_range_reply_t::start_id, xcb_xc_misc_get_xid_range(), and xcb_xc_misc_get_xid_range_reply().
const xcb_query_extension_reply_t* xcb_get_extension_data | ( | xcb_connection_t * | c, | |
xcb_extension_t * | ext | |||
) |
Caches reply information from QueryExtension requests.
c,: | The connection. | |
ext,: | The extension data. |
The result must not be freed. This storage is managed by the cache itself.
References xcb_query_extension_reply().
Referenced by xcb_prefetch_maximum_request_length().
int xcb_get_file_descriptor | ( | xcb_connection_t * | c | ) |
Access the file descriptor of the connection.
c,: | The connection. |
c
.
uint32_t xcb_get_maximum_request_length | ( | xcb_connection_t * | c | ) |
Returns the maximum request length that this server accepts.
c,: | The connection to the X server. |
Note that this length is measured in four-byte units, making the theoretical maximum lengths roughly 256kB without BIG-REQUESTS and 16GB with.
References xcb_big_requests_enable_reply_t::maximum_request_length, xcb_big_requests_enable_reply(), and xcb_prefetch_maximum_request_length().
const xcb_setup_t* xcb_get_setup | ( | xcb_connection_t * | c | ) |
Access the data returned by the server.
c,: | The connection. |
See the X protocol specification for more details.
The result must not be freed.
int xcb_parse_display | ( | const char * | name, | |
char ** | host, | |||
int * | display, | |||
int * | screen | |||
) |
Parses a display string name in the form documented by X(7x).
name,: | The name of the display. | |
host,: | A pointer to a malloc'd copy of the hostname. | |
display,: | A pointer to the display number. | |
screen,: | A pointer to the screen number. |
display_name
in the form documented by X(7x). Has no side effects on failure. If displayname
is NULL
or empty, it uses the environment variable DISPLAY. hostp
is a pointer to a newly allocated string that contain the host name. displayp
is set to the display number and screenp
to the preferred screen number. screenp
can be NULL
. If displayname
does not contain a screen number, it is set to 0
.
xcb_generic_event_t* xcb_poll_for_event | ( | xcb_connection_t * | c | ) |
Returns the next event or error from the server.
c,: | The connection to the X server. error status of the operation. |
NULL
otherwise. If no event is available, that might be because an I/O error like connection close occurred while attempting to read the next event, in which case the connection is shut down when this function returns.
void xcb_prefetch_extension_data | ( | xcb_connection_t * | c, | |
xcb_extension_t * | ext | |||
) |
Prefetch of extension data into the extension cache.
c,: | The connection. | |
ext,: | The extension data. |
void xcb_prefetch_maximum_request_length | ( | xcb_connection_t * | c | ) |
Prefetch the maximum request length without blocking.
c,: | The connection to the X server. |
Invoking this function may cause a call to xcb_big_requests_enable, but will not block waiting for the reply. xcb_get_maximum_request_length will return the prefetched data after possibly blocking while the reply is retrieved.
Note that in order for this function to be fully non-blocking, the application must previously have called xcb_prefetch_extension_data(c, &xcb_big_requests_id) and the reply must have already arrived.
References xcb_query_extension_reply_t::present, xcb_big_requests_enable(), and xcb_get_extension_data().
Referenced by xcb_get_maximum_request_length().
xcb_generic_error_t* xcb_request_check | ( | xcb_connection_t * | c, | |
xcb_void_cookie_t | cookie | |||
) |
Return the error for a request, or NULL if none can ever arrive.
c,: | The connection to the X server. | |
cookie,: | The request cookie. |
Note that this function will perform a sync if needed to ensure that the sequence number will advance beyond that provided in cookie; this is a convenience to avoid races in determining whether the sync is needed.
References xcb_void_cookie_t::sequence, xcb_get_input_focus(), and xcb_get_input_focus_reply().
xcb_generic_event_t* xcb_wait_for_event | ( | xcb_connection_t * | c | ) |
Returns the next event or error from the server.
c,: | The connection to the X server. |