<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>XCB: xcb.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.3 --> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">XCB <span id="projectnumber">1.7</span></div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#nested-classes">Data Structures</a> | <a href="#define-members">Defines</a> | <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <h1>xcb.h File Reference</h1> </div> </div> <div class="contents"> <div class="textblock"><code>#include <sys/types.h></code><br/> <code>#include <stdint.h></code><br/> <code>#include <sys/uio.h></code><br/> <code>#include <pthread.h></code><br/> <code>#include "xproto.h"</code><br/> </div><div class="textblock"><div class="dynheader"> Include dependency graph for xcb.h:</div> <div class="dyncontent"> <div class="center"><img src="xcb_8h__incl.png" border="0" usemap="#xcb_8h" alt=""/></div> <map name="xcb_8h" id="xcb_8h"> <area shape="rect" id="node11" href="xproto_8h_source.html" title="xproto.h" alt="" coords="557,80,659,107"/></map> </div> </div><div class="textblock"><div class="dynheader"> This graph shows which files directly or indirectly include this file:</div> <div class="dyncontent"> <div class="center"><img src="xcb_8h__dep__incl.png" border="0" usemap="#xcb_8hdep" alt=""/></div> <map name="xcb_8hdep" id="xcb_8hdep"> <area shape="rect" id="node3" href="xcbext_8h_source.html" title="xcbext.h" alt="" coords="5,80,107,107"/><area shape="rect" id="node5" href="xproto_8h_source.html" title="xproto.h" alt="" coords="1163,80,1264,107"/><area shape="rect" id="node8" href="composite_8h_source.html" title="composite.h" alt="" coords="396,304,527,331"/><area shape="rect" id="node10" href="render_8h_source.html" title="render.h" alt="" coords="549,155,651,181"/><area shape="rect" id="node13" href="xfixes_8h_source.html" title="xfixes.h" alt="" coords="549,229,651,256"/><area shape="rect" id="node16" href="damage_8h_source.html" title="damage.h" alt="" coords="637,304,739,331"/><area shape="rect" id="node19" href="randr_8h_source.html" title="randr.h" alt="" coords="725,229,816,256"/><area shape="rect" id="node21" href="shape_8h_source.html" title="shape.h" alt="" coords="435,155,525,181"/><area shape="rect" id="node28" href="dri2_8h_source.html" title="dri2.h" alt="" coords="232,155,315,181"/><area shape="rect" id="node30" href="glx_8h_source.html" title="glx.h" alt="" coords="339,155,411,181"/><area shape="rect" id="node33" href="res_8h_source.html" title="res.h" alt="" coords="725,155,797,181"/><area shape="rect" id="node35" href="screensaver_8h_source.html" title="screensaver.h" alt="" coords="821,155,973,181"/><area shape="rect" id="node37" href="shm_8h_source.html" title="shm.h" alt="" coords="2168,155,2240,181"/><area shape="rect" id="node39" href="xv_8h_source.html" title="xv.h" alt="" coords="2117,229,2179,256"/><area shape="rect" id="node41" href="xvmc_8h_source.html" title="xvmc.h" alt="" coords="2140,304,2223,331"/><area shape="rect" id="node44" href="sync_8h_source.html" title="sync.h" alt="" coords="1301,155,1384,181"/><area shape="rect" id="node46" href="xinerama_8h_source.html" title="xinerama.h" alt="" coords="1408,155,1531,181"/><area shape="rect" id="node48" href="xinput_8h_source.html" title="xinput.h" alt="" coords="1555,155,1656,181"/><area shape="rect" id="node50" href="xprint_8h_source.html" title="xprint.h" alt="" coords="1680,155,1781,181"/><area shape="rect" id="node52" href="xselinux_8h_source.html" title="xselinux.h" alt="" coords="1805,155,1928,181"/><area shape="rect" id="node54" href="xtest_8h_source.html" title="xtest.h" alt="" coords="1952,155,2043,181"/><area shape="rect" id="node58" href="bigreq_8h_source.html" title="bigreq.h" alt="" coords="2269,80,2371,107"/><area shape="rect" id="node67" href="dpms_8h_source.html" title="dpms.h" alt="" coords="2395,80,2477,107"/><area shape="rect" id="node72" href="record_8h_source.html" title="record.h" alt="" coords="2501,80,2603,107"/><area shape="rect" id="node78" href="xc__misc_8h_source.html" title="xc_misc.h" alt="" coords="2627,80,2739,107"/><area shape="rect" id="node80" href="xevie_8h_source.html" title="xevie.h" alt="" coords="2763,80,2853,107"/><area shape="rect" id="node82" href="xf86dri_8h_source.html" title="xf86dri.h" alt="" coords="2877,80,2989,107"/><area shape="rect" id="node60" href="xcbint_8h_source.html" title="xcbint.h" alt="" coords="2315,155,2416,181"/></map> </div> </div> <p><a href="xcb_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="nested-classes"></a> Data Structures</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxcb__generic__iterator__t.html">xcb_generic_iterator_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Generic iterator. <a href="structxcb__generic__iterator__t.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxcb__generic__reply__t.html">xcb_generic_reply_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Generic reply. <a href="structxcb__generic__reply__t.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxcb__generic__event__t.html">xcb_generic_event_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Generic event. <a href="structxcb__generic__event__t.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxcb__ge__event__t.html">xcb_ge_event_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">GE event. <a href="structxcb__ge__event__t.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxcb__generic__error__t.html">xcb_generic_error_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Generic error. <a href="structxcb__generic__error__t.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxcb__void__cookie__t.html">xcb_void_cookie_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Generic cookie. <a href="structxcb__void__cookie__t.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxcb__auth__info__t.html">xcb_auth_info_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Container for authorization information. <a href="structxcb__auth__info__t.html#_details">More...</a><br/></td></tr> <tr><td colspan="2"><h2><a name="define-members"></a> Defines</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga33a326c569db79d44ac7f50449cd41a9">X_PROTOCOL</a>   11</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gaec218574c2dba2befb7b797b55d5b146">X_PROTOCOL_REVISION</a>   0</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gae3ab23b2215dc45af366b61a84b40272">X_TCP_PORT</a>   6000</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7a30f2a3be1abba1232db075a0f0876f"></a><!-- doxytag: member="xcb.h::XCB_TYPE_PAD" ref="ga7a30f2a3be1abba1232db075a0f0876f" args="(T, I)" --> #define </td><td class="memItemRight" valign="bottom"><b>XCB_TYPE_PAD</b>(T, I)   (-(I) & (sizeof(T) > 4 ? 3 : sizeof(T) - 1))</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gafa5402f36a6f6b5def0e98c4a452dc82">XCB_NONE</a>   0L</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gacfad5acd9f27e048614dce1f7ea69ed8">XCB_COPY_FROM_PARENT</a>   0L</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga3a6ff159310850f5e28b018192a4a0d0">XCB_CURRENT_TIME</a>   0L</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga47e7b30cb867e921290ab333b88184dd">XCB_NO_SYMBOL</a>   0L</td></tr> <tr><td colspan="2"><h2><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga8af532123ce5fb1c75ded03a0d77691f">xcb_connection_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">XCB Connection structure. <a href="group__XCB__Core__API.html#ga8af532123ce5fb1c75ded03a0d77691f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structxcb__auth__info__t.html">xcb_auth_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga5c434ae83bd5822deb8e20ea517071b6">xcb_auth_info_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Container for authorization information. <a href="group__XCB__Core__API.html#ga5c434ae83bd5822deb8e20ea517071b6"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structxcb__extension__t.html">xcb_extension_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga8615b6e0d78ed5de111d9202530cebe9">xcb_extension_t</a></td></tr> <tr><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga9361ead09eb756ba9cc8953c4569a789">xcb_flush</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Forces any buffered output to be written to the server. <a href="group__XCB__Core__API.html#ga9361ead09eb756ba9cc8953c4569a789"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gaac2771a6f8f77b574bcebcec3a7de977">xcb_get_maximum_request_length</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the maximum request length that this server accepts. <a href="group__XCB__Core__API.html#gaac2771a6f8f77b574bcebcec3a7de977"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga365edf27111a8dd4e1d2831f652315e7">xcb_prefetch_maximum_request_length</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Prefetch the maximum request length without blocking. <a href="group__XCB__Core__API.html#ga365edf27111a8dd4e1d2831f652315e7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structxcb__generic__event__t.html">xcb_generic_event_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga1152db5668f718d1b3daf9b40712b0dd">xcb_wait_for_event</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the next event or error from the server. <a href="group__XCB__Core__API.html#ga1152db5668f718d1b3daf9b40712b0dd"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structxcb__generic__event__t.html">xcb_generic_event_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga3289f98c49afa3aa56f84f741557a434">xcb_poll_for_event</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the next event or error from the server. <a href="group__XCB__Core__API.html#ga3289f98c49afa3aa56f84f741557a434"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structxcb__generic__error__t.html">xcb_generic_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga3ee7f1ad9cf0a9f1716d5c22405598fc">xcb_request_check</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c, <a class="el" href="structxcb__void__cookie__t.html">xcb_void_cookie_t</a> cookie)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the error for a request, or NULL if none can ever arrive. <a href="group__XCB__Core__API.html#ga3ee7f1ad9cf0a9f1716d5c22405598fc"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gabb6bc06a4ee73b3b820847a02bd8bfcb">xcb_discard_reply</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c, unsigned int sequence)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Discards the reply for a request. <a href="group__XCB__Core__API.html#gabb6bc06a4ee73b3b820847a02bd8bfcb"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structxcb__query__extension__reply__t.html">xcb_query_extension_reply_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga3cbee434e4859a00d685bbdf1e299b9e">xcb_get_extension_data</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c, <a class="el" href="structxcb__extension__t.html">xcb_extension_t</a> *ext)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Caches reply information from QueryExtension requests. <a href="group__XCB__Core__API.html#ga3cbee434e4859a00d685bbdf1e299b9e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gaa3c0a602c213180792c2668f8056a324">xcb_prefetch_extension_data</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c, <a class="el" href="structxcb__extension__t.html">xcb_extension_t</a> *ext)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Prefetch of extension data into the extension cache. <a href="group__XCB__Core__API.html#gaa3c0a602c213180792c2668f8056a324"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structxcb__setup__t.html">xcb_setup_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gafc379a27800bf735818a0760bd036321">xcb_get_setup</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Access the data returned by the server. <a href="group__XCB__Core__API.html#gafc379a27800bf735818a0760bd036321"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga537e3cea89389382533957444eaa13fd">xcb_get_file_descriptor</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Access the file descriptor of the connection. <a href="group__XCB__Core__API.html#ga537e3cea89389382533957444eaa13fd"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga70a6bade94bd2824db552abcf5fbdbe3">xcb_connection_has_error</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Test whether the connection has shut down due to a fatal error. <a href="group__XCB__Core__API.html#ga70a6bade94bd2824db552abcf5fbdbe3"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga6a5bf0156ada8c8863461073adefc7e2">xcb_connect_to_fd</a> (int fd, <a class="el" href="structxcb__auth__info__t.html">xcb_auth_info_t</a> *auth_info)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Connects to the X server. <a href="group__XCB__Core__API.html#ga6a5bf0156ada8c8863461073adefc7e2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gad562fe46469d419a81d5d9b20a659eaa">xcb_disconnect</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the connection. <a href="group__XCB__Core__API.html#gad562fe46469d419a81d5d9b20a659eaa"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gacdcc135342419d73b45e4f5499f26b20">xcb_parse_display</a> (const char *name, char **host, int *display, int *screen)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Parses a display string name in the form documented by X(7x). <a href="group__XCB__Core__API.html#gacdcc135342419d73b45e4f5499f26b20"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga094470586356d1764e69c9a1882966c3">xcb_connect</a> (const char *displayname, int *screenp)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Connects to the X server. <a href="group__XCB__Core__API.html#ga094470586356d1764e69c9a1882966c3"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#gaba02ef0d79d42c863842ae7eb8dd67a2">xcb_connect_to_display_with_auth_info</a> (const char *display, <a class="el" href="structxcb__auth__info__t.html">xcb_auth_info_t</a> *auth, int *screen)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Connects to the X server, using an authorization information. <a href="group__XCB__Core__API.html#gaba02ef0d79d42c863842ae7eb8dd67a2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XCB__Core__API.html#ga3208afc306e3c564435a6ecbaddf80d1">xcb_generate_id</a> (<a class="el" href="structxcb__connection__t.html">xcb_connection_t</a> *c)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Allocates an XID for a new object. <a href="group__XCB__Core__API.html#ga3208afc306e3c564435a6ecbaddf80d1"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"></div></div> <hr class="footer"/><address class="footer"><small>Generated on Fri Apr 29 2011 15:45:46 for XCB by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address> </body> </html>