xorg-server-1.4/hw/dmx/doc/html/dmxbackend_8h.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html>
   3   <head>
   4     <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   5     <title>File Index</title>
   6     <link href="doxygen.css" rel="stylesheet" type="text/css">
   7   </head>
   8   <body>
   9 <!-- Generated by Doxygen 1.3.4 -->
  10 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a></div>
  11 <h1>dmxbackend.h File Reference</h1>
  12 <p>
  13 <a href="dmxbackend_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
  14 <tr><td></td></tr>
  15 <tr><td colspan=2><br><h2>Functions</h2></td></tr>
  16 <tr><td class="memItemLeft" nowrap align=right valign=top>pointer&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8h.html#a0">dmxBackendCreatePrivate</a> (DeviceIntPtr pDevice)</td></tr>
  17
  18 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8h.html#a1">dmxBackendDestroyPrivate</a> (pointer private)</td></tr>
  19
  20 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8h.html#a2">dmxBackendInit</a> (DevicePtr pDev)</td></tr>
  21
  22 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8h.html#a3">dmxBackendLateReInit</a> (DevicePtr pDev)</td></tr>
  23
  24 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8h.html#a4">dmxBackendMouGetInfo</a> (DevicePtr pDev, <a class="el" href="struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr</a> info)</td></tr>
  25
  26 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8h.html#a5">dmxBackendKbdGetInfo</a> (DevicePtr pDev, <a class="el" href="struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr</a> info)</td></tr>
  27
  28 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8h.html#a6">dmxBackendCollectEvents</a> (DevicePtr pDev, dmxMotionProcPtr motion, dmxEnqueueProcPtr enqueue, dmxCheckSpecialProcPtr checkspecial, DMXBlockType block)</td></tr>
  29
  30 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8h.html#a7">dmxBackendProcessInput</a> (pointer private)</td></tr>
  31
  32 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8h.html#a8">dmxBackendFunctions</a> (pointer private, DMXFunctionType function)</td></tr>
  33
  34 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8h.html#a9">dmxBackendUpdatePosition</a> (pointer private, int x, int y)</td></tr>
  35
  36 </table>
  37 <hr><a name="_details"></a><h2>Detailed Description</h2>
  38 Interface to backend input device support. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="dmxbackend_8c.html">dmxbackend.c</a> <p>
  39 <a class="el" href="dmxcommon_8c.html">dmxcommon.c</a></dd></dl>
  40 <hr><h2>Function Documentation</h2>
  41 <a class="anchor" name="a6" doxytag="dmxbackend.h::dmxBackendCollectEvents" ></a><p>
  42 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  43   <tr>
  44     <td class="mdRow">
  45       <table cellpadding="0" cellspacing="0" border="0">
  46         <tr>
  47           <td class="md" nowrap valign="top"> void dmxBackendCollectEvents </td>
  48           <td class="md" valign="top">(&nbsp;</td>
  49           <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
  50           <td class="mdname" nowrap> <em>pDev</em>, </td>
  51         </tr>
  52         <tr>
  53           <td></td>
  54           <td></td>
  55           <td class="md" nowrap>dmxMotionProcPtr&nbsp;</td>
  56           <td class="mdname" nowrap> <em>motion</em>, </td>
  57         </tr>
  58         <tr>
  59           <td></td>
  60           <td></td>
  61           <td class="md" nowrap>dmxEnqueueProcPtr&nbsp;</td>
  62           <td class="mdname" nowrap> <em>enqueue</em>, </td>
  63         </tr>
  64         <tr>
  65           <td></td>
  66           <td></td>
  67           <td class="md" nowrap>dmxCheckSpecialProcPtr&nbsp;</td>
  68           <td class="mdname" nowrap> <em>checkspecial</em>, </td>
  69         </tr>
  70         <tr>
  71           <td></td>
  72           <td></td>
  73           <td class="md" nowrap>DMXBlockType&nbsp;</td>
  74           <td class="mdname" nowrap> <em>block</em></td>
  75         </tr>
  76         <tr>
  77           <td></td>
  78           <td class="md">)&nbsp;</td>
  79           <td class="md" colspan="2"></td>
  80         </tr>
  81
  82       </table>
  83     </td>
  84   </tr>
  85 </table>
  86 <table cellspacing=5 cellpadding=0 border=0>
  87   <tr>
  88     <td>
  89       &nbsp;
  90     </td>
  91     <td>
  92
  93 <p>
  94 Get events from the X queue on the backend servers and put the events into the DMX event queue.     </td>
  95   </tr>
  96 </table>
  97 <a class="anchor" name="a0" doxytag="dmxbackend.h::dmxBackendCreatePrivate" ></a><p>
  98 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  99   <tr>
 100     <td class="mdRow">
 101       <table cellpadding="0" cellspacing="0" border="0">
 102         <tr>
 103           <td class="md" nowrap valign="top"> pointer dmxBackendCreatePrivate </td>
 104           <td class="md" valign="top">(&nbsp;</td>
 105           <td class="md" nowrap valign="top">DeviceIntPtr&nbsp;</td>
 106           <td class="mdname1" valign="top" nowrap> <em>pDevice</em>          </td>
 107           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 108           <td class="md" nowrap></td>
 109         </tr>
 110
 111       </table>
 112     </td>
 113   </tr>
 114 </table>
 115 <table cellspacing=5 cellpadding=0 border=0>
 116   <tr>
 117     <td>
 118       &nbsp;
 119     </td>
 120     <td>
 121
 122 <p>
 123 Create and return a private data structure.     </td>
 124   </tr>
 125 </table>
 126 <a class="anchor" name="a1" doxytag="dmxbackend.h::dmxBackendDestroyPrivate" ></a><p>
 127 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 128   <tr>
 129     <td class="mdRow">
 130       <table cellpadding="0" cellspacing="0" border="0">
 131         <tr>
 132           <td class="md" nowrap valign="top"> void dmxBackendDestroyPrivate </td>
 133           <td class="md" valign="top">(&nbsp;</td>
 134           <td class="md" nowrap valign="top">pointer&nbsp;</td>
 135           <td class="mdname1" valign="top" nowrap> <em>private</em>          </td>
 136           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 137           <td class="md" nowrap></td>
 138         </tr>
 139
 140       </table>
 141     </td>
 142   </tr>
 143 </table>
 144 <table cellspacing=5 cellpadding=0 border=0>
 145   <tr>
 146     <td>
 147       &nbsp;
 148     </td>
 149     <td>
 150
 151 <p>
 152 Destroy the private data structure. No checking is performed to verify that the structure was actually created by <a class="el" href="dmxbackend_8h.html#a0">dmxBackendCreatePrivate</a>.     </td>
 153   </tr>
 154 </table>
 155 <a class="anchor" name="a8" doxytag="dmxbackend.h::dmxBackendFunctions" ></a><p>
 156 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 157   <tr>
 158     <td class="mdRow">
 159       <table cellpadding="0" cellspacing="0" border="0">
 160         <tr>
 161           <td class="md" nowrap valign="top"> int dmxBackendFunctions </td>
 162           <td class="md" valign="top">(&nbsp;</td>
 163           <td class="md" nowrap valign="top">pointer&nbsp;</td>
 164           <td class="mdname" nowrap> <em>private</em>, </td>
 165         </tr>
 166         <tr>
 167           <td></td>
 168           <td></td>
 169           <td class="md" nowrap>DMXFunctionType&nbsp;</td>
 170           <td class="mdname" nowrap> <em>function</em></td>
 171         </tr>
 172         <tr>
 173           <td></td>
 174           <td class="md">)&nbsp;</td>
 175           <td class="md" colspan="2"></td>
 176         </tr>
 177
 178       </table>
 179     </td>
 180   </tr>
 181 </table>
 182 <table cellspacing=5 cellpadding=0 border=0>
 183   <tr>
 184     <td>
 185       &nbsp;
 186     </td>
 187     <td>
 188
 189 <p>
 190 Process #DMXFunctionType functions. The only function handled here is to acknowledge a pending server shutdown.     </td>
 191   </tr>
 192 </table>
 193 <a class="anchor" name="a2" doxytag="dmxbackend.h::dmxBackendInit" ></a><p>
 194 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 195   <tr>
 196     <td class="mdRow">
 197       <table cellpadding="0" cellspacing="0" border="0">
 198         <tr>
 199           <td class="md" nowrap valign="top"> void dmxBackendInit </td>
 200           <td class="md" valign="top">(&nbsp;</td>
 201           <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
 202           <td class="mdname1" valign="top" nowrap> <em>pDev</em>          </td>
 203           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 204           <td class="md" nowrap></td>
 205         </tr>
 206
 207       </table>
 208     </td>
 209   </tr>
 210 </table>
 211 <table cellspacing=5 cellpadding=0 border=0>
 212   <tr>
 213     <td>
 214       &nbsp;
 215     </td>
 216     <td>
 217
 218 <p>
 219 Initialized the backend device described by <em>pDev</em>.     </td>
 220   </tr>
 221 </table>
 222 <a class="anchor" name="a5" doxytag="dmxbackend.h::dmxBackendKbdGetInfo" ></a><p>
 223 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 224   <tr>
 225     <td class="mdRow">
 226       <table cellpadding="0" cellspacing="0" border="0">
 227         <tr>
 228           <td class="md" nowrap valign="top"> void dmxBackendKbdGetInfo </td>
 229           <td class="md" valign="top">(&nbsp;</td>
 230           <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
 231           <td class="mdname" nowrap> <em>pDev</em>, </td>
 232         </tr>
 233         <tr>
 234           <td></td>
 235           <td></td>
 236           <td class="md" nowrap><a class="el" href="struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr</a>&nbsp;</td>
 237           <td class="mdname" nowrap> <em>info</em></td>
 238         </tr>
 239         <tr>
 240           <td></td>
 241           <td class="md">)&nbsp;</td>
 242           <td class="md" colspan="2"></td>
 243         </tr>
 244
 245       </table>
 246     </td>
 247   </tr>
 248 </table>
 249 <table cellspacing=5 cellpadding=0 border=0>
 250   <tr>
 251     <td>
 252       &nbsp;
 253     </td>
 254     <td>
 255
 256 <p>
 257 Get information about the backend keyboard (for initialization).     </td>
 258   </tr>
 259 </table>
 260 <a class="anchor" name="a3" doxytag="dmxbackend.h::dmxBackendLateReInit" ></a><p>
 261 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 262   <tr>
 263     <td class="mdRow">
 264       <table cellpadding="0" cellspacing="0" border="0">
 265         <tr>
 266           <td class="md" nowrap valign="top"> void dmxBackendLateReInit </td>
 267           <td class="md" valign="top">(&nbsp;</td>
 268           <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
 269           <td class="mdname1" valign="top" nowrap> <em>pDev</em>          </td>
 270           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 271           <td class="md" nowrap></td>
 272         </tr>
 273
 274       </table>
 275     </td>
 276   </tr>
 277 </table>
 278 <table cellspacing=5 cellpadding=0 border=0>
 279   <tr>
 280     <td>
 281       &nbsp;
 282     </td>
 283     <td>
 284
 285 <p>
 286 Re-initialized the backend device described by <em>pDev</em> (after a reconfig).     </td>
 287   </tr>
 288 </table>
 289 <a class="anchor" name="a4" doxytag="dmxbackend.h::dmxBackendMouGetInfo" ></a><p>
 290 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 291   <tr>
 292     <td class="mdRow">
 293       <table cellpadding="0" cellspacing="0" border="0">
 294         <tr>
 295           <td class="md" nowrap valign="top"> void dmxBackendMouGetInfo </td>
 296           <td class="md" valign="top">(&nbsp;</td>
 297           <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
 298           <td class="mdname" nowrap> <em>pDev</em>, </td>
 299         </tr>
 300         <tr>
 301           <td></td>
 302           <td></td>
 303           <td class="md" nowrap><a class="el" href="struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr</a>&nbsp;</td>
 304           <td class="mdname" nowrap> <em>info</em></td>
 305         </tr>
 306         <tr>
 307           <td></td>
 308           <td class="md">)&nbsp;</td>
 309           <td class="md" colspan="2"></td>
 310         </tr>
 311
 312       </table>
 313     </td>
 314   </tr>
 315 </table>
 316 <table cellspacing=5 cellpadding=0 border=0>
 317   <tr>
 318     <td>
 319       &nbsp;
 320     </td>
 321     <td>
 322
 323 <p>
 324 Get information about the backend pointer (for initialization).     </td>
 325   </tr>
 326 </table>
 327 <a class="anchor" name="a7" doxytag="dmxbackend.h::dmxBackendProcessInput" ></a><p>
 328 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 329   <tr>
 330     <td class="mdRow">
 331       <table cellpadding="0" cellspacing="0" border="0">
 332         <tr>
 333           <td class="md" nowrap valign="top"> void dmxBackendProcessInput </td>
 334           <td class="md" valign="top">(&nbsp;</td>
 335           <td class="md" nowrap valign="top">pointer&nbsp;</td>
 336           <td class="mdname1" valign="top" nowrap> <em>private</em>          </td>
 337           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 338           <td class="md" nowrap></td>
 339         </tr>
 340
 341       </table>
 342     </td>
 343   </tr>
 344 </table>
 345 <table cellspacing=5 cellpadding=0 border=0>
 346   <tr>
 347     <td>
 348       &nbsp;
 349     </td>
 350     <td>
 351
 352 <p>
 353 Called after input events are processed from the DMX queue. No event processing actually takes place here, but this is a convenient place to update the pointer.     </td>
 354   </tr>
 355 </table>
 356 <a class="anchor" name="a9" doxytag="dmxbackend.h::dmxBackendUpdatePosition" ></a><p>
 357 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 358   <tr>
 359     <td class="mdRow">
 360       <table cellpadding="0" cellspacing="0" border="0">
 361         <tr>
 362           <td class="md" nowrap valign="top"> void dmxBackendUpdatePosition </td>
 363           <td class="md" valign="top">(&nbsp;</td>
 364           <td class="md" nowrap valign="top">pointer&nbsp;</td>
 365           <td class="mdname" nowrap> <em>private</em>, </td>
 366         </tr>
 367         <tr>
 368           <td></td>
 369           <td></td>
 370           <td class="md" nowrap>int&nbsp;</td>
 371           <td class="mdname" nowrap> <em>x</em>, </td>
 372         </tr>
 373         <tr>
 374           <td></td>
 375           <td></td>
 376           <td class="md" nowrap>int&nbsp;</td>
 377           <td class="mdname" nowrap> <em>y</em></td>
 378         </tr>
 379         <tr>
 380           <td></td>
 381           <td class="md">)&nbsp;</td>
 382           <td class="md" colspan="2"></td>
 383         </tr>
 384
 385       </table>
 386     </td>
 387   </tr>
 388 </table>
 389 <table cellspacing=5 cellpadding=0 border=0>
 390   <tr>
 391     <td>
 392       &nbsp;
 393     </td>
 394     <td>
 395
 396 <p>
 397 This routine is called from #dmxCoreMotion for each motion event. #x and #y are global coordinants.     </td>
 398   </tr>
 399 </table>
 400     <hr>
 401     <address>
 402       <small>
 403         Generated June 29, 2004 for <a
 404         href="http://dmx.sourceforge.net">Distributed Multihead X</a> by
 405         <a href="http://www.doxygen.org/index.html">doxygen</a>
 406         1.3.4.
 407       </small>
 408     </addres>
 409     </hr>
 410   </body>
 411 </html>