comparison docs/html/sdlenvvars.html @ 803:355632dca928

Updated SDL HTML documentation
author Sam Lantinga <slouken@libsdl.org>
date Tue, 10 Feb 2004 15:15:40 +0000
parents
children 34cca785be57
comparison
equal deleted inserted replaced
802:3c609d54f100 803:355632dca928
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 >(MacOS 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 >epoc</TT
440 ></TD
441 ><TD
442 ALIGN="LEFT"
443 VALIGN="TOP"
444 ><P
445 >(Epoc)</P
446 ></TD
447 ></TR
448 ><TR
449 ><TD
450 ALIGN="LEFT"
451 VALIGN="TOP"
452 ><TT
453 CLASS="LITERAL"
454 >dummy</TT
455 ></TD
456 ><TD
457 ALIGN="LEFT"
458 VALIGN="TOP"
459 ><P
460 ></P
461 ></TD
462 ></TR
463 ></TBODY
464 ></TABLE
465 ><P
466 ></P
467 ></DIV
468 ></DD
469 ><DT
470 ><TT
471 CLASS="LITERAL"
472 >SDL_VIDEO_CENTERED</TT
473 ></DT
474 ><DD
475 ><P
476 >If set, tries to center the SDL window when running in X11 windowed
477 mode, or using the CyberGrafix driver.</P
478 ></DD
479 ><DT
480 ><TT
481 CLASS="LITERAL"
482 >SDL_VIDEO_GL_DRIVER</TT
483 ></DT
484 ><DD
485 ><P
486 >The openGL driver (shared library) to use for X11. Default is libGL.so.1</P
487 ></DD
488 ><DT
489 ><TT
490 CLASS="LITERAL"
491 >SDL_VIDEO_X11_DGAMOUSE</TT
492 ></DT
493 ><DD
494 ><P
495 >With XFree86, enables use of DGA mouse if set.</P
496 ></DD
497 ><DT
498 ><TT
499 CLASS="LITERAL"
500 >SDL_VIDEO_X11_MOUSEACCEL</TT
501 ></DT
502 ><DD
503 ><P
504 >For X11, sets the mouse acceleration. The value should be a string
505 on the form:</P
506 ><P
507 >"<TT
508 CLASS="PARAMETER"
509 ><I
510 >n</I
511 ></TT
512 >/<TT
513 CLASS="PARAMETER"
514 ><I
515 >d</I
516 ></TT
517 >/<TT
518 CLASS="PARAMETER"
519 ><I
520 >t</I
521 ></TT
522 >"</P
523 ><P
524 >where <TT
525 CLASS="PARAMETER"
526 ><I
527 >n</I
528 ></TT
529 > and <TT
530 CLASS="PARAMETER"
531 ><I
532 >d</I
533 ></TT
534 > are the
535 acceleration numerator/denumerators (so mouse movement is accelerated by
536 <TT
537 CLASS="PARAMETER"
538 ><I
539 >n</I
540 ></TT
541 >/<TT
542 CLASS="PARAMETER"
543 ><I
544 >d</I
545 ></TT
546 >), and
547 <TT
548 CLASS="PARAMETER"
549 ><I
550 >t</I
551 ></TT
552 > is the threshold above which acceleration applies
553 (counted as number of pixels the mouse moves at once).</P
554 ></DD
555 ><DT
556 ><TT
557 CLASS="LITERAL"
558 >SDL_VIDEO_X11_NODIRECTCOLOR</TT
559 ></DT
560 ><DD
561 ><P
562 >If set, don't attempt to use DirectColor visuals even if they are
563 present. (SDL will use them otherwise for gamma correction).
564 This is needed with older X servers when using the XVideo extension.</P
565 ></DD
566 ><DT
567 ><TT
568 CLASS="LITERAL"
569 >SDL_VIDEO_X11_VISUALID</TT
570 ></DT
571 ><DD
572 ><P
573 >ID of an X11 visual to use, overriding SDL's default visual selection
574 algorithm. It can be in decimal or in hex (prefixed by 0x).</P
575 ></DD
576 ><DT
577 ><TT
578 CLASS="LITERAL"
579 >SDL_VIDEO_YUV_DIRECT</TT
580 ></DT
581 ><DD
582 ><P
583 >If set, display YUV overlay directly on the video surface if possible,
584 instead of on the surface passed to
585 <A
586 HREF="sdlcreateyuvoverlay.html"
587 ><TT
588 CLASS="FUNCTION"
589 >SDL_CreateYUVOverlay</TT
590 ></A
591 >.</P
592 ></DD
593 ><DT
594 ><TT
595 CLASS="LITERAL"
596 >SDL_VIDEO_YUV_HWACCEL</TT
597 ></DT
598 ><DD
599 ><P
600 >If not set or set to a nonzero value, SDL will attempt to use
601 hardware YUV acceleration for video playback.</P
602 ></DD
603 ><DT
604 ><TT
605 CLASS="LITERAL"
606 >SDL_WINDOWID</TT
607 ></DT
608 ><DD
609 ><P
610 >For X11 or Win32, contains the ID number of the window to be used by
611 SDL instead of creating its own window. Either in decimal or
612 in hex (prefixed by 0x).</P
613 ></DD
614 ></DL
615 ></DIV
616 ></DIV
617 ><DIV
618 CLASS="REFSECT1"
619 ><A
620 NAME="AEN866"
621 ></A
622 ><H2
623 >Events/Input</H2
624 ><P
625 ></P
626 ><DIV
627 CLASS="VARIABLELIST"
628 ><DL
629 ><DT
630 ><TT
631 CLASS="LITERAL"
632 >SDL_MOUSE_RELATIVE</TT
633 ></DT
634 ><DD
635 ><P
636 >If set to 0, do not use mouse relative mode in X11. The default is
637 to use it if the mouse is hidden and input is grabbed.</P
638 ></DD
639 ><DT
640 ><TT
641 CLASS="LITERAL"
642 >SDL_MOUSEDEV</TT
643 ></DT
644 ><DD
645 ><P
646 >The mouse device to use for the linux fbcon driver. If not set,
647 SDL first tries to use GPM in repeater mode, then various other
648 devices (/dev/pcaux, /dev/adbmouse, /dev/mouse etc).</P
649 ></DD
650 ><DT
651 ><TT
652 CLASS="LITERAL"
653 >SDL_MOUSEDEV_IMPS2</TT
654 ></DT
655 ><DD
656 ><P
657 >If set, SDL will not try to auto-detect the IMPS/2 protocol of
658 a PS/2 mouse but use it right away. For the fbcon and ps2gs drivers.</P
659 ></DD
660 ><DT
661 ><TT
662 CLASS="LITERAL"
663 >SDL_MOUSEDRV</TT
664 ></DT
665 ><DD
666 ><P
667 >For the linux fbcon driver: if set to ELO, use the ELO touchscreen
668 controller as a pointer device</P
669 ></DD
670 ><DT
671 ><TT
672 CLASS="LITERAL"
673 >SDL_NO_RAWKBD</TT
674 ></DT
675 ><DD
676 ><P
677 >For the libvga driver: If set, do not attempt to put the keyboard in raw mode.</P
678 ></DD
679 ><DT
680 ><TT
681 CLASS="LITERAL"
682 >SDL_NOMOUSE</TT
683 ></DT
684 ><DD
685 ><P
686 >If set, the linux fbcon driver will not use a mouse at all.</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 >audio</TT
787 ></TD
788 ><TD
789 ALIGN="LEFT"
790 VALIGN="TOP"
791 ><P
792 >(Unix style /dev/audio: SunOS, Solaris etc)</P
793 ></TD
794 ></TR
795 ><TR
796 ><TD
797 ALIGN="LEFT"
798 VALIGN="TOP"
799 ><TT
800 CLASS="LITERAL"
801 >AL</TT
802 ></TD
803 ><TD
804 ALIGN="LEFT"
805 VALIGN="TOP"
806 ><P
807 >(Irix)</P
808 ></TD
809 ></TR
810 ><TR
811 ><TD
812 ALIGN="LEFT"
813 VALIGN="TOP"
814 ><TT
815 CLASS="LITERAL"
816 >artsc</TT
817 ></TD
818 ><TD
819 ALIGN="LEFT"
820 VALIGN="TOP"
821 ><P
822 >(ARTS audio daemon)</P
823 ></TD
824 ></TR
825 ><TR
826 ><TD
827 ALIGN="LEFT"
828 VALIGN="TOP"
829 ><TT
830 CLASS="LITERAL"
831 >esd</TT
832 ></TD
833 ><TD
834 ALIGN="LEFT"
835 VALIGN="TOP"
836 ><P
837 >(esound audio daemon)</P
838 ></TD
839 ></TR
840 ><TR
841 ><TD
842 ALIGN="LEFT"
843 VALIGN="TOP"
844 ><TT
845 CLASS="LITERAL"
846 >nas</TT
847 ></TD
848 ><TD
849 ALIGN="LEFT"
850 VALIGN="TOP"
851 ><P
852 >(NAS audio daemon)</P
853 ></TD
854 ></TR
855 ><TR
856 ><TD
857 ALIGN="LEFT"
858 VALIGN="TOP"
859 ><TT
860 CLASS="LITERAL"
861 >dma</TT
862 ></TD
863 ><TD
864 ALIGN="LEFT"
865 VALIGN="TOP"
866 ><P
867 >(OSS /dev/dsp, using DMA)</P
868 ></TD
869 ></TR
870 ><TR
871 ><TD
872 ALIGN="LEFT"
873 VALIGN="TOP"
874 ><TT
875 CLASS="LITERAL"
876 >dsound</TT
877 ></TD
878 ><TD
879 ALIGN="LEFT"
880 VALIGN="TOP"
881 ><P
882 >(Win32 DirectX)</P
883 ></TD
884 ></TR
885 ><TR
886 ><TD
887 ALIGN="LEFT"
888 VALIGN="TOP"
889 ><TT
890 CLASS="LITERAL"
891 >waveout</TT
892 ></TD
893 ><TD
894 ALIGN="LEFT"
895 VALIGN="TOP"
896 ><P
897 >(Win32 WaveOut)</P
898 ></TD
899 ></TR
900 ><TR
901 ><TD
902 ALIGN="LEFT"
903 VALIGN="TOP"
904 ><TT
905 CLASS="LITERAL"
906 >baudio</TT
907 ></TD
908 ><TD
909 ALIGN="LEFT"
910 VALIGN="TOP"
911 ><P
912 >(BeOS)</P
913 ></TD
914 ></TR
915 ><TR
916 ><TD
917 ALIGN="LEFT"
918 VALIGN="TOP"
919 ><TT
920 CLASS="LITERAL"
921 >sndmgr</TT
922 ></TD
923 ><TD
924 ALIGN="LEFT"
925 VALIGN="TOP"
926 ><P
927 >(MacOS SoundManager)</P
928 ></TD
929 ></TR
930 ><TR
931 ><TD
932 ALIGN="LEFT"
933 VALIGN="TOP"
934 ><TT
935 CLASS="LITERAL"
936 >paud</TT
937 ></TD
938 ><TD
939 ALIGN="LEFT"
940 VALIGN="TOP"
941 ><P
942 >(AIX)</P
943 ></TD
944 ></TR
945 ><TR
946 ><TD
947 ALIGN="LEFT"
948 VALIGN="TOP"
949 ><TT
950 CLASS="LITERAL"
951 >AHI</TT
952 ></TD
953 ><TD
954 ALIGN="LEFT"
955 VALIGN="TOP"
956 ><P
957 >(Amiga)</P
958 ></TD
959 ></TR
960 ><TR
961 ><TD
962 ALIGN="LEFT"
963 VALIGN="TOP"
964 ><TT
965 CLASS="LITERAL"
966 >disk</TT
967 ></TD
968 ><TD
969 ALIGN="LEFT"
970 VALIGN="TOP"
971 ><P
972 >(all; output to file)</P
973 ></TD
974 ></TR
975 ></TBODY
976 ></TABLE
977 ><P
978 ></P
979 ></DIV
980 ></DD
981 ><DT
982 ><TT
983 CLASS="LITERAL"
984 >SDL_DISKAUDIOFILE</TT
985 ></DT
986 ><DD
987 ><P
988 >The name of the output file for the "disk" audio driver. If not
989 set, the name <TT
990 CLASS="LITERAL"
991 >sdlaudio.raw</TT
992 > is used.</P
993 ></DD
994 ><DT
995 ><TT
996 CLASS="LITERAL"
997 >SDL_DISKAUDIODELAY</TT
998 ></DT
999 ><DD
1000 ><P
1001 >For the "disk" audio driver, how long to wait (in ms) before writing
1002 a full sound buffer. The default is 150 ms.</P
1003 ></DD
1004 ><DT
1005 ><TT
1006 CLASS="LITERAL"
1007 >SDL_DSP_NOSELECT</TT
1008 ></DT
1009 ><DD
1010 ><P
1011 >For some audio drivers (alsa, paud, dma and dsp), don't use select()
1012 but a timed method instead. May cure some audio problems, or cause
1013 others.</P
1014 ></DD
1015 ><DT
1016 ><TT
1017 CLASS="LITERAL"
1018 >SDL_PATH_DSP</TT
1019 ></DT
1020 ><DD
1021 ><P
1022 >The audio device to use. If not set, SDL tries AUDIODEV and then
1023 a platform-dependent default value (/dev/audio on Solaris,
1024 /dev/dsp on Linux etc).</P
1025 ></DD
1026 ></DL
1027 ></DIV
1028 ></DIV
1029 ><DIV
1030 CLASS="REFSECT1"
1031 ><A
1032 NAME="AEN1017"
1033 ></A
1034 ><H2
1035 >CD-ROM</H2
1036 ><P
1037 ></P
1038 ><DIV
1039 CLASS="VARIABLELIST"
1040 ><DL
1041 ><DT
1042 ><TT
1043 CLASS="LITERAL"
1044 >SDL_CDROM</TT
1045 ></DT
1046 ><DD
1047 ><P
1048 >A colon-separated list of CD-ROM devices to use, in addition to
1049 the standard devices (typically /dev/cdrom, platform-dependent).</P
1050 ></DD
1051 ></DL
1052 ></DIV
1053 ></DIV
1054 ><DIV
1055 CLASS="REFSECT1"
1056 ><A
1057 NAME="AEN1025"
1058 ></A
1059 ><H2
1060 >Debugging</H2
1061 ><P
1062 ></P
1063 ><DIV
1064 CLASS="VARIABLELIST"
1065 ><DL
1066 ><DT
1067 ><TT
1068 CLASS="LITERAL"
1069 >SDL_DEBUG</TT
1070 ></DT
1071 ><DD
1072 ><P
1073 >If set, causes every call to <TT
1074 CLASS="FUNCTION"
1075 >SDL_SetError</TT
1076 > (that
1077 is, every time SDL signals an error) to also print an error message on
1078 stderr.</P
1079 ></DD
1080 ></DL
1081 ></DIV
1082 ></DIV
1083 ><DIV
1084 CLASS="REFSECT1"
1085 ><A
1086 NAME="AEN1034"
1087 ></A
1088 ><H2
1089 >Joystick</H2
1090 ><P
1091 ></P
1092 ><DIV
1093 CLASS="VARIABLELIST"
1094 ><DL
1095 ><DT
1096 ><TT
1097 CLASS="LITERAL"
1098 >SDL_JOYSTICK_DEVICE</TT
1099 ></DT
1100 ><DD
1101 ><P
1102 >Joystick device to use in the linux joystick driver, in addition
1103 to the usual: /dev/js*, /dev/input/event*, /dev/input/js*</P
1104 ></DD
1105 ><DT
1106 ><TT
1107 CLASS="LITERAL"
1108 >SDL_LINUX_JOYSTICK</TT
1109 ></DT
1110 ><DD
1111 ><P
1112 >Special joystick configuration string for linux. The format is</P
1113 ><P
1114 >"<TT
1115 CLASS="PARAMETER"
1116 ><I
1117 >name</I
1118 ></TT
1119 > <TT
1120 CLASS="PARAMETER"
1121 ><I
1122 >numaxes</I
1123 ></TT
1124 > <TT
1125 CLASS="PARAMETER"
1126 ><I
1127 >numhats</I
1128 ></TT
1129 > <TT
1130 CLASS="PARAMETER"
1131 ><I
1132 >numballs</I
1133 ></TT
1134 >"</P
1135 ><P
1136 >where <TT
1137 CLASS="PARAMETER"
1138 ><I
1139 >name</I
1140 ></TT
1141 > is the name string of the joystick
1142 (possibly in single quotes), and the rest are the number of axes, hats
1143 and balls respectively.</P
1144 ></DD
1145 ></DL
1146 ></DIV
1147 ></DIV
1148 ><DIV
1149 CLASS="NAVFOOTER"
1150 ><HR
1151 ALIGN="LEFT"
1152 WIDTH="100%"><TABLE
1153 SUMMARY="Footer navigation table"
1154 WIDTH="100%"
1155 BORDER="0"
1156 CELLPADDING="0"
1157 CELLSPACING="0"
1158 ><TR
1159 ><TD
1160 WIDTH="33%"
1161 ALIGN="left"
1162 VALIGN="top"
1163 ><A
1164 HREF="sdlgeterror.html"
1165 ACCESSKEY="P"
1166 >Prev</A
1167 ></TD
1168 ><TD
1169 WIDTH="34%"
1170 ALIGN="center"
1171 VALIGN="top"
1172 ><A
1173 HREF="index.html"
1174 ACCESSKEY="H"
1175 >Home</A
1176 ></TD
1177 ><TD
1178 WIDTH="33%"
1179 ALIGN="right"
1180 VALIGN="top"
1181 ><A
1182 HREF="video.html"
1183 ACCESSKEY="N"
1184 >Next</A
1185 ></TD
1186 ></TR
1187 ><TR
1188 ><TD
1189 WIDTH="33%"
1190 ALIGN="left"
1191 VALIGN="top"
1192 >SDL_GetError</TD
1193 ><TD
1194 WIDTH="34%"
1195 ALIGN="center"
1196 VALIGN="top"
1197 ><A
1198 HREF="general.html"
1199 ACCESSKEY="U"
1200 >Up</A
1201 ></TD
1202 ><TD
1203 WIDTH="33%"
1204 ALIGN="right"
1205 VALIGN="top"
1206 >Video</TD
1207 ></TR
1208 ></TABLE
1209 ></DIV
1210 ></BODY
1211 ></HTML
1212 >