xcb.xcb

Public Imports

xcb.xproto
public import xcb.xproto;

Members

Functions

xcb_connect
xcb_connection_t* xcb_connect(const char* displayname, int* screenp)

@brief Connects to the X server. @param displayname: The name of the display. @param screenp: A pointer to a preferred screen number. @return A newly allocated xcb_connection_t structure.

xcb_connect_to_display_with_auth_info
xcb_connection_t* xcb_connect_to_display_with_auth_info(const char* display, xcb_auth_info_t* auth, int* screen)

@brief Connects to the X server, using an authorization information. @param display: The name of the display. @param auth: The authorization information. @param screen: A pointer to a preferred screen number. @return A newly allocated xcb_connection_t structure.

xcb_connect_to_fd
xcb_connection_t* xcb_connect_to_fd(int fd, xcb_auth_info_t* auth_info)

@brief Connects to the X server. @param fd: The file descriptor. @param auth_info: Authentication data. @return A newly allocated xcb_connection_t structure.

xcb_connection_has_error
int xcb_connection_has_error(xcb_connection_t* c)

@brief Test whether the connection has shut down due to a fatal error. @param c: The connection. @return > 0 if the connection is in an error state; 0 otherwise.

xcb_discard_reply
void xcb_discard_reply(xcb_connection_t* c, uint sequence)

@brief Discards the reply for a request. @param c: The connection to the X server. @param sequence: The request sequence number from a cookie.

xcb_discard_reply64
void xcb_discard_reply64(xcb_connection_t* c, uint sequence)

@brief Discards the reply for a request, given by a 64bit sequence number @param c: The connection to the X server. @param sequence: 64-bit sequence number as returned by xcb_send_request64().

xcb_disconnect
void xcb_disconnect(xcb_connection_t* c)

@brief Closes the connection. @param c: The connection.

xcb_flush
int xcb_flush(xcb_connection_t* c)

@brief Forces any buffered output to be written to the server. @param c: The connection to the X server. @return > @c 0 on success, <= @c 0 otherwise.

xcb_generate_id
uint xcb_generate_id(xcb_connection_t* c)

@brief Allocates an XID for a new object. @param c: The connection. @return A newly allocated XID.

xcb_get_extension_data
xcb_query_extension_reply_t* xcb_get_extension_data(xcb_connection_t* c, xcb_extension_t* ext)

@brief Caches reply information from QueryExtension requests. @param c: The connection. @param ext: The extension data. @return A pointer to the xcb_query_extension_reply_t for the extension.

xcb_get_file_descriptor
int xcb_get_file_descriptor(xcb_connection_t* c)

@brief Access the file descriptor of the connection. @param c: The connection. @return The file descriptor.

xcb_get_maximum_request_length
uint xcb_get_maximum_request_length(xcb_connection_t* c)

@brief Returns the maximum request length that this server accepts. @param c: The connection to the X server. @return The maximum request length field.

xcb_get_setup
xcb_setup_t* xcb_get_setup(xcb_connection_t* c)

@brief Access the data returned by the server. @param c: The connection. @return A pointer to an xcb_setup_t structure.

xcb_parse_display
int xcb_parse_display(const char* name, char** host, int* display, int* screen)

@brief Parses a display string name in the form documented by X(7x). @param name: The name of the display. @param host: A pointer to a malloc'd copy of the hostname. @param display: A pointer to the display number. @param screen: A pointer to the screen number. @return 0 on failure, non 0 otherwise.

xcb_poll_for_event
xcb_generic_event_t* xcb_poll_for_event(xcb_connection_t* c)

@brief Returns the next event or error from the server. @param c: The connection to the X server. @return The next event from the server.

xcb_poll_for_queued_event
xcb_generic_event_t* xcb_poll_for_queued_event(xcb_connection_t* c)

@brief Returns the next event without reading from the connection. @param c: The connection to the X server. @return The next already queued event from the server.

xcb_poll_for_special_event
xcb_generic_event_t* xcb_poll_for_special_event(xcb_connection_t* c, xcb_special_event_t* se)

@brief Returns the next event from a special queue

xcb_prefetch_extension_data
void xcb_prefetch_extension_data(xcb_connection_t* c, xcb_extension_t* ext)

@brief Prefetch of extension data into the extension cache @param c: The connection. @param ext: The extension data.

