SDL-1.2.14
[sdl_omap.git] / docs / html / sdlenvvars.html
1 <HTML
2 ><HEAD
3 ><TITLE
4 >SDL_envvars</TITLE
5 ><META
6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8 "><LINK
9 REL="HOME"
10 TITLE="SDL Library Documentation"
11 HREF="index.html"><LINK
12 REL="UP"
13 TITLE="General"
14 HREF="general.html"><LINK
15 REL="PREVIOUS"
16 TITLE="SDL_GetError"
17 HREF="sdlgeterror.html"><LINK
18 REL="NEXT"
19 TITLE="Video"
20 HREF="video.html"></HEAD
21 ><BODY
22 CLASS="REFENTRY"
23 BGCOLOR="#FFF8DC"
24 TEXT="#000000"
25 LINK="#0000ee"
26 VLINK="#551a8b"
27 ALINK="#ff0000"
28 ><DIV
29 CLASS="NAVHEADER"
30 ><TABLE
31 SUMMARY="Header navigation table"
32 WIDTH="100%"
33 BORDER="0"
34 CELLPADDING="0"
35 CELLSPACING="0"
36 ><TR
37 ><TH
38 COLSPAN="3"
39 ALIGN="center"
40 >SDL Library Documentation</TH
41 ></TR
42 ><TR
43 ><TD
44 WIDTH="10%"
45 ALIGN="left"
46 VALIGN="bottom"
47 ><A
48 HREF="sdlgeterror.html"
49 ACCESSKEY="P"
50 >Prev</A
51 ></TD
52 ><TD
53 WIDTH="80%"
54 ALIGN="center"
55 VALIGN="bottom"
56 ></TD
57 ><TD
58 WIDTH="10%"
59 ALIGN="right"
60 VALIGN="bottom"
61 ><A
62 HREF="video.html"
63 ACCESSKEY="N"
64 >Next</A
65 ></TD
66 ></TR
67 ></TABLE
68 ><HR
69 ALIGN="LEFT"
70 WIDTH="100%"></DIV
71 ><H1
72 ><A
73 NAME="SDLENVVARS"
74 ></A
75 >SDL_envvars</H1
76 ><DIV
77 CLASS="REFNAMEDIV"
78 ><A
79 NAME="AEN675"
80 ></A
81 ><H2
82 >Name</H2
83 >SDL_envvars&nbsp;--&nbsp;SDL environment variables</DIV
84 ><DIV
85 CLASS="REFSECT1"
86 ><A
87 NAME="AEN678"
88 ></A
89 ><H2
90 >Description</H2
91 ><P
92 >Not a function, set using setenv()</P
93 ><P
94 >Several environment variables are available to modify the
95 behaviour of SDL. Using these variables isn't recommened and the names
96 and presence of these variables aren't guaranteed from one release to
97 the next. However, they can be very useful for debugging
98 purposes.</P
99 ></DIV
100 ><DIV
101 CLASS="REFSECT1"
102 ><A
103 NAME="AEN682"
104 ></A
105 ><H2
106 >Video</H2
107 ><P
108 ></P
109 ><DIV
110 CLASS="VARIABLELIST"
111 ><DL
112 ><DT
113 ><TT
114 CLASS="LITERAL"
115 >SDL_FBACCEL</TT
116 ></DT
117 ><DD
118 ><P
119 >If set to 0, disable hardware acceleration in the linux fbcon driver.</P
120 ></DD
121 ><DT
122 ><TT
123 CLASS="LITERAL"
124 >SDL_FBDEV</TT
125 ></DT
126 ><DD
127 ><P
128 >Frame buffer device to use in the linux fbcon driver, instead of /dev/fb0</P
129 ></DD
130 ><DT
131 ><TT
132 CLASS="LITERAL"
133 >SDL_FULLSCREEN_UPDATE</TT
134 ></DT
135 ><DD
136 ><P
137 >In the ps2gs driver, sets the <TT
138 CLASS="LITERAL"
139 >SDL_ASYNCBLIT</TT
140 > flag on the
141 display surface.</P
142 ></DD
143 ><DT
144 ><TT
145 CLASS="LITERAL"
146 >SDL_VIDEODRIVER</TT
147 ></DT
148 ><DD
149 ><P
150 >Selectes the video driver for SDL to use. Possible values, in the
151 order they are tried if this variable is not set:</P
152 ><DIV
153 CLASS="INFORMALTABLE"
154 ><A
155 NAME="AEN706"
156 ></A
157 ><P
158 ></P
159 ><TABLE
160 BORDER="0"
161 CLASS="CALSTABLE"
162 ><TBODY
163 ><TR
164 ><TD
165 ALIGN="LEFT"
166 VALIGN="TOP"
167 ><TT
168 CLASS="LITERAL"
169 >x11</TT
170 ></TD
171 ><TD
172 ALIGN="LEFT"
173 VALIGN="TOP"
174 ><P
175 ></P
176 ></TD
177 ></TR
178 ><TR
179 ><TD
180 ALIGN="LEFT"
181 VALIGN="TOP"
182 ><TT
183 CLASS="LITERAL"
184 >dga</TT
185 ></TD
186 ><TD
187 ALIGN="LEFT"
188 VALIGN="TOP"
189 ><P
190 >(the XFree86 DGA2)</P
191 ></TD
192 ></TR
193 ><TR
194 ><TD
195 ALIGN="LEFT"
196 VALIGN="TOP"
197 ><TT
198 CLASS="LITERAL"
199 >nanox</TT
200 ></TD
201 ><TD
202 ALIGN="LEFT"
203 VALIGN="TOP"
204 ><P
205 >(Linux)</P
206 ></TD
207 ></TR
208 ><TR
209 ><TD
210 ALIGN="LEFT"
211 VALIGN="TOP"
212 ><TT
213 CLASS="LITERAL"
214 >fbcon</TT
215 ></TD
216 ><TD
217 ALIGN="LEFT"
218 VALIGN="TOP"
219 ><P
220 >(Linux)</P
221 ></TD
222 ></TR
223 ><TR
224 ><TD
225 ALIGN="LEFT"
226 VALIGN="TOP"
227 ><TT
228 CLASS="LITERAL"
229 >directfb</TT
230 ></TD
231 ><TD
232 ALIGN="LEFT"
233 VALIGN="TOP"
234 ><P
235 >(Linux)</P
236 ></TD
237 ></TR
238 ><TR
239 ><TD
240 ALIGN="LEFT"
241 VALIGN="TOP"
242 ><TT
243 CLASS="LITERAL"
244 >ps2gs</TT
245 ></TD
246 ><TD
247 ALIGN="LEFT"
248 VALIGN="TOP"
249 ><P
250 >(Playstation 2)</P
251 ></TD
252 ></TR
253 ><TR
254 ><TD
255 ALIGN="LEFT"
256 VALIGN="TOP"
257 ><TT
258 CLASS="LITERAL"
259 >ggi</TT
260 ></TD
261 ><TD
262 ALIGN="LEFT"
263 VALIGN="TOP"
264 ><P
265 ></P
266 ></TD
267 ></TR
268 ><TR
269 ><TD
270 ALIGN="LEFT"
271 VALIGN="TOP"
272 ><TT
273 CLASS="LITERAL"
274 >vgl</TT
275 ></TD
276 ><TD
277 ALIGN="LEFT"
278 VALIGN="TOP"
279 ><P
280 >(BSD)</P
281 ></TD
282 ></TR
283 ><TR
284 ><TD
285 ALIGN="LEFT"
286 VALIGN="TOP"
287 ><TT
288 CLASS="LITERAL"
289 >svgalib</TT
290 ></TD
291 ><TD
292 ALIGN="LEFT"
293 VALIGN="TOP"
294 ><P
295 >(Linux)</P
296 ></TD
297 ></TR
298 ><TR
299 ><TD
300 ALIGN="LEFT"
301 VALIGN="TOP"
302 ><TT
303 CLASS="LITERAL"
304 >aalib</TT
305 ></TD
306 ><TD
307 ALIGN="LEFT"
308 VALIGN="TOP"
309 ><P
310 ></P
311 ></TD
312 ></TR
313 ><TR
314 ><TD
315 ALIGN="LEFT"
316 VALIGN="TOP"
317 ><TT
318 CLASS="LITERAL"
319 >directx</TT
320 ></TD
321 ><TD
322 ALIGN="LEFT"
323 VALIGN="TOP"
324 ><P
325 >(Win32)</P
326 ></TD
327 ></TR
328 ><TR
329 ><TD
330 ALIGN="LEFT"
331 VALIGN="TOP"
332 ><TT
333 CLASS="LITERAL"
334 >windib</TT
335 ></TD
336 ><TD
337 ALIGN="LEFT"
338 VALIGN="TOP"
339 ><P
340 >(Win32)</P
341 ></TD
342 ></TR
343 ><TR
344 ><TD
345 ALIGN="LEFT"
346 VALIGN="TOP"
347 ><TT
348 CLASS="LITERAL"
349 >bwindow</TT
350 ></TD
351 ><TD
352 ALIGN="LEFT"
353 VALIGN="TOP"
354 ><P
355 >(BeOS)</P
356 ></TD
357 ></TR
358 ><TR
359 ><TD
360 ALIGN="LEFT"
361 VALIGN="TOP"
362 ><TT
363 CLASS="LITERAL"
364 >toolbox</TT
365 ></TD
366 ><TD
367 ALIGN="LEFT"
368 VALIGN="TOP"
369 ><P
370 >(MacOS Classic)</P
371 ></TD
372 ></TR
373 ><TR
374 ><TD
375 ALIGN="LEFT"
376 VALIGN="TOP"
377 ><TT
378 CLASS="LITERAL"
379 >DSp</TT
380 ></TD
381 ><TD
382 ALIGN="LEFT"
383 VALIGN="TOP"
384 ><P
385 >(MacOS Classic)</P
386 ></TD
387 ></TR
388 ><TR
389 ><TD
390 ALIGN="LEFT"
391 VALIGN="TOP"
392 ><TT
393 CLASS="LITERAL"
394 >Quartz</TT
395 ></TD
396 ><TD
397 ALIGN="LEFT"
398 VALIGN="TOP"
399 ><P
400 >(Mac OS X)</P
401 ></TD
402 ></TR
403 ><TR
404 ><TD
405 ALIGN="LEFT"
406 VALIGN="TOP"
407 ><TT
408 CLASS="LITERAL"
409 >CGX</TT
410 ></TD
411 ><TD
412 ALIGN="LEFT"
413 VALIGN="TOP"
414 ><P
415 >(Amiga)</P
416 ></TD
417 ></TR
418 ><TR
419 ><TD
420 ALIGN="LEFT"
421 VALIGN="TOP"
422 ><TT
423 CLASS="LITERAL"
424 >photon</TT
425 ></TD
426 ><TD
427 ALIGN="LEFT"
428 VALIGN="TOP"
429 ><P
430 >(QNX)</P
431 ></TD
432 ></TR
433 ><TR
434 ><TD
435 ALIGN="LEFT"
436 VALIGN="TOP"
437 ><TT
438 CLASS="LITERAL"
439 >dummy</TT
440 ></TD
441 ><TD
442 ALIGN="LEFT"
443 VALIGN="TOP"
444 ><P
445 ></P
446 ></TD
447 ></TR
448 ></TBODY
449 ></TABLE
450 ><P
451 ></P
452 ></DIV
453 ></DD
454 ><DT
455 ><TT
456 CLASS="LITERAL"
457 >SDL_VIDEO_CENTERED</TT
458 ></DT
459 ><DD
460 ><P
461 >If set, tries to center the SDL window when running in X11 windowed
462 mode, or using the CyberGrafix driver.</P
463 ></DD
464 ><DT
465 ><TT
466 CLASS="LITERAL"
467 >SDL_VIDEO_GL_DRIVER</TT
468 ></DT
469 ><DD
470 ><P
471 >The openGL driver (shared library) to use for X11. Default is libGL.so.1</P
472 ></DD
473 ><DT
474 ><TT
475 CLASS="LITERAL"
476 >SDL_VIDEO_X11_DGAMOUSE</TT
477 ></DT
478 ><DD
479 ><P
480 >With XFree86, enables use of DGA mouse if set.</P
481 ></DD
482 ><DT
483 ><TT
484 CLASS="LITERAL"
485 >SDL_VIDEO_X11_MOUSEACCEL</TT
486 ></DT
487 ><DD
488 ><P
489 >For X11, sets the mouse acceleration. The value should be a string
490 on the form:</P
491 ><P
492 >"<TT
493 CLASS="PARAMETER"
494 ><I
495 >n</I
496 ></TT
497 >/<TT
498 CLASS="PARAMETER"
499 ><I
500 >d</I
501 ></TT
502 >/<TT
503 CLASS="PARAMETER"
504 ><I
505 >t</I
506 ></TT
507 >"</P
508 ><P
509 >where <TT
510 CLASS="PARAMETER"
511 ><I
512 >n</I
513 ></TT
514 > and <TT
515 CLASS="PARAMETER"
516 ><I
517 >d</I
518 ></TT
519 > are the
520 acceleration numerator/denumerators (so mouse movement is accelerated by
521 <TT
522 CLASS="PARAMETER"
523 ><I
524 >n</I
525 ></TT
526 >/<TT
527 CLASS="PARAMETER"
528 ><I
529 >d</I
530 ></TT
531 >), and
532 <TT
533 CLASS="PARAMETER"
534 ><I
535 >t</I
536 ></TT
537 > is the threshold above which acceleration applies
538 (counted as number of pixels the mouse moves at once).</P
539 ></DD
540 ><DT
541 ><TT
542 CLASS="LITERAL"
543 >SDL_VIDEO_X11_NODIRECTCOLOR</TT
544 ></DT
545 ><DD
546 ><P
547 >If set, don't attempt to use DirectColor visuals even if they are
548 present. (SDL will use them otherwise for gamma correction).
549 This is needed with older X servers when using the XVideo extension.</P
550 ></DD
551 ><DT
552 ><TT
553 CLASS="LITERAL"
554 >SDL_VIDEO_X11_VISUALID</TT
555 ></DT
556 ><DD
557 ><P
558 >ID of an X11 visual to use, overriding SDL's default visual selection
559 algorithm. It can be in decimal or in hex (prefixed by 0x).</P
560 ></DD
561 ><DT
562 ><TT
563 CLASS="LITERAL"
564 >SDL_VIDEO_YUV_DIRECT</TT
565 ></DT
566 ><DD
567 ><P
568 >If set, display YUV overlay directly on the video surface if possible,
569 instead of on the surface passed to
570 <A
571 HREF="sdlcreateyuvoverlay.html"
572 ><TT
573 CLASS="FUNCTION"
574 >SDL_CreateYUVOverlay</TT
575 ></A
576 >.</P
577 ></DD
578 ><DT
579 ><TT
580 CLASS="LITERAL"
581 >SDL_VIDEO_YUV_HWACCEL</TT
582 ></DT
583 ><DD
584 ><P
585 >If not set or set to a nonzero value, SDL will attempt to use
586 hardware YUV acceleration for video playback.</P
587 ></DD
588 ><DT
589 ><TT
590 CLASS="LITERAL"
591 >SDL_WINDOWID</TT
592 ></DT
593 ><DD
594 ><P
595 >For X11 or Win32, contains the ID number of the window to be used by
596 SDL instead of creating its own window. Either in decimal or
597 in hex (prefixed by 0x).</P
598 ></DD
599 ></DL
600 ></DIV
601 ></DIV
602 ><DIV
603 CLASS="REFSECT1"
604 ><A
605 NAME="AEN866"
606 ></A
607 ><H2
608 >Events/Input</H2
609 ><P
610 ></P
611 ><DIV
612 CLASS="VARIABLELIST"
613 ><DL
614 ><DT
615 ><TT
616 CLASS="LITERAL"
617 >SDL_MOUSE_RELATIVE</TT
618 ></DT
619 ><DD
620 ><P
621 >If set to 0, do not use mouse relative mode in X11. The default is
622 to use it if the mouse is hidden and input is grabbed.</P
623 ></DD
624 ><DT
625 ><TT
626 CLASS="LITERAL"
627 >SDL_MOUSEDEV</TT
628 ></DT
629 ><DD
630 ><P
631 >The mouse device to use for the linux fbcon driver. If not set,
632 SDL first tries to use GPM in repeater mode, then various other
633 devices (/dev/pcaux, /dev/adbmouse, /dev/mouse etc).</P
634 ></DD
635 ><DT
636 ><TT
637 CLASS="LITERAL"
638 >SDL_MOUSEDEV_IMPS2</TT
639 ></DT
640 ><DD
641 ><P
642 >If set, SDL will not try to auto-detect        the IMPS/2 protocol of
643 a PS/2 mouse but use it right away. For the fbcon and ps2gs drivers.</P
644 ></DD
645 ><DT
646 ><TT
647 CLASS="LITERAL"
648 >SDL_MOUSEDRV</TT
649 ></DT
650 ><DD
651 ><P
652 >For the linux fbcon driver: if set to ELO, use the ELO touchscreen
653 controller as a pointer device</P
654 ></DD
655 ><DT
656 ><TT
657 CLASS="LITERAL"
658 >SDL_NO_RAWKBD</TT
659 ></DT
660 ><DD
661 ><P
662 >For the libvga driver: If set, do not attempt to put the keyboard in raw mode.</P
663 ></DD
664 ><DT
665 ><TT
666 CLASS="LITERAL"
667 >SDL_NOMOUSE</TT
668 ></DT
669 ><DD
670 ><P
671 >If set, the linux fbcon driver will not use a mouse at all.</P
672 ></DD
673 ><DT
674 ><TT
675 CLASS="LITERAL"
676 >SDL_NO_LOCK_KEYS</TT
677 ></DT
678 ><DD
679 ><P
680 >Disable CAPS-LOCK and NUM-LOCK suppression of down+up key events,
681 suitable for games where the player needs these keys to do more than just toggle.
682 A value of 1 will effect both CAPS-LOCK and NUM-LOCK.
683 A value of 2 will effect only CAPS-LOCK.
684 A value of 3 will effect only NUM-LOCK.
685 All other values have no effect.
686 </P
687 ></DD
688 ></DL
689 ></DIV
690 ></DIV
691 ><DIV
692 CLASS="REFSECT1"
693 ><A
694 NAME="AEN899"
695 ></A
696 ><H2
697 >Audio</H2
698 ><P
699 ></P
700 ><DIV
701 CLASS="VARIABLELIST"
702 ><DL
703 ><DT
704 ><TT
705 CLASS="LITERAL"
706 >AUDIODEV</TT
707 ></DT
708 ><DD
709 ><P
710 >The audio device to use, if <TT
711 CLASS="LITERAL"
712 >SDL_PATH_DSP</TT
713 > isn't set.</P
714 ></DD
715 ><DT
716 ><TT
717 CLASS="LITERAL"
718 >SDL_AUDIODRIVER</TT
719 ></DT
720 ><DD
721 ><P
722 >Selects the audio driver for SDL to use. Possible values, in the
723 order they are tried if this variable is not set:</P
724 ><DIV
725 CLASS="INFORMALTABLE"
726 ><A
727 NAME="AEN913"
728 ></A
729 ><P
730 ></P
731 ><TABLE
732 BORDER="0"
733 CLASS="CALSTABLE"
734 ><TBODY
735 ><TR
736 ><TD
737 ALIGN="LEFT"
738 VALIGN="TOP"
739 ><TT
740 CLASS="LITERAL"
741 >openbsd</TT
742 ></TD
743 ><TD
744 ALIGN="LEFT"
745 VALIGN="TOP"
746 ><P
747 >(OpenBSD)</P
748 ></TD
749 ></TR
750 ><TR
751 ><TD
752 ALIGN="LEFT"
753 VALIGN="TOP"
754 ><TT
755 CLASS="LITERAL"
756 >dsp</TT
757 ></TD
758 ><TD
759 ALIGN="LEFT"
760 VALIGN="TOP"
761 ><P
762 >(OSS /dev/dsp: Linux, Solaris, BSD etc)</P
763 ></TD
764 ></TR
765 ><TR
766 ><TD
767 ALIGN="LEFT"
768 VALIGN="TOP"
769 ><TT
770 CLASS="LITERAL"
771 >alsa</TT
772 ></TD
773 ><TD
774 ALIGN="LEFT"
775 VALIGN="TOP"
776 ><P
777 >(Linux)</P
778 ></TD
779 ></TR
780 ><TR
781 ><TD
782 ALIGN="LEFT"
783 VALIGN="TOP"
784 ><TT
785 CLASS="LITERAL"
786 >pulse</TT
787 ></TD
788 ><TD
789 ALIGN="LEFT"
790 VALIGN="TOP"
791 ><P
792 >(PulseAudio daemon)</P
793 ></TD
794 ></TR
795 ><TR
796 ><TD
797 ALIGN="LEFT"
798 VALIGN="TOP"
799 ><TT
800 CLASS="LITERAL"
801 >audio</TT
802 ></TD
803 ><TD
804 ALIGN="LEFT"
805 VALIGN="TOP"
806 ><P
807 >(Unix style /dev/audio: SunOS, Solaris etc)</P
808 ></TD
809 ></TR
810 ><TR
811 ><TD
812 ALIGN="LEFT"
813 VALIGN="TOP"
814 ><TT
815 CLASS="LITERAL"
816 >AL</TT
817 ></TD
818 ><TD
819 ALIGN="LEFT"
820 VALIGN="TOP"
821 ><P
822 >(Irix)</P
823 ></TD
824 ></TR
825 ><TR
826 ><TD
827 ALIGN="LEFT"
828 VALIGN="TOP"
829 ><TT
830 CLASS="LITERAL"
831 >artsc</TT
832 ></TD
833 ><TD
834 ALIGN="LEFT"
835 VALIGN="TOP"
836 ><P
837 >(ARTS audio daemon)</P
838 ></TD
839 ></TR
840 ><TR
841 ><TD
842 ALIGN="LEFT"
843 VALIGN="TOP"
844 ><TT
845 CLASS="LITERAL"
846 >esd</TT
847 ></TD
848 ><TD
849 ALIGN="LEFT"
850 VALIGN="TOP"
851 ><P
852 >(esound audio daemon)</P
853 ></TD
854 ></TR
855 ><TR
856 ><TD
857 ALIGN="LEFT"
858 VALIGN="TOP"
859 ><TT
860 CLASS="LITERAL"
861 >nas</TT
862 ></TD
863 ><TD
864 ALIGN="LEFT"
865 VALIGN="TOP"
866 ><P
867 >(NAS audio daemon)</P
868 ></TD
869 ></TR
870 ><TR
871 ><TD
872 ALIGN="LEFT"
873 VALIGN="TOP"
874 ><TT
875 CLASS="LITERAL"
876 >dma</TT
877 ></TD
878 ><TD
879 ALIGN="LEFT"
880 VALIGN="TOP"
881 ><P
882 >(OSS /dev/dsp, using DMA)</P
883 ></TD
884 ></TR
885 ><TR
886 ><TD
887 ALIGN="LEFT"
888 VALIGN="TOP"
889 ><TT
890 CLASS="LITERAL"
891 >dsound</TT
892 ></TD
893 ><TD
894 ALIGN="LEFT"
895 VALIGN="TOP"
896 ><P
897 >(Win32 DirectX)</P
898 ></TD
899 ></TR
900 ><TR
901 ><TD
902 ALIGN="LEFT"
903 VALIGN="TOP"
904 ><TT
905 CLASS="LITERAL"
906 >waveout</TT
907 ></TD
908 ><TD
909 ALIGN="LEFT"
910 VALIGN="TOP"
911 ><P
912 >(Win32 WaveOut)</P
913 ></TD
914 ></TR
915 ><TR
916 ><TD
917 ALIGN="LEFT"
918 VALIGN="TOP"
919 ><TT
920 CLASS="LITERAL"
921 >baudio</TT
922 ></TD
923 ><TD
924 ALIGN="LEFT"
925 VALIGN="TOP"
926 ><P
927 >(BeOS)</P
928 ></TD
929 ></TR
930 ><TR
931 ><TD
932 ALIGN="LEFT"
933 VALIGN="TOP"
934 ><TT
935 CLASS="LITERAL"
936 >sndmgr</TT
937 ></TD
938 ><TD
939 ALIGN="LEFT"
940 VALIGN="TOP"
941 ><P
942 >(MacOS SoundManager)</P
943 ></TD
944 ></TR
945 ><TR
946 ><TD
947 ALIGN="LEFT"
948 VALIGN="TOP"
949 ><TT
950 CLASS="LITERAL"
951 >paud</TT
952 ></TD
953 ><TD
954 ALIGN="LEFT"
955 VALIGN="TOP"
956 ><P
957 >(AIX)</P
958 ></TD
959 ></TR
960 ><TR
961 ><TD
962 ALIGN="LEFT"
963 VALIGN="TOP"
964 ><TT
965 CLASS="LITERAL"
966 >AHI</TT
967 ></TD
968 ><TD
969 ALIGN="LEFT"
970 VALIGN="TOP"
971 ><P
972 >(Amiga)</P
973 ></TD
974 ></TR
975 ><TR
976 ><TD
977 ALIGN="LEFT"
978 VALIGN="TOP"
979 ><TT
980 CLASS="LITERAL"
981 >disk</TT
982 ></TD
983 ><TD
984 ALIGN="LEFT"
985 VALIGN="TOP"
986 ><P
987 >(all; output to file)</P
988 ></TD
989 ></TR
990 ></TBODY
991 ></TABLE
992 ><P
993 ></P
994 ></DIV
995 ></DD
996 ><DT
997 ><TT
998 CLASS="LITERAL"
999 >SDL_DISKAUDIOFILE</TT
1000 ></DT
1001 ><DD
1002 ><P
1003 >The name of the output file for the "disk" audio driver. If not
1004 set, the name <TT
1005 CLASS="LITERAL"
1006 >sdlaudio.raw</TT
1007 > is used.</P
1008 ></DD
1009 ><DT
1010 ><TT
1011 CLASS="LITERAL"
1012 >SDL_DISKAUDIODELAY</TT
1013 ></DT
1014 ><DD
1015 ><P
1016 >For the "disk" audio driver, how long to wait (in ms) before writing
1017 a full sound buffer. The default is 150 ms.</P
1018 ></DD
1019 ><DT
1020 ><TT
1021 CLASS="LITERAL"
1022 >SDL_DSP_NOSELECT</TT
1023 ></DT
1024 ><DD
1025 ><P
1026 >For some audio drivers (alsa, paud, dma and dsp), don't use select()
1027 but a timed method instead. May cure some audio problems, or cause
1028 others.</P
1029 ></DD
1030 ><DT
1031 ><TT
1032 CLASS="LITERAL"
1033 >SDL_PATH_DSP</TT
1034 ></DT
1035 ><DD
1036 ><P
1037 >The audio device to use. If not set, SDL tries AUDIODEV and then
1038 a platform-dependent default value (/dev/audio on Solaris,
1039 /dev/dsp on Linux etc).</P
1040 ></DD
1041 ></DL
1042 ></DIV
1043 ></DIV
1044 ><DIV
1045 CLASS="REFSECT1"
1046 ><A
1047 NAME="AEN1017"
1048 ></A
1049 ><H2
1050 >CD-ROM</H2
1051 ><P
1052 ></P
1053 ><DIV
1054 CLASS="VARIABLELIST"
1055 ><DL
1056 ><DT
1057 ><TT
1058 CLASS="LITERAL"
1059 >SDL_CDROM</TT
1060 ></DT
1061 ><DD
1062 ><P
1063 >A colon-separated list of CD-ROM devices to use, in addition to
1064 the standard devices (typically /dev/cdrom, platform-dependent).</P
1065 ></DD
1066 ></DL
1067 ></DIV
1068 ></DIV
1069 ><DIV
1070 CLASS="REFSECT1"
1071 ><A
1072 NAME="AEN1025"
1073 ></A
1074 ><H2
1075 >Debugging</H2
1076 ><P
1077 ></P
1078 ><DIV
1079 CLASS="VARIABLELIST"
1080 ><DL
1081 ><DT
1082 ><TT
1083 CLASS="LITERAL"
1084 >SDL_DEBUG</TT
1085 ></DT
1086 ><DD
1087 ><P
1088 >If set, causes every call to <TT
1089 CLASS="FUNCTION"
1090 >SDL_SetError</TT
1091 > (that
1092 is, every time SDL signals an error) to also print an error message on
1093 stderr.</P
1094 ></DD
1095 ></DL
1096 ></DIV
1097 ></DIV
1098 ><DIV
1099 CLASS="REFSECT1"
1100 ><A
1101 NAME="AEN1034"
1102 ></A
1103 ><H2
1104 >Joystick</H2
1105 ><P
1106 ></P
1107 ><DIV
1108 CLASS="VARIABLELIST"
1109 ><DL
1110 ><DT
1111 ><TT
1112 CLASS="LITERAL"
1113 >SDL_JOYSTICK_DEVICE</TT
1114 ></DT
1115 ><DD
1116 ><P
1117 >Joystick device to use in the linux joystick driver, in addition
1118 to the usual: /dev/js*, /dev/input/event*, /dev/input/js*</P
1119 ></DD
1120 ><DT
1121 ><TT
1122 CLASS="LITERAL"
1123 >SDL_LINUX_JOYSTICK</TT
1124 ></DT
1125 ><DD
1126 ><P
1127 >Special joystick configuration string for linux. The format is</P
1128 ><P
1129 >"<TT
1130 CLASS="PARAMETER"
1131 ><I
1132 >name</I
1133 ></TT
1134 > <TT
1135 CLASS="PARAMETER"
1136 ><I
1137 >numaxes</I
1138 ></TT
1139 > <TT
1140 CLASS="PARAMETER"
1141 ><I
1142 >numhats</I
1143 ></TT
1144 > <TT
1145 CLASS="PARAMETER"
1146 ><I
1147 >numballs</I
1148 ></TT
1149 >"</P
1150 ><P
1151 >where <TT
1152 CLASS="PARAMETER"
1153 ><I
1154 >name</I
1155 ></TT
1156 > is the name string of the joystick
1157 (possibly in single quotes), and the rest are the number of axes, hats
1158 and balls respectively.</P
1159 ></DD
1160 ></DL
1161 ></DIV
1162 ></DIV
1163 ><DIV
1164 CLASS="NAVFOOTER"
1165 ><HR
1166 ALIGN="LEFT"
1167 WIDTH="100%"><TABLE
1168 SUMMARY="Footer navigation table"
1169 WIDTH="100%"
1170 BORDER="0"
1171 CELLPADDING="0"
1172 CELLSPACING="0"
1173 ><TR
1174 ><TD
1175 WIDTH="33%"
1176 ALIGN="left"
1177 VALIGN="top"
1178 ><A
1179 HREF="sdlgeterror.html"
1180 ACCESSKEY="P"
1181 >Prev</A
1182 ></TD
1183 ><TD
1184 WIDTH="34%"
1185 ALIGN="center"
1186 VALIGN="top"
1187 ><A
1188 HREF="index.html"
1189 ACCESSKEY="H"
1190 >Home</A
1191 ></TD
1192 ><TD
1193 WIDTH="33%"
1194 ALIGN="right"
1195 VALIGN="top"
1196 ><A
1197 HREF="video.html"
1198 ACCESSKEY="N"
1199 >Next</A
1200 ></TD
1201 ></TR
1202 ><TR
1203 ><TD
1204 WIDTH="33%"
1205 ALIGN="left"
1206 VALIGN="top"
1207 >SDL_GetError</TD
1208 ><TD
1209 WIDTH="34%"
1210 ALIGN="center"
1211 VALIGN="top"
1212 ><A
1213 HREF="general.html"
1214 ACCESSKEY="U"
1215 >Up</A
1216 ></TD
1217 ><TD
1218 WIDTH="33%"
1219 ALIGN="right"
1220 VALIGN="top"
1221 >Video</TD
1222 ></TR
1223 ></TABLE
1224 ></DIV
1225 ></BODY
1226 ></HTML
1227 >