First import
[xorg_rtime.git] / xorg-server-1.4 / hw / dmx / doc / html / dmxextension_8c.html
blob6bcf8f1338f4fd3cfa56ebbd8a6a7589e9601f3a
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.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="dmxinit_8h-source.html">dmxinit.h</a>"</code><br>
13 <code>#include "<a class="el" href="dmxextension_8h-source.html">dmxextension.h</a>"</code><br>
14 <code>#include "<a class="el" href="dmxwindow_8h-source.html">dmxwindow.h</a>"</code><br>
15 <code>#include "<a class="el" href="dmxcb_8h-source.html">dmxcb.h</a>"</code><br>
16 <code>#include "<a class="el" href="dmxcursor_8h-source.html">dmxcursor.h</a>"</code><br>
17 <code>#include "<a class="el" href="dmxpixmap_8h-source.html">dmxpixmap.h</a>"</code><br>
18 <code>#include "<a class="el" href="dmxgc_8h-source.html">dmxgc.h</a>"</code><br>
19 <code>#include "<a class="el" href="dmxfont_8h-source.html">dmxfont.h</a>"</code><br>
20 <code>#include "<a class="el" href="dmxcmap_8h-source.html">dmxcmap.h</a>"</code><br>
21 <code>#include "<a class="el" href="dmxpict_8h-source.html">dmxpict.h</a>"</code><br>
22 <code>#include "<a class="el" href="dmxinput_8h-source.html">dmxinput.h</a>"</code><br>
23 <code>#include "<a class="el" href="dmxsync_8h-source.html">dmxsync.h</a>"</code><br>
24 <code>#include "<a class="el" href="dmxscrinit_8h-source.html">dmxscrinit.h</a>"</code><br>
25 <code>#include "<a class="el" href="dmxinputinit_8h-source.html">input/dmxinputinit.h</a>"</code><br>
26 <code>#include "windowstr.h"</code><br>
27 <code>#include "inputstr.h"</code><br>
28 <code>#include "<a class="el" href="dmxproto_8h-source.html">dmxproto.h</a>"</code><br>
29 <code>#include "cursorstr.h"</code><br>
30 <table border=0 cellpadding=0 cellspacing=0>
31 <tr><td></td></tr>
32 <tr><td colspan=2><br><h2>Functions</h2></td></tr>
33 <tr><td class="memItemLeft" nowrap align=right valign=top>Bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8c.html#a1">dmxGetScreenAttributes</a> (int physical, DMXScreenAttributesPtr attr)</td></tr>
35 <tr><td class="memItemLeft" nowrap align=right valign=top>Bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8c.html#a2">dmxGetWindowAttributes</a> (WindowPtr pWindow, DMXWindowAttributesPtr attr)</td></tr>
37 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8c.html#a4">dmxGetInputCount</a> (void)</td></tr>
39 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8c.html#a5">dmxGetInputAttributes</a> (int deviceId, DMXInputAttributesPtr attr)</td></tr>
41 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8c.html#a7">dmxAddInput</a> (DMXInputAttributesPtr attr, int *id)</td></tr>
43 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8c.html#a8">dmxRemoveInput</a> (int id)</td></tr>
45 <tr><td class="memItemLeft" nowrap align=right valign=top>unsigned long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8c.html#a9">dmxGetNumScreens</a> (void)</td></tr>
47 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8c.html#a10">dmxForceWindowCreation</a> (WindowPtr pWindow)</td></tr>
49 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8c.html#a11">dmxFlushPendingSyncs</a> (void)</td></tr>
51 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8c.html#a18">dmxAttachScreen</a> (int idx, DMXScreenAttributesPtr attr)</td></tr>
53 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxextension_8c.html#a23">dmxDetachScreen</a> (int idx)</td></tr>
55 </table>
56 <hr><a name="_details"></a><h2>Detailed Description</h2>
57 This file provides the only interface to the X server extension support in programs/Xserver/Xext. Those programs should only include <a class="el" href="dmxext_8h.html">dmxext.h</a><hr><h2>Function Documentation</h2>
58 <a class="anchor" name="a7" doxytag="dmxextension.c::dmxAddInput" ></a><p>
59 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
60 <tr>
61 <td class="mdRow">
62 <table cellpadding="0" cellspacing="0" border="0">
63 <tr>
64 <td class="md" nowrap valign="top"> int dmxAddInput </td>
65 <td class="md" valign="top">(&nbsp;</td>
66 <td class="md" nowrap valign="top">DMXInputAttributesPtr&nbsp;</td>
67 <td class="mdname" nowrap> <em>attr</em>, </td>
68 </tr>
69 <tr>
70 <td></td>
71 <td></td>
72 <td class="md" nowrap>int *&nbsp;</td>
73 <td class="mdname" nowrap> <em>id</em></td>
74 </tr>
75 <tr>
76 <td></td>
77 <td class="md">)&nbsp;</td>
78 <td class="md" colspan="2"></td>
79 </tr>
81 </table>
82 </td>
83 </tr>
84 </table>
85 <table cellspacing=5 cellpadding=0 border=0>
86 <tr>
87 <td>
88 &nbsp;
89 </td>
90 <td>
92 <p>
93 Add an input with the specified attributes. If the input is added, the physical id is returned in <em>deviceId</em>. </td>
94 </tr>
95 </table>
96 <a class="anchor" name="a18" doxytag="dmxextension.c::dmxAttachScreen" ></a><p>
97 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
98 <tr>
99 <td class="mdRow">
100 <table cellpadding="0" cellspacing="0" border="0">
101 <tr>
102 <td class="md" nowrap valign="top"> int dmxAttachScreen </td>
103 <td class="md" valign="top">(&nbsp;</td>
104 <td class="md" nowrap valign="top">int&nbsp;</td>
105 <td class="mdname" nowrap> <em>idx</em>, </td>
106 </tr>
107 <tr>
108 <td></td>
109 <td></td>
110 <td class="md" nowrap>DMXScreenAttributesPtr&nbsp;</td>
111 <td class="mdname" nowrap> <em>attr</em></td>
112 </tr>
113 <tr>
114 <td></td>
115 <td class="md">)&nbsp;</td>
116 <td class="md" colspan="2"></td>
117 </tr>
119 </table>
120 </td>
121 </tr>
122 </table>
123 <table cellspacing=5 cellpadding=0 border=0>
124 <tr>
125 <td>
126 &nbsp;
127 </td>
128 <td>
131 Reattach previously detached back-end screen. </td>
132 </tr>
133 </table>
134 <a class="anchor" name="a23" doxytag="dmxextension.c::dmxDetachScreen" ></a><p>
135 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
136 <tr>
137 <td class="mdRow">
138 <table cellpadding="0" cellspacing="0" border="0">
139 <tr>
140 <td class="md" nowrap valign="top"> int dmxDetachScreen </td>
141 <td class="md" valign="top">(&nbsp;</td>
142 <td class="md" nowrap valign="top">int&nbsp;</td>
143 <td class="mdname1" valign="top" nowrap> <em>idx</em> </td>
144 <td class="md" valign="top">&nbsp;)&nbsp;</td>
145 <td class="md" nowrap></td>
146 </tr>
148 </table>
149 </td>
150 </tr>
151 </table>
152 <table cellspacing=5 cellpadding=0 border=0>
153 <tr>
154 <td>
155 &nbsp;
156 </td>
157 <td>
160 Detach back-end screen. </td>
161 </tr>
162 </table>
163 <a class="anchor" name="a11" doxytag="dmxextension.c::dmxFlushPendingSyncs" ></a><p>
164 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
165 <tr>
166 <td class="mdRow">
167 <table cellpadding="0" cellspacing="0" border="0">
168 <tr>
169 <td class="md" nowrap valign="top"> void dmxFlushPendingSyncs </td>
170 <td class="md" valign="top">(&nbsp;</td>
171 <td class="md" nowrap valign="top">void&nbsp;</td>
172 <td class="mdname1" valign="top" nowrap> </td>
173 <td class="md" valign="top">&nbsp;)&nbsp;</td>
174 <td class="md" nowrap></td>
175 </tr>
177 </table>
178 </td>
179 </tr>
180 </table>
181 <table cellspacing=5 cellpadding=0 border=0>
182 <tr>
183 <td>
184 &nbsp;
185 </td>
186 <td>
189 Flush pending syncs for all screens. </td>
190 </tr>
191 </table>
192 <a class="anchor" name="a10" doxytag="dmxextension.c::dmxForceWindowCreation" ></a><p>
193 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
194 <tr>
195 <td class="mdRow">
196 <table cellpadding="0" cellspacing="0" border="0">
197 <tr>
198 <td class="md" nowrap valign="top"> void dmxForceWindowCreation </td>
199 <td class="md" valign="top">(&nbsp;</td>
200 <td class="md" nowrap valign="top">WindowPtr&nbsp;</td>
201 <td class="mdname1" valign="top" nowrap> <em>pWindow</em> </td>
202 <td class="md" valign="top">&nbsp;)&nbsp;</td>
203 <td class="md" nowrap></td>
204 </tr>
206 </table>
207 </td>
208 </tr>
209 </table>
210 <table cellspacing=5 cellpadding=0 border=0>
211 <tr>
212 <td>
213 &nbsp;
214 </td>
215 <td>
218 Make sure that <a class="el" href="dmxwindow_8h.html#a14">dmxCreateAndRealizeWindow</a> has been called for <em>pWindow</em>. </td>
219 </tr>
220 </table>
221 <a class="anchor" name="a5" doxytag="dmxextension.c::dmxGetInputAttributes" ></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"> int dmxGetInputAttributes </td>
228 <td class="md" valign="top">(&nbsp;</td>
229 <td class="md" nowrap valign="top">int&nbsp;</td>
230 <td class="mdname" nowrap> <em>deviceId</em>, </td>
231 </tr>
232 <tr>
233 <td></td>
234 <td></td>
235 <td class="md" nowrap>DMXInputAttributesPtr&nbsp;</td>
236 <td class="mdname" nowrap> <em>attr</em></td>
237 </tr>
238 <tr>
239 <td></td>
240 <td class="md">)&nbsp;</td>
241 <td class="md" colspan="2"></td>
242 </tr>
244 </table>
245 </td>
246 </tr>
247 </table>
248 <table cellspacing=5 cellpadding=0 border=0>
249 <tr>
250 <td>
251 &nbsp;
252 </td>
253 <td>
256 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>
257 </tr>
258 </table>
259 <a class="anchor" name="a4" doxytag="dmxextension.c::dmxGetInputCount" ></a><p>
260 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
261 <tr>
262 <td class="mdRow">
263 <table cellpadding="0" cellspacing="0" border="0">
264 <tr>
265 <td class="md" nowrap valign="top"> int dmxGetInputCount </td>
266 <td class="md" valign="top">(&nbsp;</td>
267 <td class="md" nowrap valign="top">void&nbsp;</td>
268 <td class="mdname1" valign="top" nowrap> </td>
269 <td class="md" valign="top">&nbsp;)&nbsp;</td>
270 <td class="md" nowrap></td>
271 </tr>
273 </table>
274 </td>
275 </tr>
276 </table>
277 <table cellspacing=5 cellpadding=0 border=0>
278 <tr>
279 <td>
280 &nbsp;
281 </td>
282 <td>
285 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>
286 </tr>
287 </table>
288 <a class="anchor" name="a9" doxytag="dmxextension.c::dmxGetNumScreens" ></a><p>
289 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
290 <tr>
291 <td class="mdRow">
292 <table cellpadding="0" cellspacing="0" border="0">
293 <tr>
294 <td class="md" nowrap valign="top"> unsigned long dmxGetNumScreens </td>
295 <td class="md" valign="top">(&nbsp;</td>
296 <td class="md" nowrap valign="top">void&nbsp;</td>
297 <td class="mdname1" valign="top" nowrap> </td>
298 <td class="md" valign="top">&nbsp;)&nbsp;</td>
299 <td class="md" nowrap></td>
300 </tr>
302 </table>
303 </td>
304 </tr>
305 </table>
306 <table cellspacing=5 cellpadding=0 border=0>
307 <tr>
308 <td>
309 &nbsp;
310 </td>
311 <td>
314 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>
315 </tr>
316 </table>
317 <a class="anchor" name="a1" doxytag="dmxextension.c::dmxGetScreenAttributes" ></a><p>
318 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
319 <tr>
320 <td class="mdRow">
321 <table cellpadding="0" cellspacing="0" border="0">
322 <tr>
323 <td class="md" nowrap valign="top"> Bool dmxGetScreenAttributes </td>
324 <td class="md" valign="top">(&nbsp;</td>
325 <td class="md" nowrap valign="top">int&nbsp;</td>
326 <td class="mdname" nowrap> <em>physical</em>, </td>
327 </tr>
328 <tr>
329 <td></td>
330 <td></td>
331 <td class="md" nowrap>DMXScreenAttributesPtr&nbsp;</td>
332 <td class="mdname" nowrap> <em>attr</em></td>
333 </tr>
334 <tr>
335 <td></td>
336 <td class="md">)&nbsp;</td>
337 <td class="md" colspan="2"></td>
338 </tr>
340 </table>
341 </td>
342 </tr>
343 </table>
344 <table cellspacing=5 cellpadding=0 border=0>
345 <tr>
346 <td>
347 &nbsp;
348 </td>
349 <td>
352 This routine provides information to the DMX protocol extension about a particular screen. </td>
353 </tr>
354 </table>
355 <a class="anchor" name="a2" doxytag="dmxextension.c::dmxGetWindowAttributes" ></a><p>
356 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
357 <tr>
358 <td class="mdRow">
359 <table cellpadding="0" cellspacing="0" border="0">
360 <tr>
361 <td class="md" nowrap valign="top"> Bool dmxGetWindowAttributes </td>
362 <td class="md" valign="top">(&nbsp;</td>
363 <td class="md" nowrap valign="top">WindowPtr&nbsp;</td>
364 <td class="mdname" nowrap> <em>pWindow</em>, </td>
365 </tr>
366 <tr>
367 <td></td>
368 <td></td>
369 <td class="md" nowrap>DMXWindowAttributesPtr&nbsp;</td>
370 <td class="mdname" nowrap> <em>attr</em></td>
371 </tr>
372 <tr>
373 <td></td>
374 <td class="md">)&nbsp;</td>
375 <td class="md" colspan="2"></td>
376 </tr>
378 </table>
379 </td>
380 </tr>
381 </table>
382 <table cellspacing=5 cellpadding=0 border=0>
383 <tr>
384 <td>
385 &nbsp;
386 </td>
387 <td>
390 This routine provides information to the DMX protocol extension about a particular window. </td>
391 </tr>
392 </table>
393 <a class="anchor" name="a8" doxytag="dmxextension.c::dmxRemoveInput" ></a><p>
394 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
395 <tr>
396 <td class="mdRow">
397 <table cellpadding="0" cellspacing="0" border="0">
398 <tr>
399 <td class="md" nowrap valign="top"> int dmxRemoveInput </td>
400 <td class="md" valign="top">(&nbsp;</td>
401 <td class="md" nowrap valign="top">int&nbsp;</td>
402 <td class="mdname1" valign="top" nowrap> <em>id</em> </td>
403 <td class="md" valign="top">&nbsp;)&nbsp;</td>
404 <td class="md" nowrap></td>
405 </tr>
407 </table>
408 </td>
409 </tr>
410 </table>
411 <table cellspacing=5 cellpadding=0 border=0>
412 <tr>
413 <td>
414 &nbsp;
415 </td>
416 <td>
419 Remove the input with physical id <em>id</em>. </td>
420 </tr>
421 </table>
422 <hr>
423 <address>
424 <small>
425 Generated June 29, 2004 for <a
426 href="http://dmx.sourceforge.net">Distributed Multihead X</a> by
427 <a href="http://www.doxygen.org/index.html">doxygen</a>
428 1.3.4.
429 </small>
430 </addres>
431 </hr>
432 </body>
433 </html>