xorg-server-1.4/hw/dmx/doc/html/dmxcursor_8c.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>dmxcursor.c File Reference</h1><code>#include "<a class="el" href="dmx_8h-source.html">dmx.h</a>"</code><br>
  12 <code>#include "<a class="el" href="dmxsync_8h-source.html">dmxsync.h</a>"</code><br>
  13 <code>#include "<a class="el" href="dmxcursor_8h-source.html">dmxcursor.h</a>"</code><br>
  14 <code>#include "<a class="el" href="dmxlog_8h-source.html">dmxlog.h</a>"</code><br>
  15 <code>#include "<a class="el" href="dmxprop_8h-source.html">dmxprop.h</a>"</code><br>
  16 <code>#include "<a class="el" href="dmxinput_8h-source.html">dmxinput.h</a>"</code><br>
  17 <code>#include "mipointer.h"</code><br>
  18 <code>#include "windowstr.h"</code><br>
  19 <code>#include "globals.h"</code><br>
  20 <code>#include "cursorstr.h"</code><br>
  21 <code>#include "dixevents.h"</code><br>
  22 <table border=0 cellpadding=0 cellspacing=0>
  23 <tr><td></td></tr>
  24 <tr><td colspan=2><br><h2>Functions</h2></td></tr>
  25 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxcursor_8c.html#a12">dmxCursorNoMulti</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="dmxcursor_8c.html#a21">dmxReInitOrigins</a> (void)</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="dmxcursor_8c.html#a22">dmxInitOrigins</a> (void)</td></tr>
  30
  31 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxcursor_8c.html#a23">dmxOnScreen</a> (int x, int y, <a class="el" href="struct__DMXScreenInfo.html">DMXScreenInfo</a> *dmxScreen)</td></tr>
  32
  33 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxcursor_8c.html#a28">dmxInitOverlap</a> (void)</td></tr>
  34
  35 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxcursor_8c.html#a29">dmxBECreateCursor</a> (ScreenPtr pScreen, CursorPtr pCursor)</td></tr>
  36
  37 <tr><td class="memItemLeft" nowrap align=right valign=top>Bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxcursor_8c.html#a31">dmxBEFreeCursor</a> (ScreenPtr pScreen, CursorPtr pCursor)</td></tr>
  38
  39 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxcursor_8c.html#a38">dmxMoveCursor</a> (ScreenPtr pScreen, int x, int y)</td></tr>
  40
  41 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxcursor_8c.html#a40">dmxHideCursor</a> (<a class="el" href="struct__DMXScreenInfo.html">DMXScreenInfo</a> *dmxScreen)</td></tr>
  42
  43 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxcursor_8c.html#a41">dmxCheckCursor</a> (void)</td></tr>
  44
  45 <tr><td colspan=2><br><h2>Variables</h2></td></tr>
  46 <tr><td class="memItemLeft" nowrap align=right valign=top>miPointerScreenFuncRec&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxcursor_8c.html#a10">dmxPointerCursorFuncs</a></td></tr>
  47
  48 <tr><td class="memItemLeft" nowrap align=right valign=top>miPointerSpriteFuncRec&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxcursor_8c.html#a11">dmxPointerSpriteFuncs</a></td></tr>
  49
  50 </table>
  51 <hr><a name="_details"></a><h2>Detailed Description</h2>
  52 This file contains code than supports cursor movement, including the code that initializes and reinitializes the screen positions and computes screen overlap.<p>
  53 "This code is based very closely on the XFree86 equivalent (xfree86/common/xf86Cursor.c)." --David Dawes.<p>
  54 "This code was then extensively re-written, as explained here." --Rik Faith<p>
  55 The code in xf86Cursor.c used edge lists to implement the CursorOffScreen function. The edge list computation was complex (especially in the face of arbitrarily overlapping screens) compared with the speed savings in the CursorOffScreen function. The new implementation has erred on the side of correctness, readability, and maintainability over efficiency. For the common (non-edge) case, the dmxCursorOffScreen function does avoid a loop over all the screens. When the cursor has left the screen, all the screens are searched, and the first screen (in dmxScreens order) containing the cursor will be returned. If run-time profiling shows that this routing is a performance bottle-neck, then an edge list may have to be reimplemented. An edge list algorithm is O(edges) whereas the new algorithm is O(dmxNumScreens). Since edges is usually 1-3 and dmxNumScreens may be 30-60 for large backend walls, this trade off may be compelling.<p>
  56 The xf86InitOrigins routine uses bit masks during the computation and is therefore limited to the length of a word (e.g., 32 or 64 bits) screens. Because Xdmx is expected to be used with a large number of backend displays, this limitation was removed. The new implementation has erred on the side of readability over efficiency, using the dmxSL* routines to manage a screen list instead of a bitmap, and a function call to decrease the length of the main routine. Both algorithms are of the same order, and both are called only at server generation time, so trading clarity and long-term maintainability for efficiency does not seem justified in this case.<hr><h2>Function Documentation</h2>
  57 <a class="anchor" name="a29" doxytag="dmxcursor.c::dmxBECreateCursor" ></a><p>
  58 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  59   <tr>
  60     <td class="mdRow">
  61       <table cellpadding="0" cellspacing="0" border="0">
  62         <tr>
  63           <td class="md" nowrap valign="top"> void dmxBECreateCursor </td>
  64           <td class="md" valign="top">(&nbsp;</td>
  65           <td class="md" nowrap valign="top">ScreenPtr&nbsp;</td>
  66           <td class="mdname" nowrap> <em>pScreen</em>, </td>
  67         </tr>
  68         <tr>
  69           <td></td>
  70           <td></td>
  71           <td class="md" nowrap>CursorPtr&nbsp;</td>
  72           <td class="mdname" nowrap> <em>pCursor</em></td>
  73         </tr>
  74         <tr>
  75           <td></td>
  76           <td class="md">)&nbsp;</td>
  77           <td class="md" colspan="2"></td>
  78         </tr>
  79
  80       </table>
  81     </td>
  82   </tr>
  83 </table>
  84 <table cellspacing=5 cellpadding=0 border=0>
  85   <tr>
  86     <td>
  87       &nbsp;
  88     </td>
  89     <td>
  90
  91 <p>
  92 Create <em>pCursor</em> on the back-end associated with <em>pScreen</em>.     </td>
  93   </tr>
  94 </table>
  95 <a class="anchor" name="a31" doxytag="dmxcursor.c::dmxBEFreeCursor" ></a><p>
  96 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  97   <tr>
  98     <td class="mdRow">
  99       <table cellpadding="0" cellspacing="0" border="0">
 100         <tr>
 101           <td class="md" nowrap valign="top"> Bool dmxBEFreeCursor </td>
 102           <td class="md" valign="top">(&nbsp;</td>
 103           <td class="md" nowrap valign="top">ScreenPtr&nbsp;</td>
 104           <td class="mdname" nowrap> <em>pScreen</em>, </td>
 105         </tr>
 106         <tr>
 107           <td></td>
 108           <td></td>
 109           <td class="md" nowrap>CursorPtr&nbsp;</td>
 110           <td class="mdname" nowrap> <em>pCursor</em></td>
 111         </tr>
 112         <tr>
 113           <td></td>
 114           <td class="md">)&nbsp;</td>
 115           <td class="md" colspan="2"></td>
 116         </tr>
 117
 118       </table>
 119     </td>
 120   </tr>
 121 </table>
 122 <table cellspacing=5 cellpadding=0 border=0>
 123   <tr>
 124     <td>
 125       &nbsp;
 126     </td>
 127     <td>
 128
 129 <p>
 130 Free <em>pCursor</em> on the back-end associated with <em>pScreen</em>.     </td>
 131   </tr>
 132 </table>
 133 <a class="anchor" name="a41" doxytag="dmxcursor.c::dmxCheckCursor" ></a><p>
 134 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 135   <tr>
 136     <td class="mdRow">
 137       <table cellpadding="0" cellspacing="0" border="0">
 138         <tr>
 139           <td class="md" nowrap valign="top"> void dmxCheckCursor </td>
 140           <td class="md" valign="top">(&nbsp;</td>
 141           <td class="md" nowrap valign="top">void&nbsp;</td>
 142           <td class="mdname1" valign="top" nowrap>          </td>
 143           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 144           <td class="md" nowrap></td>
 145         </tr>
 146
 147       </table>
 148     </td>
 149   </tr>
 150 </table>
 151 <table cellspacing=5 cellpadding=0 border=0>
 152   <tr>
 153     <td>
 154       &nbsp;
 155     </td>
 156     <td>
 157
 158 <p>
 159 This routine is called during reconfiguration to make sure the cursor is visible.     </td>
 160   </tr>
 161 </table>
 162 <a class="anchor" name="a12" doxytag="dmxcursor.c::dmxCursorNoMulti" ></a><p>
 163 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 164   <tr>
 165     <td class="mdRow">
 166       <table cellpadding="0" cellspacing="0" border="0">
 167         <tr>
 168           <td class="md" nowrap valign="top"> void dmxCursorNoMulti </td>
 169           <td class="md" valign="top">(&nbsp;</td>
 170           <td class="md" nowrap valign="top">void&nbsp;</td>
 171           <td class="mdname1" valign="top" nowrap>          </td>
 172           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 173           <td class="md" nowrap></td>
 174         </tr>
 175
 176       </table>
 177     </td>
 178   </tr>
 179 </table>
 180 <table cellspacing=5 cellpadding=0 border=0>
 181   <tr>
 182     <td>
 183       &nbsp;
 184     </td>
 185     <td>
 186
 187 <p>
 188 Turn off support for displaying multiple cursors on overlapped back-end displays. See #dmxCursorDoMultiCursors.     </td>
 189   </tr>
 190 </table>
 191 <a class="anchor" name="a40" doxytag="dmxcursor.c::dmxHideCursor" ></a><p>
 192 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 193   <tr>
 194     <td class="mdRow">
 195       <table cellpadding="0" cellspacing="0" border="0">
 196         <tr>
 197           <td class="md" nowrap valign="top"> void dmxHideCursor </td>
 198           <td class="md" valign="top">(&nbsp;</td>
 199           <td class="md" nowrap valign="top"><a class="el" href="struct__DMXScreenInfo.html">DMXScreenInfo</a> *&nbsp;</td>
 200           <td class="mdname1" valign="top" nowrap> <em>dmxScreen</em>          </td>
 201           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 202           <td class="md" nowrap></td>
 203         </tr>
 204
 205       </table>
 206     </td>
 207   </tr>
 208 </table>
 209 <table cellspacing=5 cellpadding=0 border=0>
 210   <tr>
 211     <td>
 212       &nbsp;
 213     </td>
 214     <td>
 215
 216 <p>
 217 This routine is used by the backend input routines to hide the cursor on a screen that is being used for relative input. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="dmxbackend_8c.html">dmxbackend.c</a> </dd></dl>
 218     </td>
 219   </tr>
 220 </table>
 221 <a class="anchor" name="a22" doxytag="dmxcursor.c::dmxInitOrigins" ></a><p>
 222 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 223   <tr>
 224     <td class="mdRow">
 225       <table cellpadding="0" cellspacing="0" border="0">
 226         <tr>
 227           <td class="md" nowrap valign="top"> void dmxInitOrigins </td>
 228           <td class="md" valign="top">(&nbsp;</td>
 229           <td class="md" nowrap valign="top">void&nbsp;</td>
 230           <td class="mdname1" valign="top" nowrap>          </td>
 231           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 232           <td class="md" nowrap></td>
 233         </tr>
 234
 235       </table>
 236     </td>
 237   </tr>
 238 </table>
 239 <table cellspacing=5 cellpadding=0 border=0>
 240   <tr>
 241     <td>
 242       &nbsp;
 243     </td>
 244     <td>
 245
 246 <p>
 247 Initialize screen origins (and relative position). This is called for each server generation. For dynamic reconfiguration, use <a class="el" href="dmxcursor_8c.html#a21">dmxReInitOrigins()</a> instead.     </td>
 248   </tr>
 249 </table>
 250 <a class="anchor" name="a28" doxytag="dmxcursor.c::dmxInitOverlap" ></a><p>
 251 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 252   <tr>
 253     <td class="mdRow">
 254       <table cellpadding="0" cellspacing="0" border="0">
 255         <tr>
 256           <td class="md" nowrap valign="top"> void dmxInitOverlap </td>
 257           <td class="md" valign="top">(&nbsp;</td>
 258           <td class="md" nowrap valign="top">void&nbsp;</td>
 259           <td class="mdname1" valign="top" nowrap>          </td>
 260           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 261           <td class="md" nowrap></td>
 262         </tr>
 263
 264       </table>
 265     </td>
 266   </tr>
 267 </table>
 268 <table cellspacing=5 cellpadding=0 border=0>
 269   <tr>
 270     <td>
 271       &nbsp;
 272     </td>
 273     <td>
 274
 275 <p>
 276 Detects overlapping dmxScreens and creates circular lists. This uses an O(dmxNumScreens^2) algorithm, but dmxNumScreens is &lt; 100 and the computation only needs to be performed for every server generation or dynamic reconfiguration .     </td>
 277   </tr>
 278 </table>
 279 <a class="anchor" name="a38" doxytag="dmxcursor.c::dmxMoveCursor" ></a><p>
 280 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 281   <tr>
 282     <td class="mdRow">
 283       <table cellpadding="0" cellspacing="0" border="0">
 284         <tr>
 285           <td class="md" nowrap valign="top"> void dmxMoveCursor </td>
 286           <td class="md" valign="top">(&nbsp;</td>
 287           <td class="md" nowrap valign="top">ScreenPtr&nbsp;</td>
 288           <td class="mdname" nowrap> <em>pScreen</em>, </td>
 289         </tr>
 290         <tr>
 291           <td></td>
 292           <td></td>
 293           <td class="md" nowrap>int&nbsp;</td>
 294           <td class="mdname" nowrap> <em>x</em>, </td>
 295         </tr>
 296         <tr>
 297           <td></td>
 298           <td></td>
 299           <td class="md" nowrap>int&nbsp;</td>
 300           <td class="mdname" nowrap> <em>y</em></td>
 301         </tr>
 302         <tr>
 303           <td></td>
 304           <td class="md">)&nbsp;</td>
 305           <td class="md" colspan="2"></td>
 306         </tr>
 307
 308       </table>
 309     </td>
 310   </tr>
 311 </table>
 312 <table cellspacing=5 cellpadding=0 border=0>
 313   <tr>
 314     <td>
 315       &nbsp;
 316     </td>
 317     <td>
 318
 319 <p>
 320 Move the cursor to coordinates (<em>x</em>, <em>y</em>)on <em>pScreen</em>. This function is usually called via <a class="el" href="dmxcursor_8h.html#a4">dmxPointerSpriteFuncs</a>, except during reconfiguration when the cursor is repositioned to force an update on newley overlapping screens and on screens that no longer overlap.     </td>
 321   </tr>
 322 </table>
 323 <a class="anchor" name="a23" doxytag="dmxcursor.c::dmxOnScreen" ></a><p>
 324 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 325   <tr>
 326     <td class="mdRow">
 327       <table cellpadding="0" cellspacing="0" border="0">
 328         <tr>
 329           <td class="md" nowrap valign="top"> int dmxOnScreen </td>
 330           <td class="md" valign="top">(&nbsp;</td>
 331           <td class="md" nowrap valign="top">int&nbsp;</td>
 332           <td class="mdname" nowrap> <em>x</em>, </td>
 333         </tr>
 334         <tr>
 335           <td></td>
 336           <td></td>
 337           <td class="md" nowrap>int&nbsp;</td>
 338           <td class="mdname" nowrap> <em>y</em>, </td>
 339         </tr>
 340         <tr>
 341           <td></td>
 342           <td></td>
 343           <td class="md" nowrap><a class="el" href="struct__DMXScreenInfo.html">DMXScreenInfo</a> *&nbsp;</td>
 344           <td class="mdname" nowrap> <em>dmxScreen</em></td>
 345         </tr>
 346         <tr>
 347           <td></td>
 348           <td class="md">)&nbsp;</td>
 349           <td class="md" colspan="2"></td>
 350         </tr>
 351
 352       </table>
 353     </td>
 354   </tr>
 355 </table>
 356 <table cellspacing=5 cellpadding=0 border=0>
 357   <tr>
 358     <td>
 359       &nbsp;
 360     </td>
 361     <td>
 362
 363 <p>
 364 Returns non-zero if the global <em>x</em>, <em>y</em> coordinate is on the screen window of the <em>dmxScreen</em>.     </td>
 365   </tr>
 366 </table>
 367 <a class="anchor" name="a21" doxytag="dmxcursor.c::dmxReInitOrigins" ></a><p>
 368 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 369   <tr>
 370     <td class="mdRow">
 371       <table cellpadding="0" cellspacing="0" border="0">
 372         <tr>
 373           <td class="md" nowrap valign="top"> void dmxReInitOrigins </td>
 374           <td class="md" valign="top">(&nbsp;</td>
 375           <td class="md" nowrap valign="top">void&nbsp;</td>
 376           <td class="mdname1" valign="top" nowrap>          </td>
 377           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 378           <td class="md" nowrap></td>
 379         </tr>
 380
 381       </table>
 382     </td>
 383   </tr>
 384 </table>
 385 <table cellspacing=5 cellpadding=0 border=0>
 386   <tr>
 387     <td>
 388       &nbsp;
 389     </td>
 390     <td>
 391
 392 <p>
 393 Recompute origin information in the <a class="el" href="dmxinit_8c.html#a2">dmxScreens</a> list. This is either called from <a class="el" href="dmxcursor_8c.html#a22">dmxInitOrigins()</a> or from #dmxReconfig().     </td>
 394   </tr>
 395 </table>
 396 <hr><h2>Variable Documentation</h2>
 397 <a class="anchor" name="a10" doxytag="dmxcursor.c::dmxPointerCursorFuncs" ></a><p>
 398 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 399   <tr>
 400     <td class="mdRow">
 401       <table cellpadding="0" cellspacing="0" border="0">
 402         <tr>
 403           <td class="md" nowrap valign="top"> miPointerScreenFuncRec <a class="el" href="dmxcursor_8h.html#a3">dmxPointerCursorFuncs</a>
 404       </table>
 405     </td>
 406   </tr>
 407 </table>
 408 <table cellspacing=5 cellpadding=0 border=0>
 409   <tr>
 410     <td>
 411       &nbsp;
 412     </td>
 413     <td>
 414
 415 <p>
 416 <b>Initial value:</b><div class="fragment"><pre>
 417 {
 418     dmxCursorOffScreen,
 419     dmxCrossScreen,
 420     dmxWarpCursor,
 421     <a class="code" href="dmxeq_8c.html#a13">dmxeqEnqueue</a>,
 422     <a class="code" href="dmxeq_8c.html#a14">dmxeqSwitchScreen</a>
 423 }
 424 </pre></div>Cursor functions for mi layer. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="dmxcursor_8c.html">dmxcursor.c</a> <p>
 425 <a class="el" href="dmxscrinit_8c.html">dmxscrinit.c</a> </dd></dl>
 426     </td>
 427   </tr>
 428 </table>
 429 <a class="anchor" name="a11" doxytag="dmxcursor.c::dmxPointerSpriteFuncs" ></a><p>
 430 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 431   <tr>
 432     <td class="mdRow">
 433       <table cellpadding="0" cellspacing="0" border="0">
 434         <tr>
 435           <td class="md" nowrap valign="top"> miPointerSpriteFuncRec <a class="el" href="dmxcursor_8h.html#a4">dmxPointerSpriteFuncs</a>
 436       </table>
 437     </td>
 438   </tr>
 439 </table>
 440 <table cellspacing=5 cellpadding=0 border=0>
 441   <tr>
 442     <td>
 443       &nbsp;
 444     </td>
 445     <td>
 446
 447 <p>
 448 <b>Initial value:</b><div class="fragment"><pre>
 449 {
 450     dmxRealizeCursor,
 451     dmxUnrealizeCursor,
 452     dmxSetCursor,
 453     <a class="code" href="dmxcursor_8c.html#a38">dmxMoveCursor</a>,
 454 }
 455 </pre></div>Sprite functions for mi layer. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="dmxcursor_8c.html">dmxcursor.c</a> <p>
 456 <a class="el" href="dmxscrinit_8c.html">dmxscrinit.c</a> </dd></dl>
 457     </td>
 458   </tr>
 459 </table>
 460     <hr>
 461     <address>
 462       <small>
 463         Generated June 29, 2004 for <a
 464         href="http://dmx.sourceforge.net">Distributed Multihead X</a> by
 465         <a href="http://www.doxygen.org/index.html">doxygen</a>
 466         1.3.4.
 467       </small>
 468     </addres>
 469     </hr>
 470   </body>
 471 </html>