First import
[xorg_rtime.git] / xorg-server-1.4 / hw / dmx / doc / html / dmx_8h.html
blobecdde319dce3115fb78357372d4ca6f6c65fe4ef
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>dmx.h File Reference</h1><code>#include "gcstruct.h"</code><br>
12 <code>#include "<a class="el" href="dmxclient_8h-source.html">dmxclient.h</a>"</code><br>
13 <code>#include "globals.h"</code><br>
14 <code>#include "scrnintstr.h"</code><br>
15 <code>#include "picturestr.h"</code><br>
17 <p>
18 <a href="dmx_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
19 <tr><td></td></tr>
20 <tr><td colspan=2><br><h2>Data Structures</h2></td></tr>
21 <tr><td class="memItemLeft" nowrap align=right valign=top>struct &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="struct__DMXScreenInfo.html">_DMXScreenInfo</a></td></tr>
23 <tr><td colspan=2><br><h2>Defines</h2></td></tr>
24 <tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a0">DMX_WRAP</a>(_entry, _newfunc, _saved, _actual)</td></tr>
26 <tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a1">DMX_UNWRAP</a>(_entry, _saved, _actual)</td></tr>
28 <tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
29 <tr><td class="memItemLeft" nowrap align=right valign=top>typedef <a class="el" href="struct__DMXInputInfo.html">_DMXInputInfo</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a2">DMXInputInfo</a></td></tr>
31 <tr><td class="memItemLeft" nowrap align=right valign=top>typedef <a class="el" href="struct__DMXStatInfo.html">_DMXStatInfo</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a3">DMXStatInfo</a></td></tr>
33 <tr><td class="memItemLeft" nowrap align=right valign=top>typedef <a class="el" href="struct__DMXScreenInfo.html">_DMXScreenInfo</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a4">DMXScreenInfo</a></td></tr>
35 <tr><td colspan=2><br><h2>Variables</h2></td></tr>
36 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a5">dmxNumScreens</a></td></tr>
38 <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="struct__DMXScreenInfo.html">DMXScreenInfo</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a6">dmxScreens</a></td></tr>
40 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a7">dmxShadowFB</a></td></tr>
42 <tr><td class="memItemLeft" nowrap align=right valign=top>XErrorEvent&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a8">dmxLastErrorEvent</a></td></tr>
44 <tr><td class="memItemLeft" nowrap align=right valign=top>Bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a9">dmxErrorOccurred</a></td></tr>
46 <tr><td class="memItemLeft" nowrap align=right valign=top>Bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a10">dmxOffScreenOpt</a></td></tr>
48 <tr><td class="memItemLeft" nowrap align=right valign=top>Bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a11">dmxSubdividePrimitives</a></td></tr>
50 <tr><td class="memItemLeft" nowrap align=right valign=top>Bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a12">dmxLazyWindowCreation</a></td></tr>
52 <tr><td class="memItemLeft" nowrap align=right valign=top>Bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a13">dmxUseXKB</a></td></tr>
54 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a14">dmxDepth</a></td></tr>
56 <tr><td class="memItemLeft" nowrap align=right valign=top>Bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a15">dmxNoRender</a></td></tr>
58 <tr><td class="memItemLeft" nowrap align=right valign=top>char *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a16">dmxFontPath</a></td></tr>
60 <tr><td class="memItemLeft" nowrap align=right valign=top>Bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a17">dmxIgnoreBadFontPaths</a></td></tr>
62 <tr><td class="memItemLeft" nowrap align=right valign=top>Bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmx_8h.html#a18">dmxAddRemoveScreens</a></td></tr>
64 </table>
65 <hr><a name="_details"></a><h2>Detailed Description</h2>
66 Main header file included by all other DMX-related files.<hr><h2>Define Documentation</h2>
67 <a class="anchor" name="a1" doxytag="dmx.h::DMX_UNWRAP" ></a><p>
68 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
69 <tr>
70 <td class="mdRow">
71 <table cellpadding="0" cellspacing="0" border="0">
72 <tr>
73 <td class="md" nowrap valign="top"> #define DMX_UNWRAP</td>
74 <td class="md" valign="top">(&nbsp;</td>
75 <td class="md" nowrap valign="top">_entry, <tr>
76 <td></td>
77 <td></td>
78 <td class="md" nowrap>_saved, <tr>
79 <td></td>
80 <td></td>
81 <td class="md" nowrap>_actual&nbsp;</td>
82 <td class="mdname1" valign="top" nowrap> </td>
83 <td class="md" valign="top">&nbsp;)&nbsp;</td>
84 <td class="md" nowrap>
85 </table>
86 </td>
87 </tr>
88 </table>
89 <table cellspacing=5 cellpadding=0 border=0>
90 <tr>
91 <td>
92 &nbsp;
93 </td>
94 <td>
96 <p>
97 <b>Value:</b><div class="fragment"><pre><span class="keywordflow">do</span> { \
98 (_actual)-&gt;_entry = (_saved)-&gt;_entry; \
99 } <span class="keywordflow">while</span> (0)
100 </pre></div>Unwrap screen or GC function pointer </td>
101 </tr>
102 </table>
103 <a class="anchor" name="a0" doxytag="dmx.h::DMX_WRAP" ></a><p>
104 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
105 <tr>
106 <td class="mdRow">
107 <table cellpadding="0" cellspacing="0" border="0">
108 <tr>
109 <td class="md" nowrap valign="top"> #define DMX_WRAP</td>
110 <td class="md" valign="top">(&nbsp;</td>
111 <td class="md" nowrap valign="top">_entry, <tr>
112 <td></td>
113 <td></td>
114 <td class="md" nowrap>_newfunc, <tr>
115 <td></td>
116 <td></td>
117 <td class="md" nowrap>_saved, <tr>
118 <td></td>
119 <td></td>
120 <td class="md" nowrap>_actual&nbsp;</td>
121 <td class="mdname1" valign="top" nowrap> </td>
122 <td class="md" valign="top">&nbsp;)&nbsp;</td>
123 <td class="md" nowrap>
124 </table>
125 </td>
126 </tr>
127 </table>
128 <table cellspacing=5 cellpadding=0 border=0>
129 <tr>
130 <td>
131 &nbsp;
132 </td>
133 <td>
136 <b>Value:</b><div class="fragment"><pre><span class="keywordflow">do</span> { \
137 (_saved)-&gt;_entry = (_actual)-&gt;_entry; \
138 (_actual)-&gt;_entry = (_newfunc); \
139 } <span class="keywordflow">while</span> (0)
140 </pre></div>Wrap screen or GC function pointer </td>
141 </tr>
142 </table>
143 <hr><h2>Typedef Documentation</h2>
144 <a class="anchor" name="a2" doxytag="dmx.h::DMXInputInfo" ></a><p>
145 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
146 <tr>
147 <td class="mdRow">
148 <table cellpadding="0" cellspacing="0" border="0">
149 <tr>
150 <td class="md" nowrap valign="top"> typedef struct <a class="el" href="struct__DMXInputInfo.html">_DMXInputInfo</a> <a class="el" href="struct__DMXInputInfo.html">DMXInputInfo</a>
151 </table>
152 </td>
153 </tr>
154 </table>
155 <table cellspacing=5 cellpadding=0 border=0>
156 <tr>
157 <td>
158 &nbsp;
159 </td>
160 <td>
163 Provide the typedef globally, but keep the contents opaque outside of the input routines. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="dmxinput_8h.html">dmxinput.h</a> </dd></dl>
164 </td>
165 </tr>
166 </table>
167 <a class="anchor" name="a4" doxytag="dmx.h::DMXScreenInfo" ></a><p>
168 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
169 <tr>
170 <td class="mdRow">
171 <table cellpadding="0" cellspacing="0" border="0">
172 <tr>
173 <td class="md" nowrap valign="top"> typedef struct <a class="el" href="struct__DMXScreenInfo.html">_DMXScreenInfo</a> <a class="el" href="struct__DMXScreenInfo.html">DMXScreenInfo</a>
174 </table>
175 </td>
176 </tr>
177 </table>
178 <table cellspacing=5 cellpadding=0 border=0>
179 <tr>
180 <td>
181 &nbsp;
182 </td>
183 <td>
186 Global structure containing information about each backend screen. </td>
187 </tr>
188 </table>
189 <a class="anchor" name="a3" doxytag="dmx.h::DMXStatInfo" ></a><p>
190 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
191 <tr>
192 <td class="mdRow">
193 <table cellpadding="0" cellspacing="0" border="0">
194 <tr>
195 <td class="md" nowrap valign="top"> typedef struct <a class="el" href="struct__DMXStatInfo.html">_DMXStatInfo</a> <a class="el" href="struct__DMXStatInfo.html">DMXStatInfo</a>
196 </table>
197 </td>
198 </tr>
199 </table>
200 <table cellspacing=5 cellpadding=0 border=0>
201 <tr>
202 <td>
203 &nbsp;
204 </td>
205 <td>
208 Provide the typedef globally, but keep the contents opaque outside of the XSync statistic routines. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="dmxstat_8c.html">dmxstat.c</a> </dd></dl>
209 </td>
210 </tr>
211 </table>
212 <hr><h2>Variable Documentation</h2>
213 <a class="anchor" name="a18" doxytag="dmx.h::dmxAddRemoveScreens" ></a><p>
214 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
215 <tr>
216 <td class="mdRow">
217 <table cellpadding="0" cellspacing="0" border="0">
218 <tr>
219 <td class="md" nowrap valign="top"> Bool <a class="el" href="dmxinit_8c.html#a17">dmxAddRemoveScreens</a>
220 </table>
221 </td>
222 </tr>
223 </table>
224 <table cellspacing=5 cellpadding=0 border=0>
225 <tr>
226 <td>
227 &nbsp;
228 </td>
229 <td>
232 True if add and remove screens support is enabled </td>
233 </tr>
234 </table>
235 <a class="anchor" name="a14" doxytag="dmx.h::dmxDepth" ></a><p>
236 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
237 <tr>
238 <td class="mdRow">
239 <table cellpadding="0" cellspacing="0" border="0">
240 <tr>
241 <td class="md" nowrap valign="top"> int <a class="el" href="dmxinit_8c.html#a13">dmxDepth</a>
242 </table>
243 </td>
244 </tr>
245 </table>
246 <table cellspacing=5 cellpadding=0 border=0>
247 <tr>
248 <td>
249 &nbsp;
250 </td>
251 <td>
254 Requested depth if non-zero </td>
255 </tr>
256 </table>
257 <a class="anchor" name="a9" doxytag="dmx.h::dmxErrorOccurred" ></a><p>
258 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
259 <tr>
260 <td class="mdRow">
261 <table cellpadding="0" cellspacing="0" border="0">
262 <tr>
263 <td class="md" nowrap valign="top"> Bool <a class="el" href="dmxinit_8c.html#a7">dmxErrorOccurred</a>
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>
276 True if an error occurred </td>
277 </tr>
278 </table>
279 <a class="anchor" name="a16" doxytag="dmx.h::dmxFontPath" ></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"> char* <a class="el" href="dmxinit_8c.html#a8">dmxFontPath</a>
286 </table>
287 </td>
288 </tr>
289 </table>
290 <table cellspacing=5 cellpadding=0 border=0>
291 <tr>
292 <td>
293 &nbsp;
294 </td>
295 <td>
298 NULL if no font path is set on the command line; otherwise, a string of comma separated paths built from the command line specified font paths </td>
299 </tr>
300 </table>
301 <a class="anchor" name="a17" doxytag="dmx.h::dmxIgnoreBadFontPaths" ></a><p>
302 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
303 <tr>
304 <td class="mdRow">
305 <table cellpadding="0" cellspacing="0" border="0">
306 <tr>
307 <td class="md" nowrap valign="top"> Bool <a class="el" href="dmxinit_8c.html#a16">dmxIgnoreBadFontPaths</a>
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>
320 True if bad font paths should be ignored during server init </td>
321 </tr>
322 </table>
323 <a class="anchor" name="a8" doxytag="dmx.h::dmxLastErrorEvent" ></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"> XErrorEvent <a class="el" href="dmxinit_8c.html#a6">dmxLastErrorEvent</a>
330 </table>
331 </td>
332 </tr>
333 </table>
334 <table cellspacing=5 cellpadding=0 border=0>
335 <tr>
336 <td>
337 &nbsp;
338 </td>
339 <td>
342 Last error that occurred </td>
343 </tr>
344 </table>
345 <a class="anchor" name="a12" doxytag="dmx.h::dmxLazyWindowCreation" ></a><p>
346 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
347 <tr>
348 <td class="mdRow">
349 <table cellpadding="0" cellspacing="0" border="0">
350 <tr>
351 <td class="md" nowrap valign="top"> Bool <a class="el" href="dmxinit_8c.html#a11">dmxLazyWindowCreation</a>
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>
364 True if using the lazy window creation optimization </td>
365 </tr>
366 </table>
367 <a class="anchor" name="a15" doxytag="dmx.h::dmxNoRender" ></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"> Bool <a class="el" href="dmxinit_8c.html#a14">dmxNoRender</a>
374 </table>
375 </td>
376 </tr>
377 </table>
378 <table cellspacing=5 cellpadding=0 border=0>
379 <tr>
380 <td>
381 &nbsp;
382 </td>
383 <td>
386 True if the RENDER extension should be disabled </td>
387 </tr>
388 </table>
389 <a class="anchor" name="a5" doxytag="dmx.h::dmxNumScreens" ></a><p>
390 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
391 <tr>
392 <td class="mdRow">
393 <table cellpadding="0" cellspacing="0" border="0">
394 <tr>
395 <td class="md" nowrap valign="top"> int <a class="el" href="dmxinit_8c.html#a1">dmxNumScreens</a>
396 </table>
397 </td>
398 </tr>
399 </table>
400 <table cellspacing=5 cellpadding=0 border=0>
401 <tr>
402 <td>
403 &nbsp;
404 </td>
405 <td>
408 Number of dmxScreens </td>
409 </tr>
410 </table>
411 <a class="anchor" name="a10" doxytag="dmx.h::dmxOffScreenOpt" ></a><p>
412 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
413 <tr>
414 <td class="mdRow">
415 <table cellpadding="0" cellspacing="0" border="0">
416 <tr>
417 <td class="md" nowrap valign="top"> Bool <a class="el" href="dmxinit_8c.html#a9">dmxOffScreenOpt</a>
418 </table>
419 </td>
420 </tr>
421 </table>
422 <table cellspacing=5 cellpadding=0 border=0>
423 <tr>
424 <td>
425 &nbsp;
426 </td>
427 <td>
430 True if using off screen optimizations </td>
431 </tr>
432 </table>
433 <a class="anchor" name="a6" doxytag="dmx.h::dmxScreens" ></a><p>
434 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
435 <tr>
436 <td class="mdRow">
437 <table cellpadding="0" cellspacing="0" border="0">
438 <tr>
439 <td class="md" nowrap valign="top"> <a class="el" href="struct__DMXScreenInfo.html">DMXScreenInfo</a>* <a class="el" href="dmxinit_8c.html#a2">dmxScreens</a>
440 </table>
441 </td>
442 </tr>
443 </table>
444 <table cellspacing=5 cellpadding=0 border=0>
445 <tr>
446 <td>
447 &nbsp;
448 </td>
449 <td>
452 List of outputs </td>
453 </tr>
454 </table>
455 <a class="anchor" name="a7" doxytag="dmx.h::dmxShadowFB" ></a><p>
456 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
457 <tr>
458 <td class="mdRow">
459 <table cellpadding="0" cellspacing="0" border="0">
460 <tr>
461 <td class="md" nowrap valign="top"> int <a class="el" href="dmxinit_8c.html#a5">dmxShadowFB</a>
462 </table>
463 </td>
464 </tr>
465 </table>
466 <table cellspacing=5 cellpadding=0 border=0>
467 <tr>
468 <td>
469 &nbsp;
470 </td>
471 <td>
474 Non-zero if using shadow frame-buffer (deprecated) </td>
475 </tr>
476 </table>
477 <a class="anchor" name="a11" doxytag="dmx.h::dmxSubdividePrimitives" ></a><p>
478 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
479 <tr>
480 <td class="mdRow">
481 <table cellpadding="0" cellspacing="0" border="0">
482 <tr>
483 <td class="md" nowrap valign="top"> Bool <a class="el" href="dmxinit_8c.html#a10">dmxSubdividePrimitives</a>
484 </table>
485 </td>
486 </tr>
487 </table>
488 <table cellspacing=5 cellpadding=0 border=0>
489 <tr>
490 <td>
491 &nbsp;
492 </td>
493 <td>
496 True if using the primitive subdivision optimization </td>
497 </tr>
498 </table>
499 <a class="anchor" name="a13" doxytag="dmx.h::dmxUseXKB" ></a><p>
500 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
501 <tr>
502 <td class="mdRow">
503 <table cellpadding="0" cellspacing="0" border="0">
504 <tr>
505 <td class="md" nowrap valign="top"> Bool <a class="el" href="dmxinit_8c.html#a12">dmxUseXKB</a>
506 </table>
507 </td>
508 </tr>
509 </table>
510 <table cellspacing=5 cellpadding=0 border=0>
511 <tr>
512 <td>
513 &nbsp;
514 </td>
515 <td>
518 True if the XKB extension should be used with the backend servers </td>
519 </tr>
520 </table>
521 <hr>
522 <address>
523 <small>
524 Generated June 29, 2004 for <a
525 href="http://dmx.sourceforge.net">Distributed Multihead X</a> by
526 <a href="http://www.doxygen.org/index.html">doxygen</a>
527 1.3.4.
528 </small>
529 </addres>
530 </hr>
531 </body>
532 </html>