First import
[xorg_rtime.git] / xorg-server-1.4 / hw / dmx / doc / html / dmxbackend_8c.html
blob1fde71a99d39aa8fb1f12e326c31a96683dc7aeb
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.c File Reference</h1><code>#include "<a class="el" href="dmxinputinit_8h-source.html">dmxinputinit.h</a>"</code><br>
12 <code>#include "<a class="el" href="dmxbackend_8h-source.html">dmxbackend.h</a>"</code><br>
13 <code>#include "<a class="el" href="dmxcommon_8h-source.html">dmxcommon.h</a>"</code><br>
14 <code>#include "<a class="el" href="dmxconsole_8h-source.html">dmxconsole.h</a>"</code><br>
15 <code>#include "<a class="el" href="dmxcursor_8h-source.html">dmxcursor.h</a>"</code><br>
16 <code>#include "<a class="el" href="dmxprop_8h-source.html">dmxprop.h</a>"</code><br>
17 <code>#include "<a class="el" href="dmxsync_8h-source.html">dmxsync.h</a>"</code><br>
18 <code>#include "<a class="el" href="dmxcb_8h-source.html">dmxcb.h</a>"</code><br>
19 <code>#include "<a class="el" href="dmxevents_8h-source.html">dmxevents.h</a>"</code><br>
20 <code>#include "<a class="el" href="ChkNotMaskEv_8h-source.html">ChkNotMaskEv.h</a>"</code><br>
21 <code>#include "inputstr.h"</code><br>
22 <code>#include "input.h"</code><br>
23 <code>#include "keysym.h"</code><br>
24 <code>#include "mipointer.h"</code><br>
25 <code>#include "scrnintstr.h"</code><br>
26 <code>#include "windowstr.h"</code><br>
27 <table border=0 cellpadding=0 cellspacing=0>
28 <tr><td></td></tr>
29 <tr><td colspan=2><br><h2>Data Structures</h2></td></tr>
30 <tr><td class="memItemLeft" nowrap align=right valign=top>struct &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="struct__myPrivate.html">_myPrivate</a></td></tr>
32 <tr><td colspan=2><br><h2>Functions</h2></td></tr>
33 <tr><td class="memItemLeft" nowrap align=right valign=top>pointer&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8c.html#a12">dmxBackendCreatePrivate</a> (DeviceIntPtr pDevice)</td></tr>
35 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8c.html#a13">dmxBackendDestroyPrivate</a> (pointer private)</td></tr>
37 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8c.html#a24">dmxBackendUpdatePosition</a> (pointer private, int x, int y)</td></tr>
39 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8c.html#a25">dmxBackendCollectEvents</a> (DevicePtr pDev, dmxMotionProcPtr motion, dmxEnqueueProcPtr enqueue, dmxCheckSpecialProcPtr checkspecial, DMXBlockType block)</td></tr>
41 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8c.html#a26">dmxBackendProcessInput</a> (pointer private)</td></tr>
43 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8c.html#a29">dmxBackendLateReInit</a> (DevicePtr pDev)</td></tr>
45 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8c.html#a30">dmxBackendInit</a> (DevicePtr pDev)</td></tr>
47 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8c.html#a31">dmxBackendMouGetInfo</a> (DevicePtr pDev, <a class="el" href="struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr</a> info)</td></tr>
49 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8c.html#a32">dmxBackendKbdGetInfo</a> (DevicePtr pDev, <a class="el" href="struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr</a> info)</td></tr>
51 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxbackend_8c.html#a33">dmxBackendFunctions</a> (pointer private, DMXFunctionType function)</td></tr>
53 </table>
54 <hr><a name="_details"></a><h2>Detailed Description</h2>
55 These routines support taking input from devices on the backend (output) displays. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="dmxcommon_8c.html">dmxcommon.c</a>.</dd></dl>
56 <hr><h2>Function Documentation</h2>
57 <a class="anchor" name="a25" doxytag="dmxbackend.c::dmxBackendCollectEvents" ></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 dmxBackendCollectEvents </td>
64 <td class="md" valign="top">(&nbsp;</td>
65 <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
66 <td class="mdname" nowrap> <em>pDev</em>, </td>
67 </tr>
68 <tr>
69 <td></td>
70 <td></td>
71 <td class="md" nowrap>dmxMotionProcPtr&nbsp;</td>
72 <td class="mdname" nowrap> <em>motion</em>, </td>
73 </tr>
74 <tr>
75 <td></td>
76 <td></td>
77 <td class="md" nowrap>dmxEnqueueProcPtr&nbsp;</td>
78 <td class="mdname" nowrap> <em>enqueue</em>, </td>
79 </tr>
80 <tr>
81 <td></td>
82 <td></td>
83 <td class="md" nowrap>dmxCheckSpecialProcPtr&nbsp;</td>
84 <td class="mdname" nowrap> <em>checkspecial</em>, </td>
85 </tr>
86 <tr>
87 <td></td>
88 <td></td>
89 <td class="md" nowrap>DMXBlockType&nbsp;</td>
90 <td class="mdname" nowrap> <em>block</em></td>
91 </tr>
92 <tr>
93 <td></td>
94 <td class="md">)&nbsp;</td>
95 <td class="md" colspan="2"></td>
96 </tr>
98 </table>
99 </td>
100 </tr>
101 </table>
102 <table cellspacing=5 cellpadding=0 border=0>
103 <tr>
104 <td>
105 &nbsp;
106 </td>
107 <td>
110 Get events from the X queue on the backend servers and put the events into the DMX event queue. </td>
111 </tr>
112 </table>
113 <a class="anchor" name="a12" doxytag="dmxbackend.c::dmxBackendCreatePrivate" ></a><p>
114 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
115 <tr>
116 <td class="mdRow">
117 <table cellpadding="0" cellspacing="0" border="0">
118 <tr>
119 <td class="md" nowrap valign="top"> pointer dmxBackendCreatePrivate </td>
120 <td class="md" valign="top">(&nbsp;</td>
121 <td class="md" nowrap valign="top">DeviceIntPtr&nbsp;</td>
122 <td class="mdname1" valign="top" nowrap> <em>pDevice</em> </td>
123 <td class="md" valign="top">&nbsp;)&nbsp;</td>
124 <td class="md" nowrap></td>
125 </tr>
127 </table>
128 </td>
129 </tr>
130 </table>
131 <table cellspacing=5 cellpadding=0 border=0>
132 <tr>
133 <td>
134 &nbsp;
135 </td>
136 <td>
139 Create and return a private data structure. </td>
140 </tr>
141 </table>
142 <a class="anchor" name="a13" doxytag="dmxbackend.c::dmxBackendDestroyPrivate" ></a><p>
143 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
144 <tr>
145 <td class="mdRow">
146 <table cellpadding="0" cellspacing="0" border="0">
147 <tr>
148 <td class="md" nowrap valign="top"> void dmxBackendDestroyPrivate </td>
149 <td class="md" valign="top">(&nbsp;</td>
150 <td class="md" nowrap valign="top">pointer&nbsp;</td>
151 <td class="mdname1" valign="top" nowrap> <em>private</em> </td>
152 <td class="md" valign="top">&nbsp;)&nbsp;</td>
153 <td class="md" nowrap></td>
154 </tr>
156 </table>
157 </td>
158 </tr>
159 </table>
160 <table cellspacing=5 cellpadding=0 border=0>
161 <tr>
162 <td>
163 &nbsp;
164 </td>
165 <td>
168 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>
169 </tr>
170 </table>
171 <a class="anchor" name="a33" doxytag="dmxbackend.c::dmxBackendFunctions" ></a><p>
172 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
173 <tr>
174 <td class="mdRow">
175 <table cellpadding="0" cellspacing="0" border="0">
176 <tr>
177 <td class="md" nowrap valign="top"> int dmxBackendFunctions </td>
178 <td class="md" valign="top">(&nbsp;</td>
179 <td class="md" nowrap valign="top">pointer&nbsp;</td>
180 <td class="mdname" nowrap> <em>private</em>, </td>
181 </tr>
182 <tr>
183 <td></td>
184 <td></td>
185 <td class="md" nowrap>DMXFunctionType&nbsp;</td>
186 <td class="mdname" nowrap> <em>function</em></td>
187 </tr>
188 <tr>
189 <td></td>
190 <td class="md">)&nbsp;</td>
191 <td class="md" colspan="2"></td>
192 </tr>
194 </table>
195 </td>
196 </tr>
197 </table>
198 <table cellspacing=5 cellpadding=0 border=0>
199 <tr>
200 <td>
201 &nbsp;
202 </td>
203 <td>
206 Process #DMXFunctionType functions. The only function handled here is to acknowledge a pending server shutdown. </td>
207 </tr>
208 </table>
209 <a class="anchor" name="a30" doxytag="dmxbackend.c::dmxBackendInit" ></a><p>
210 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
211 <tr>
212 <td class="mdRow">
213 <table cellpadding="0" cellspacing="0" border="0">
214 <tr>
215 <td class="md" nowrap valign="top"> void dmxBackendInit </td>
216 <td class="md" valign="top">(&nbsp;</td>
217 <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
218 <td class="mdname1" valign="top" nowrap> <em>pDev</em> </td>
219 <td class="md" valign="top">&nbsp;)&nbsp;</td>
220 <td class="md" nowrap></td>
221 </tr>
223 </table>
224 </td>
225 </tr>
226 </table>
227 <table cellspacing=5 cellpadding=0 border=0>
228 <tr>
229 <td>
230 &nbsp;
231 </td>
232 <td>
235 Initialized the backend device described by <em>pDev</em>. </td>
236 </tr>
237 </table>
238 <a class="anchor" name="a32" doxytag="dmxbackend.c::dmxBackendKbdGetInfo" ></a><p>
239 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
240 <tr>
241 <td class="mdRow">
242 <table cellpadding="0" cellspacing="0" border="0">
243 <tr>
244 <td class="md" nowrap valign="top"> void dmxBackendKbdGetInfo </td>
245 <td class="md" valign="top">(&nbsp;</td>
246 <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
247 <td class="mdname" nowrap> <em>pDev</em>, </td>
248 </tr>
249 <tr>
250 <td></td>
251 <td></td>
252 <td class="md" nowrap><a class="el" href="struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr</a>&nbsp;</td>
253 <td class="mdname" nowrap> <em>info</em></td>
254 </tr>
255 <tr>
256 <td></td>
257 <td class="md">)&nbsp;</td>
258 <td class="md" colspan="2"></td>
259 </tr>
261 </table>
262 </td>
263 </tr>
264 </table>
265 <table cellspacing=5 cellpadding=0 border=0>
266 <tr>
267 <td>
268 &nbsp;
269 </td>
270 <td>
273 Get information about the backend keyboard (for initialization). </td>
274 </tr>
275 </table>
276 <a class="anchor" name="a29" doxytag="dmxbackend.c::dmxBackendLateReInit" ></a><p>
277 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
278 <tr>
279 <td class="mdRow">
280 <table cellpadding="0" cellspacing="0" border="0">
281 <tr>
282 <td class="md" nowrap valign="top"> void dmxBackendLateReInit </td>
283 <td class="md" valign="top">(&nbsp;</td>
284 <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
285 <td class="mdname1" valign="top" nowrap> <em>pDev</em> </td>
286 <td class="md" valign="top">&nbsp;)&nbsp;</td>
287 <td class="md" nowrap></td>
288 </tr>
290 </table>
291 </td>
292 </tr>
293 </table>
294 <table cellspacing=5 cellpadding=0 border=0>
295 <tr>
296 <td>
297 &nbsp;
298 </td>
299 <td>
302 Re-initialized the backend device described by <em>pDev</em> (after a reconfig). </td>
303 </tr>
304 </table>
305 <a class="anchor" name="a31" doxytag="dmxbackend.c::dmxBackendMouGetInfo" ></a><p>
306 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
307 <tr>
308 <td class="mdRow">
309 <table cellpadding="0" cellspacing="0" border="0">
310 <tr>
311 <td class="md" nowrap valign="top"> void dmxBackendMouGetInfo </td>
312 <td class="md" valign="top">(&nbsp;</td>
313 <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
314 <td class="mdname" nowrap> <em>pDev</em>, </td>
315 </tr>
316 <tr>
317 <td></td>
318 <td></td>
319 <td class="md" nowrap><a class="el" href="struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr</a>&nbsp;</td>
320 <td class="mdname" nowrap> <em>info</em></td>
321 </tr>
322 <tr>
323 <td></td>
324 <td class="md">)&nbsp;</td>
325 <td class="md" colspan="2"></td>
326 </tr>
328 </table>
329 </td>
330 </tr>
331 </table>
332 <table cellspacing=5 cellpadding=0 border=0>
333 <tr>
334 <td>
335 &nbsp;
336 </td>
337 <td>
340 Get information about the backend pointer (for initialization). </td>
341 </tr>
342 </table>
343 <a class="anchor" name="a26" doxytag="dmxbackend.c::dmxBackendProcessInput" ></a><p>
344 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
345 <tr>
346 <td class="mdRow">
347 <table cellpadding="0" cellspacing="0" border="0">
348 <tr>
349 <td class="md" nowrap valign="top"> void dmxBackendProcessInput </td>
350 <td class="md" valign="top">(&nbsp;</td>
351 <td class="md" nowrap valign="top">pointer&nbsp;</td>
352 <td class="mdname1" valign="top" nowrap> <em>private</em> </td>
353 <td class="md" valign="top">&nbsp;)&nbsp;</td>
354 <td class="md" nowrap></td>
355 </tr>
357 </table>
358 </td>
359 </tr>
360 </table>
361 <table cellspacing=5 cellpadding=0 border=0>
362 <tr>
363 <td>
364 &nbsp;
365 </td>
366 <td>
369 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>
370 </tr>
371 </table>
372 <a class="anchor" name="a24" doxytag="dmxbackend.c::dmxBackendUpdatePosition" ></a><p>
373 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
374 <tr>
375 <td class="mdRow">
376 <table cellpadding="0" cellspacing="0" border="0">
377 <tr>
378 <td class="md" nowrap valign="top"> void dmxBackendUpdatePosition </td>
379 <td class="md" valign="top">(&nbsp;</td>
380 <td class="md" nowrap valign="top">pointer&nbsp;</td>
381 <td class="mdname" nowrap> <em>private</em>, </td>
382 </tr>
383 <tr>
384 <td></td>
385 <td></td>
386 <td class="md" nowrap>int&nbsp;</td>
387 <td class="mdname" nowrap> <em>x</em>, </td>
388 </tr>
389 <tr>
390 <td></td>
391 <td></td>
392 <td class="md" nowrap>int&nbsp;</td>
393 <td class="mdname" nowrap> <em>y</em></td>
394 </tr>
395 <tr>
396 <td></td>
397 <td class="md">)&nbsp;</td>
398 <td class="md" colspan="2"></td>
399 </tr>
401 </table>
402 </td>
403 </tr>
404 </table>
405 <table cellspacing=5 cellpadding=0 border=0>
406 <tr>
407 <td>
408 &nbsp;
409 </td>
410 <td>
413 This routine is called from #dmxCoreMotion for each motion event. #x and #y are global coordinants. </td>
414 </tr>
415 </table>
416 <hr>
417 <address>
418 <small>
419 Generated June 29, 2004 for <a
420 href="http://dmx.sourceforge.net">Distributed Multihead X</a> by
421 <a href="http://www.doxygen.org/index.html">doxygen</a>
422 1.3.4.
423 </small>
424 </addres>
425 </hr>
426 </body>
427 </html>