1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
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">
9 <!-- Generated by Doxygen 1.3.4 -->
10 <div class=
"qindex"><a class=
"qindex" href=
"main.html">Main
Page
</a> |
<a class=
"qindex" href=
"classes.html">Alphabetical
List
</a> |
<a class=
"qindex" href=
"annotated.html">Data
Structures
</a> |
<a class=
"qindex" href=
"files.html">File
List
</a> |
<a class=
"qindex" href=
"functions.html">Data
Fields
</a> |
<a class=
"qindex" href=
"globals.html">Globals
</a></div>
11 <h1>dmxcommon.h File Reference
</h1>
13 <a href=
"dmxcommon_8h-source.html">Go to the source code of this file.
</a><table border=
0 cellpadding=
0 cellspacing=
0>
15 <tr><td colspan=
2><br><h2>Functions
</h2></td></tr>
16 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxcommon_8h.html#a13">dmxCommonKbdGetInfo
</a> (DevicePtr pDev,
<a class=
"el" href=
"struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr
</a> info)
</td></tr>
18 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxcommon_8h.html#a14">dmxCommonKbdGetMap
</a> (DevicePtr pDev, KeySymsPtr pKeySyms, CARD8 *pModMap)
</td></tr>
20 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxcommon_8h.html#a15">dmxCommonKbdCtrl
</a> (DevicePtr pDev, KeybdCtrl *ctrl)
</td></tr>
22 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxcommon_8h.html#a16">dmxCommonKbdBell
</a> (DevicePtr pDev, int percent, int volume, int pitch, int duration)
</td></tr>
24 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>int
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxcommon_8h.html#a17">dmxCommonKbdOn
</a> (DevicePtr pDev)
</td></tr>
26 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxcommon_8h.html#a18">dmxCommonKbdOff
</a> (DevicePtr pDev)
</td></tr>
28 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxcommon_8h.html#a19">dmxCommonMouGetMap
</a> (DevicePtr pDev, unsigned char *map, int *nButtons)
</td></tr>
30 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxcommon_8h.html#a20">dmxCommonMouCtrl
</a> (DevicePtr pDev, PtrCtrl *ctrl)
</td></tr>
32 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>int
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxcommon_8h.html#a21">dmxCommonMouOn
</a> (DevicePtr pDev)
</td></tr>
34 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxcommon_8h.html#a22">dmxCommonMouOff
</a> (DevicePtr pDev)
</td></tr>
36 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>int
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxcommon_8h.html#a23">dmxFindPointerScreen
</a> (int x, int y)
</td></tr>
38 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>int
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxcommon_8h.html#a24">dmxCommonOthOn
</a> (DevicePtr pDev)
</td></tr>
40 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxcommon_8h.html#a25">dmxCommonOthOff
</a> (DevicePtr pDev)
</td></tr>
42 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxcommon_8h.html#a26">dmxCommonOthGetInfo
</a> (DevicePtr pDev,
<a class=
"el" href=
"struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr
</a> info)
</td></tr>
44 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>pointer
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxcommon_8h.html#a27">dmxCommonCopyPrivate
</a> (DeviceIntPtr pDevice)
</td></tr>
46 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxcommon_8h.html#a28">dmxCommonSaveState
</a> (pointer private)
</td></tr>
48 <tr><td class=
"memItemLeft" nowrap align=right valign=top
>void
</td><td class=
"memItemRight" valign=bottom
><a class=
"el" href=
"dmxcommon_8h.html#a29">dmxCommonRestoreState
</a> (pointer private)
</td></tr>
51 <hr><a name=
"_details"></a><h2>Detailed Description
</h2>
52 Interface to functions used by backend and console input devices.
<dl compact
><dt><b>See also:
</b></dt><dd><a class=
"el" href=
"dmxcommon_8c.html">dmxcommon.c
</a> <p>
53 <a class=
"el" href=
"dmxbackend_8c.html">dmxbackend.c
</a> <p>
54 <a class=
"el" href=
"dmxconsole_8c.html">dmxconsole.c
</a></dd></dl>
55 <hr><h2>Function Documentation
</h2>
56 <a class=
"anchor" name=
"a27" doxytag=
"dmxcommon.h::dmxCommonCopyPrivate" ></a><p>
57 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
60 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
62 <td class=
"md" nowrap
valign=
"top"> pointer dmxCommonCopyPrivate
</td>
63 <td class=
"md" valign=
"top">(
</td>
64 <td class=
"md" nowrap
valign=
"top">DeviceIntPtr
</td>
65 <td class=
"mdname1" valign=
"top" nowrap
> <em>pDevice
</em> </td>
66 <td class=
"md" valign=
"top"> )
</td>
67 <td class=
"md" nowrap
></td>
74 <table cellspacing=
5 cellpadding=
0 border=
0>
82 Returns a pointer to the private area for the device that comes just prior to
<em>pDevice
</em> in the current
<em>dmxInput
</em> device list. This is used as the private area for the current device in some situations (e.g., when a keyboard and mouse form a pair that should share the same private area). If the requested private area cannot be located, then NULL is returned.
</td>
85 <a class=
"anchor" name=
"a16" doxytag=
"dmxcommon.h::dmxCommonKbdBell" ></a><p>
86 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
89 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
91 <td class=
"md" nowrap
valign=
"top"> void dmxCommonKbdBell
</td>
92 <td class=
"md" valign=
"top">(
</td>
93 <td class=
"md" nowrap
valign=
"top">DevicePtr
</td>
94 <td class=
"mdname" nowrap
> <em>pDev
</em>,
</td>
99 <td class=
"md" nowrap
>int
</td>
100 <td class=
"mdname" nowrap
> <em>percent
</em>,
</td>
105 <td class=
"md" nowrap
>int
</td>
106 <td class=
"mdname" nowrap
> <em>volume
</em>,
</td>
111 <td class=
"md" nowrap
>int
</td>
112 <td class=
"mdname" nowrap
> <em>pitch
</em>,
</td>
117 <td class=
"md" nowrap
>int
</td>
118 <td class=
"mdname" nowrap
> <em>duration
</em></td>
122 <td class=
"md">)
</td>
123 <td class=
"md" colspan=
"2"></td>
130 <table cellspacing=
5 cellpadding=
0 border=
0>
138 Sound they keyboard bell.
</td>
141 <a class=
"anchor" name=
"a15" doxytag=
"dmxcommon.h::dmxCommonKbdCtrl" ></a><p>
142 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
145 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
147 <td class=
"md" nowrap
valign=
"top"> void dmxCommonKbdCtrl
</td>
148 <td class=
"md" valign=
"top">(
</td>
149 <td class=
"md" nowrap
valign=
"top">DevicePtr
</td>
150 <td class=
"mdname" nowrap
> <em>pDev
</em>,
</td>
155 <td class=
"md" nowrap
>KeybdCtrl *
</td>
156 <td class=
"mdname" nowrap
> <em>ctrl
</em></td>
160 <td class=
"md">)
</td>
161 <td class=
"md" colspan=
"2"></td>
168 <table cellspacing=
5 cellpadding=
0 border=
0>
176 Update the keyboard control.
</td>
179 <a class=
"anchor" name=
"a13" doxytag=
"dmxcommon.h::dmxCommonKbdGetInfo" ></a><p>
180 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
183 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
185 <td class=
"md" nowrap
valign=
"top"> void dmxCommonKbdGetInfo
</td>
186 <td class=
"md" valign=
"top">(
</td>
187 <td class=
"md" nowrap
valign=
"top">DevicePtr
</td>
188 <td class=
"mdname" nowrap
> <em>pDev
</em>,
</td>
193 <td class=
"md" nowrap
><a class=
"el" href=
"struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr
</a> </td>
194 <td class=
"mdname" nowrap
> <em>info
</em></td>
198 <td class=
"md">)
</td>
199 <td class=
"md" colspan=
"2"></td>
206 <table cellspacing=
5 cellpadding=
0 border=
0>
214 Fill in the XKEYBOARD parts of the
<em>info
</em> structure for the specified
<em>pDev
</em>.
</td>
217 <a class=
"anchor" name=
"a14" doxytag=
"dmxcommon.h::dmxCommonKbdGetMap" ></a><p>
218 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
221 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
223 <td class=
"md" nowrap
valign=
"top"> void dmxCommonKbdGetMap
</td>
224 <td class=
"md" valign=
"top">(
</td>
225 <td class=
"md" nowrap
valign=
"top">DevicePtr
</td>
226 <td class=
"mdname" nowrap
> <em>pDev
</em>,
</td>
231 <td class=
"md" nowrap
>KeySymsPtr
</td>
232 <td class=
"mdname" nowrap
> <em>pKeySyms
</em>,
</td>
237 <td class=
"md" nowrap
>CARD8 *
</td>
238 <td class=
"mdname" nowrap
> <em>pModMap
</em></td>
242 <td class=
"md">)
</td>
243 <td class=
"md" colspan=
"2"></td>
250 <table cellspacing=
5 cellpadding=
0 border=
0>
258 Get the keyboard mapping.
</td>
261 <a class=
"anchor" name=
"a18" doxytag=
"dmxcommon.h::dmxCommonKbdOff" ></a><p>
262 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
265 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
267 <td class=
"md" nowrap
valign=
"top"> void dmxCommonKbdOff
</td>
268 <td class=
"md" valign=
"top">(
</td>
269 <td class=
"md" nowrap
valign=
"top">DevicePtr
</td>
270 <td class=
"mdname1" valign=
"top" nowrap
> <em>pDev
</em> </td>
271 <td class=
"md" valign=
"top"> )
</td>
272 <td class=
"md" nowrap
></td>
279 <table cellspacing=
5 cellpadding=
0 border=
0>
287 Turn
<em>pDev
</em> off.
</td>
290 <a class=
"anchor" name=
"a17" doxytag=
"dmxcommon.h::dmxCommonKbdOn" ></a><p>
291 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
294 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
296 <td class=
"md" nowrap
valign=
"top"> int dmxCommonKbdOn
</td>
297 <td class=
"md" valign=
"top">(
</td>
298 <td class=
"md" nowrap
valign=
"top">DevicePtr
</td>
299 <td class=
"mdname1" valign=
"top" nowrap
> <em>pDev
</em> </td>
300 <td class=
"md" valign=
"top"> )
</td>
301 <td class=
"md" nowrap
></td>
308 <table cellspacing=
5 cellpadding=
0 border=
0>
316 Turn
<em>pDev
</em> on (i.e., take input from
<em>pDev
</em>).
</td>
319 <a class=
"anchor" name=
"a20" doxytag=
"dmxcommon.h::dmxCommonMouCtrl" ></a><p>
320 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
323 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
325 <td class=
"md" nowrap
valign=
"top"> void dmxCommonMouCtrl
</td>
326 <td class=
"md" valign=
"top">(
</td>
327 <td class=
"md" nowrap
valign=
"top">DevicePtr
</td>
328 <td class=
"mdname" nowrap
> <em>pDev
</em>,
</td>
333 <td class=
"md" nowrap
>PtrCtrl *
</td>
334 <td class=
"mdname" nowrap
> <em>ctrl
</em></td>
338 <td class=
"md">)
</td>
339 <td class=
"md" colspan=
"2"></td>
346 <table cellspacing=
5 cellpadding=
0 border=
0>
354 Update the mouse control.
</td>
357 <a class=
"anchor" name=
"a19" doxytag=
"dmxcommon.h::dmxCommonMouGetMap" ></a><p>
358 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
361 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
363 <td class=
"md" nowrap
valign=
"top"> void dmxCommonMouGetMap
</td>
364 <td class=
"md" valign=
"top">(
</td>
365 <td class=
"md" nowrap
valign=
"top">DevicePtr
</td>
366 <td class=
"mdname" nowrap
> <em>pDev
</em>,
</td>
371 <td class=
"md" nowrap
>unsigned char *
</td>
372 <td class=
"mdname" nowrap
> <em>map
</em>,
</td>
377 <td class=
"md" nowrap
>int *
</td>
378 <td class=
"mdname" nowrap
> <em>nButtons
</em></td>
382 <td class=
"md">)
</td>
383 <td class=
"md" colspan=
"2"></td>
390 <table cellspacing=
5 cellpadding=
0 border=
0>
398 Obtain the mouse button mapping.
</td>
401 <a class=
"anchor" name=
"a22" doxytag=
"dmxcommon.h::dmxCommonMouOff" ></a><p>
402 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
405 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
407 <td class=
"md" nowrap
valign=
"top"> void dmxCommonMouOff
</td>
408 <td class=
"md" valign=
"top">(
</td>
409 <td class=
"md" nowrap
valign=
"top">DevicePtr
</td>
410 <td class=
"mdname1" valign=
"top" nowrap
> <em>pDev
</em> </td>
411 <td class=
"md" valign=
"top"> )
</td>
412 <td class=
"md" nowrap
></td>
419 <table cellspacing=
5 cellpadding=
0 border=
0>
427 Turn
<em>pDev
</em> off.
</td>
430 <a class=
"anchor" name=
"a21" doxytag=
"dmxcommon.h::dmxCommonMouOn" ></a><p>
431 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
434 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
436 <td class=
"md" nowrap
valign=
"top"> int dmxCommonMouOn
</td>
437 <td class=
"md" valign=
"top">(
</td>
438 <td class=
"md" nowrap
valign=
"top">DevicePtr
</td>
439 <td class=
"mdname1" valign=
"top" nowrap
> <em>pDev
</em> </td>
440 <td class=
"md" valign=
"top"> )
</td>
441 <td class=
"md" nowrap
></td>
448 <table cellspacing=
5 cellpadding=
0 border=
0>
456 Turn
<em>pDev
</em> on (i.e., take input from
<em>pDev
</em>).
</td>
459 <a class=
"anchor" name=
"a26" doxytag=
"dmxcommon.h::dmxCommonOthGetInfo" ></a><p>
460 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
463 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
465 <td class=
"md" nowrap
valign=
"top"> void dmxCommonOthGetInfo
</td>
466 <td class=
"md" valign=
"top">(
</td>
467 <td class=
"md" nowrap
valign=
"top">DevicePtr
</td>
468 <td class=
"mdname" nowrap
> <em>pDev
</em>,
</td>
473 <td class=
"md" nowrap
><a class=
"el" href=
"struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr
</a> </td>
474 <td class=
"mdname" nowrap
> <em>info
</em></td>
478 <td class=
"md">)
</td>
479 <td class=
"md" colspan=
"2"></td>
486 <table cellspacing=
5 cellpadding=
0 border=
0>
494 Fill the
<em>info
</em> structure with information needed to initialize
<em>pDev
</em>.
</td>
497 <a class=
"anchor" name=
"a25" doxytag=
"dmxcommon.h::dmxCommonOthOff" ></a><p>
498 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
501 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
503 <td class=
"md" nowrap
valign=
"top"> void dmxCommonOthOff
</td>
504 <td class=
"md" valign=
"top">(
</td>
505 <td class=
"md" nowrap
valign=
"top">DevicePtr
</td>
506 <td class=
"mdname1" valign=
"top" nowrap
> <em>pDev
</em> </td>
507 <td class=
"md" valign=
"top"> )
</td>
508 <td class=
"md" nowrap
></td>
515 <table cellspacing=
5 cellpadding=
0 border=
0>
523 Turn
<em>pDev
</em> off.
</td>
526 <a class=
"anchor" name=
"a24" doxytag=
"dmxcommon.h::dmxCommonOthOn" ></a><p>
527 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
530 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
532 <td class=
"md" nowrap
valign=
"top"> int dmxCommonOthOn
</td>
533 <td class=
"md" valign=
"top">(
</td>
534 <td class=
"md" nowrap
valign=
"top">DevicePtr
</td>
535 <td class=
"mdname1" valign=
"top" nowrap
> <em>pDev
</em> </td>
536 <td class=
"md" valign=
"top"> )
</td>
537 <td class=
"md" nowrap
></td>
544 <table cellspacing=
5 cellpadding=
0 border=
0>
552 Turn
<em>pDev
</em> on (i.e., take input from
<em>pDev
</em>).
</td>
555 <a class=
"anchor" name=
"a29" doxytag=
"dmxcommon.h::dmxCommonRestoreState" ></a><p>
556 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
559 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
561 <td class=
"md" nowrap
valign=
"top"> void dmxCommonRestoreState
</td>
562 <td class=
"md" valign=
"top">(
</td>
563 <td class=
"md" nowrap
valign=
"top">pointer
</td>
564 <td class=
"mdname1" valign=
"top" nowrap
> <em>private
</em> </td>
565 <td class=
"md" valign=
"top"> )
</td>
566 <td class=
"md" nowrap
></td>
573 <table cellspacing=
5 cellpadding=
0 border=
0>
581 This routine restores all the information saved by
<a class=
"el" href=
"dmxcommon_8h.html#a28">dmxCommonSaveState
</a>.
</td>
584 <a class=
"anchor" name=
"a28" doxytag=
"dmxcommon.h::dmxCommonSaveState" ></a><p>
585 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
588 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
590 <td class=
"md" nowrap
valign=
"top"> void dmxCommonSaveState
</td>
591 <td class=
"md" valign=
"top">(
</td>
592 <td class=
"md" nowrap
valign=
"top">pointer
</td>
593 <td class=
"mdname1" valign=
"top" nowrap
> <em>private
</em> </td>
594 <td class=
"md" valign=
"top"> )
</td>
595 <td class=
"md" nowrap
></td>
602 <table cellspacing=
5 cellpadding=
0 border=
0>
610 This routine saves and resets some important state for the backend and console device drivers:
<ul>
611 <li>the modifier map is saved and set to
0 (so DMX controls the LEDs)
</li><li>the key click, bell, led, and repeat masks are saved and set to the values that DMX claims to be using
</li></ul>
613 This routine and
<a class=
"el" href=
"dmxcommon_8h.html#a29">dmxCommonRestoreState
</a> are used when the pointer enters and leaves the console window, or when the backend window is active or not active (for a full-screen window, this only happens at server startup and server shutdown).
</td>
616 <a class=
"anchor" name=
"a23" doxytag=
"dmxcommon.h::dmxFindPointerScreen" ></a><p>
617 <table class=
"mdTable" width=
"100%" cellpadding=
"2" cellspacing=
"0">
620 <table cellpadding=
"0" cellspacing=
"0" border=
"0">
622 <td class=
"md" nowrap
valign=
"top"> int dmxFindPointerScreen
</td>
623 <td class=
"md" valign=
"top">(
</td>
624 <td class=
"md" nowrap
valign=
"top">int
</td>
625 <td class=
"mdname" nowrap
> <em>x
</em>,
</td>
630 <td class=
"md" nowrap
>int
</td>
631 <td class=
"mdname" nowrap
> <em>y
</em></td>
635 <td class=
"md">)
</td>
636 <td class=
"md" colspan=
"2"></td>
643 <table cellspacing=
5 cellpadding=
0 border=
0>
651 Given the global coordinates
<em>x
</em> and
<em>y
</em>, determine the screen with the lowest number on which those coordinates lie. If they are not on any screen, return -
1. The number returned is an index into #dmxScreenInfo and is between -
1 and
<a class=
"el" href=
"dmxinit_8c.html#a1">dmxNumScreens
</a> -
1, inclusive.
</td>
657 Generated June
29,
2004 for
<a
658 href=
"http://dmx.sourceforge.net">Distributed Multihead X
</a> by
659 <a href=
"http://www.doxygen.org/index.html">doxygen
</a>