xorg-server-1.4/hw/dmx/doc/html/dmxextension_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>dmxextension.h File Reference</h1>
  12 <p>
  13 <a href="dmxextension_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>Data Structures</h2></td></tr>
  16 <tr><td class="memItemLeft" nowrap align=right valign=top>struct &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structDMXDesktopAttributesRec.html">DMXDesktopAttributesRec</a></td></tr>
  17
  18 <tr><td class="memItemLeft" nowrap align=right valign=top>struct &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structDMXInputAttributesRec.html">DMXInputAttributesRec</a></td></tr>
  19
  20 <tr><td class="memItemLeft" nowrap align=right valign=top>struct &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structDMXScreenAttributesRec.html">DMXScreenAttributesRec</a></td></tr>
  21
  22 <tr><td class="memItemLeft" nowrap align=right valign=top>struct &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structDMXWindowAttributesRec.html">DMXWindowAttributesRec</a></td></tr>
  23
  24 <tr><td colspan=2><br><h2>Functions</h2></td></tr>
  25 <tr><td class="memItemLeft" nowrap align=right valign=top>unsigned long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8h.html#a4">dmxGetNumScreens</a> (void)</td></tr>
  26
  27 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8h.html#a5">dmxForceWindowCreation</a> (WindowPtr pWindow)</td></tr>
  28
  29 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8h.html#a6">dmxFlushPendingSyncs</a> (void)</td></tr>
  30
  31 <tr><td class="memItemLeft" nowrap align=right valign=top>Bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8h.html#a7">dmxGetScreenAttributes</a> (int physical, DMXScreenAttributesPtr attr)</td></tr>
  32
  33 <tr><td class="memItemLeft" nowrap align=right valign=top>Bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8h.html#a8">dmxGetWindowAttributes</a> (WindowPtr pWindow, DMXWindowAttributesPtr attr)</td></tr>
  34
  35 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8h.html#a10">dmxGetInputCount</a> (void)</td></tr>
  36
  37 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8h.html#a11">dmxGetInputAttributes</a> (int deviceId, DMXInputAttributesPtr attr)</td></tr>
  38
  39 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8h.html#a12">dmxAddInput</a> (DMXInputAttributesPtr attr, int *deviceId)</td></tr>
  40
  41 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8h.html#a13">dmxRemoveInput</a> (int deviceId)</td></tr>
  42
  43 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8h.html#a17">dmxAttachScreen</a> (int idx, DMXScreenAttributesPtr attr)</td></tr>
  44
  45 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8h.html#a18">dmxDetachScreen</a> (int idx)</td></tr>
  46
  47 </table>
  48 <hr><a name="_details"></a><h2>Detailed Description</h2>
  49 Interface for DMX extension support. These routines are called by function in Xserver/Xext/dmx.c. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="dmxextension_8c.html">dmxextension.c</a></dd></dl>
  50 <hr><h2>Function Documentation</h2>
  51 <a class="anchor" name="a12" doxytag="dmxextension.h::dmxAddInput" ></a><p>
  52 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  53   <tr>
  54     <td class="mdRow">
  55       <table cellpadding="0" cellspacing="0" border="0">
  56         <tr>
  57           <td class="md" nowrap valign="top"> int dmxAddInput </td>
  58           <td class="md" valign="top">(&nbsp;</td>
  59           <td class="md" nowrap valign="top">DMXInputAttributesPtr&nbsp;</td>
  60           <td class="mdname" nowrap> <em>attr</em>, </td>
  61         </tr>
  62         <tr>
  63           <td></td>
  64           <td></td>
  65           <td class="md" nowrap>int *&nbsp;</td>
  66           <td class="mdname" nowrap> <em>id</em></td>
  67         </tr>
  68         <tr>
  69           <td></td>
  70           <td class="md">)&nbsp;</td>
  71           <td class="md" colspan="2"></td>
  72         </tr>
  73
  74       </table>
  75     </td>
  76   </tr>
  77 </table>
  78 <table cellspacing=5 cellpadding=0 border=0>
  79   <tr>
  80     <td>
  81       &nbsp;
  82     </td>
  83     <td>
  84
  85 <p>
  86 Add an input with the specified attributes. If the input is added, the physical id is returned in <em>deviceId</em>.     </td>
  87   </tr>
  88 </table>
  89 <a class="anchor" name="a17" doxytag="dmxextension.h::dmxAttachScreen" ></a><p>
  90 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  91   <tr>
  92     <td class="mdRow">
  93       <table cellpadding="0" cellspacing="0" border="0">
  94         <tr>
  95           <td class="md" nowrap valign="top"> int dmxAttachScreen </td>
  96           <td class="md" valign="top">(&nbsp;</td>
  97           <td class="md" nowrap valign="top">int&nbsp;</td>
  98           <td class="mdname" nowrap> <em>idx</em>, </td>
  99         </tr>
 100         <tr>
 101           <td></td>
 102           <td></td>
 103           <td class="md" nowrap>DMXScreenAttributesPtr&nbsp;</td>
 104           <td class="mdname" nowrap> <em>attr</em></td>
 105         </tr>
 106         <tr>
 107           <td></td>
 108           <td class="md">)&nbsp;</td>
 109           <td class="md" colspan="2"></td>
 110         </tr>
 111
 112       </table>
 113     </td>
 114   </tr>
 115 </table>
 116 <table cellspacing=5 cellpadding=0 border=0>
 117   <tr>
 118     <td>
 119       &nbsp;
 120     </td>
 121     <td>
 122
 123 <p>
 124 Reattach previously detached back-end screen.     </td>
 125   </tr>
 126 </table>
 127 <a class="anchor" name="a18" doxytag="dmxextension.h::dmxDetachScreen" ></a><p>
 128 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 129   <tr>
 130     <td class="mdRow">
 131       <table cellpadding="0" cellspacing="0" border="0">
 132         <tr>
 133           <td class="md" nowrap valign="top"> int dmxDetachScreen </td>
 134           <td class="md" valign="top">(&nbsp;</td>
 135           <td class="md" nowrap valign="top">int&nbsp;</td>
 136           <td class="mdname1" valign="top" nowrap> <em>idx</em>          </td>
 137           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 138           <td class="md" nowrap></td>
 139         </tr>
 140
 141       </table>
 142     </td>
 143   </tr>
 144 </table>
 145 <table cellspacing=5 cellpadding=0 border=0>
 146   <tr>
 147     <td>
 148       &nbsp;
 149     </td>
 150     <td>
 151
 152 <p>
 153 Detach back-end screen.     </td>
 154   </tr>
 155 </table>
 156 <a class="anchor" name="a6" doxytag="dmxextension.h::dmxFlushPendingSyncs" ></a><p>
 157 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 158   <tr>
 159     <td class="mdRow">
 160       <table cellpadding="0" cellspacing="0" border="0">
 161         <tr>
 162           <td class="md" nowrap valign="top"> void dmxFlushPendingSyncs </td>
 163           <td class="md" valign="top">(&nbsp;</td>
 164           <td class="md" nowrap valign="top">void&nbsp;</td>
 165           <td class="mdname1" valign="top" nowrap>          </td>
 166           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 167           <td class="md" nowrap></td>
 168         </tr>
 169
 170       </table>
 171     </td>
 172   </tr>
 173 </table>
 174 <table cellspacing=5 cellpadding=0 border=0>
 175   <tr>
 176     <td>
 177       &nbsp;
 178     </td>
 179     <td>
 180
 181 <p>
 182 Flush pending syncs for all screens.     </td>
 183   </tr>
 184 </table>
 185 <a class="anchor" name="a5" doxytag="dmxextension.h::dmxForceWindowCreation" ></a><p>
 186 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 187   <tr>
 188     <td class="mdRow">
 189       <table cellpadding="0" cellspacing="0" border="0">
 190         <tr>
 191           <td class="md" nowrap valign="top"> void dmxForceWindowCreation </td>
 192           <td class="md" valign="top">(&nbsp;</td>
 193           <td class="md" nowrap valign="top">WindowPtr&nbsp;</td>
 194           <td class="mdname1" valign="top" nowrap> <em>pWindow</em>          </td>
 195           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 196           <td class="md" nowrap></td>
 197         </tr>
 198
 199       </table>
 200     </td>
 201   </tr>
 202 </table>
 203 <table cellspacing=5 cellpadding=0 border=0>
 204   <tr>
 205     <td>
 206       &nbsp;
 207     </td>
 208     <td>
 209
 210 <p>
 211 Make sure that <a class="el" href="dmxwindow_8h.html#a14">dmxCreateAndRealizeWindow</a> has been called for <em>pWindow</em>.     </td>
 212   </tr>
 213 </table>
 214 <a class="anchor" name="a11" doxytag="dmxextension.h::dmxGetInputAttributes" ></a><p>
 215 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 216   <tr>
 217     <td class="mdRow">
 218       <table cellpadding="0" cellspacing="0" border="0">
 219         <tr>
 220           <td class="md" nowrap valign="top"> int dmxGetInputAttributes </td>
 221           <td class="md" valign="top">(&nbsp;</td>
 222           <td class="md" nowrap valign="top">int&nbsp;</td>
 223           <td class="mdname" nowrap> <em>deviceId</em>, </td>
 224         </tr>
 225         <tr>
 226           <td></td>
 227           <td></td>
 228           <td class="md" nowrap>DMXInputAttributesPtr&nbsp;</td>
 229           <td class="mdname" nowrap> <em>attr</em></td>
 230         </tr>
 231         <tr>
 232           <td></td>
 233           <td class="md">)&nbsp;</td>
 234           <td class="md" colspan="2"></td>
 235         </tr>
 236
 237       </table>
 238     </td>
 239   </tr>
 240 </table>
 241 <table cellspacing=5 cellpadding=0 border=0>
 242   <tr>
 243     <td>
 244       &nbsp;
 245     </td>
 246     <td>
 247
 248 <p>
 249 Return information about the device with id = <em>deviceId</em>. This information is primarily for the <a class="el" href="programs_2Xserver_2Xext_2dmx_8c.html#a58">ProcDMXGetInputAttributes()</a> function, which does not have access to the appropriate data structure.     </td>
 250   </tr>
 251 </table>
 252 <a class="anchor" name="a10" doxytag="dmxextension.h::dmxGetInputCount" ></a><p>
 253 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 254   <tr>
 255     <td class="mdRow">
 256       <table cellpadding="0" cellspacing="0" border="0">
 257         <tr>
 258           <td class="md" nowrap valign="top"> int dmxGetInputCount </td>
 259           <td class="md" valign="top">(&nbsp;</td>
 260           <td class="md" nowrap valign="top">void&nbsp;</td>
 261           <td class="mdname1" valign="top" nowrap>          </td>
 262           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 263           <td class="md" nowrap></td>
 264         </tr>
 265
 266       </table>
 267     </td>
 268   </tr>
 269 </table>
 270 <table cellspacing=5 cellpadding=0 border=0>
 271   <tr>
 272     <td>
 273       &nbsp;
 274     </td>
 275     <td>
 276
 277 <p>
 278 Return the total number of devices, not just <a class="el" href="dmxinput_8h.html#a4">dmxNumInputs</a>. The number returned should be the same as that returned by XListInputDevices.     </td>
 279   </tr>
 280 </table>
 281 <a class="anchor" name="a4" doxytag="dmxextension.h::dmxGetNumScreens" ></a><p>
 282 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 283   <tr>
 284     <td class="mdRow">
 285       <table cellpadding="0" cellspacing="0" border="0">
 286         <tr>
 287           <td class="md" nowrap valign="top"> unsigned long dmxGetNumScreens </td>
 288           <td class="md" valign="top">(&nbsp;</td>
 289           <td class="md" nowrap valign="top">void&nbsp;</td>
 290           <td class="mdname1" valign="top" nowrap>          </td>
 291           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 292           <td class="md" nowrap></td>
 293         </tr>
 294
 295       </table>
 296     </td>
 297   </tr>
 298 </table>
 299 <table cellspacing=5 cellpadding=0 border=0>
 300   <tr>
 301     <td>
 302       &nbsp;
 303     </td>
 304     <td>
 305
 306 <p>
 307 Return the value of <a class="el" href="dmxinit_8c.html#a1">dmxNumScreens</a> -- the total number of backend screens in use (these are logical screens and may be larger than the number of backend displays).     </td>
 308   </tr>
 309 </table>
 310 <a class="anchor" name="a7" doxytag="dmxextension.h::dmxGetScreenAttributes" ></a><p>
 311 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 312   <tr>
 313     <td class="mdRow">
 314       <table cellpadding="0" cellspacing="0" border="0">
 315         <tr>
 316           <td class="md" nowrap valign="top"> Bool dmxGetScreenAttributes </td>
 317           <td class="md" valign="top">(&nbsp;</td>
 318           <td class="md" nowrap valign="top">int&nbsp;</td>
 319           <td class="mdname" nowrap> <em>physical</em>, </td>
 320         </tr>
 321         <tr>
 322           <td></td>
 323           <td></td>
 324           <td class="md" nowrap>DMXScreenAttributesPtr&nbsp;</td>
 325           <td class="mdname" nowrap> <em>attr</em></td>
 326         </tr>
 327         <tr>
 328           <td></td>
 329           <td class="md">)&nbsp;</td>
 330           <td class="md" colspan="2"></td>
 331         </tr>
 332
 333       </table>
 334     </td>
 335   </tr>
 336 </table>
 337 <table cellspacing=5 cellpadding=0 border=0>
 338   <tr>
 339     <td>
 340       &nbsp;
 341     </td>
 342     <td>
 343
 344 <p>
 345 This routine provides information to the DMX protocol extension about a particular screen.     </td>
 346   </tr>
 347 </table>
 348 <a class="anchor" name="a8" doxytag="dmxextension.h::dmxGetWindowAttributes" ></a><p>
 349 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 350   <tr>
 351     <td class="mdRow">
 352       <table cellpadding="0" cellspacing="0" border="0">
 353         <tr>
 354           <td class="md" nowrap valign="top"> Bool dmxGetWindowAttributes </td>
 355           <td class="md" valign="top">(&nbsp;</td>
 356           <td class="md" nowrap valign="top">WindowPtr&nbsp;</td>
 357           <td class="mdname" nowrap> <em>pWindow</em>, </td>
 358         </tr>
 359         <tr>
 360           <td></td>
 361           <td></td>
 362           <td class="md" nowrap>DMXWindowAttributesPtr&nbsp;</td>
 363           <td class="mdname" nowrap> <em>attr</em></td>
 364         </tr>
 365         <tr>
 366           <td></td>
 367           <td class="md">)&nbsp;</td>
 368           <td class="md" colspan="2"></td>
 369         </tr>
 370
 371       </table>
 372     </td>
 373   </tr>
 374 </table>
 375 <table cellspacing=5 cellpadding=0 border=0>
 376   <tr>
 377     <td>
 378       &nbsp;
 379     </td>
 380     <td>
 381
 382 <p>
 383 This routine provides information to the DMX protocol extension about a particular window.     </td>
 384   </tr>
 385 </table>
 386 <a class="anchor" name="a13" doxytag="dmxextension.h::dmxRemoveInput" ></a><p>
 387 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 388   <tr>
 389     <td class="mdRow">
 390       <table cellpadding="0" cellspacing="0" border="0">
 391         <tr>
 392           <td class="md" nowrap valign="top"> int dmxRemoveInput </td>
 393           <td class="md" valign="top">(&nbsp;</td>
 394           <td class="md" nowrap valign="top">int&nbsp;</td>
 395           <td class="mdname1" valign="top" nowrap> <em>id</em>          </td>
 396           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 397           <td class="md" nowrap></td>
 398         </tr>
 399
 400       </table>
 401     </td>
 402   </tr>
 403 </table>
 404 <table cellspacing=5 cellpadding=0 border=0>
 405   <tr>
 406     <td>
 407       &nbsp;
 408     </td>
 409     <td>
 410
 411 <p>
 412 Remove the input with physical id <em>id</em>.     </td>
 413   </tr>
 414 </table>
 415     <hr>
 416     <address>
 417       <small>
 418         Generated June 29, 2004 for <a
 419         href="http://dmx.sourceforge.net">Distributed Multihead X</a> by
 420         <a href="http://www.doxygen.org/index.html">doxygen</a>
 421         1.3.4.
 422       </small>
 423     </addres>
 424     </hr>
 425   </body>
 426 </html>