xcb_prefetch_maximum_request_length
void xcb_prefetch_maximum_request_length(xcb_connection_t* c)

@brief Prefetch the maximum request length without blocking. @param c: The connection to the X server.

xcb_register_for_special_xge
xcb_special_event_t* xcb_register_for_special_xge(xcb_connection_t* c, xcb_extension_t* ext, uint eid, uint* stamp)

@brief Listen for a special event

xcb_request_check
xcb_generic_error_t* xcb_request_check(xcb_connection_t* c, xcb_void_cookie_t cookie)

@brief Return the error for a request, or NULL if none can ever arrive. @param c: The connection to the X server. @param cookie: The request cookie. @return The error for the request, or NULL if none can ever arrive.

xcb_unregister_for_special_event
void xcb_unregister_for_special_event(xcb_connection_t* c, xcb_special_event_t* se)

@brief Stop listening for a special event

xcb_wait_for_event
xcb_generic_event_t* xcb_wait_for_event(xcb_connection_t* c)

@brief Returns the next event or error from the server. @param c: The connection to the X server. @return The next event from the server.

xcb_wait_for_special_event
xcb_generic_event_t* xcb_wait_for_special_event(xcb_connection_t* c, xcb_special_event_t* se)

@brief Returns the next event from a special queue, blocking until one arrives

Manifest constants

XCB_CONN_CLOSED_EXT_NOTSUPPORTED
enum XCB_CONN_CLOSED_EXT_NOTSUPPORTED;

xcb connection shutdown because of extension not supported

XCB_CONN_CLOSED_FDPASSING_FAILED
enum XCB_CONN_CLOSED_FDPASSING_FAILED;

Connection closed because some FD passing operation failed

XCB_CONN_CLOSED_INVALID_SCREEN
enum XCB_CONN_CLOSED_INVALID_SCREEN;

Connection closed because the server does not have a screen matching the display.

XCB_CONN_CLOSED_MEM_INSUFFICIENT
enum XCB_CONN_CLOSED_MEM_INSUFFICIENT;

malloc(), calloc() and realloc() error upon failure, for eg ENOMEM

XCB_CONN_CLOSED_PARSE_ERR
enum XCB_CONN_CLOSED_PARSE_ERR;

Connection closed, error during parsing display string.

XCB_CONN_CLOSED_REQ_LEN_EXCEED
enum XCB_CONN_CLOSED_REQ_LEN_EXCEED;

Connection closed, exceeding request length that server accepts.

XCB_CONN_ERROR
enum XCB_CONN_ERROR;

xcb connection errors because of socket, pipe and other stream errors.

XCB_COPY_FROM_PARENT
enum XCB_COPY_FROM_PARENT;

XCB_COPY_FROM_PARENT can be used for many xcb_create_window parameters

XCB_CURRENT_TIME
enum XCB_CURRENT_TIME;

XCB_CURRENT_TIME can be used in most requests that take an xcb_timestamp_t

XCB_NONE
enum XCB_NONE;

XCB_NONE is the universal null resource or null atom parameter value for many core X requests

XCB_NO_SYMBOL
enum XCB_NO_SYMBOL;

XCB_NO_SYMBOL fills in unused entries in xcb_keysym_t tables

X_PROTOCOL
enum X_PROTOCOL;

Current protocol version

X_PROTOCOL_REVISION
enum X_PROTOCOL_REVISION;

Current minor version

X_TCP_PORT
enum X_TCP_PORT;

X_TCP_PORT + display number = server port for TCP transport

Structs

xcb_auth_info_t
struct xcb_auth_info_t

@brief Container for authorization information.

xcb_connection_t
struct xcb_connection_t

@brief XCB Connection structure.

xcb_extension_t
struct xcb_extension_t

@typedef typedef struct xcb_extension_t xcb_extension_t

xcb_ge_event_t
struct xcb_ge_event_t

@brief GE event

xcb_generic_error_t
struct xcb_generic_error_t

@brief Generic error.

xcb_generic_event_t
struct xcb_generic_event_t

@brief Generic event.

xcb_generic_iterator_t
struct xcb_generic_iterator_t

@brief Generic iterator.

xcb_generic_reply_t
struct xcb_generic_reply_t

@brief Generic reply.

xcb_void_cookie_t
struct xcb_void_cookie_t

@brief Generic cookie.

Meta