docs/html/sdlenvvars.html
author Ryan C. Gordon <icculus@icculus.org>
Wed, 22 Mar 2006 11:13:58 +0000
changeset 1589 34cca785be57
parent 803 355632dca928
child 1621 f12379c41042
permissions -rw-r--r--
Xrandr support in the X11 target.

Fixes Bugzilla #109, and as a bonus, Bugzilla #145, too!
     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_X11_NO_XRANDR</TT
   580 ></DT
   581 ><DD
   582 ><P
   583 >If set, don't attempt to use the Xrandr extension for resolution mode
   584 switching.  Normally Xrandr takes precedence over the XF86VidMode
   585 extension, so setting this environment variable will cause the 
   586 XF86VidMode extension to be used if it is available.</P
   587 ></DD
   588 ><DT
   589 ><TT
   590 CLASS="LITERAL"
   591 >SDL_VIDEO_YUV_DIRECT</TT
   592 ></DT
   593 ><DD
   594 ><P
   595 >If set, display YUV overlay directly on the video surface if possible,
   596 instead of on the surface passed to
   597 <A
   598 HREF="sdlcreateyuvoverlay.html"
   599 ><TT
   600 CLASS="FUNCTION"
   601 >SDL_CreateYUVOverlay</TT
   602 ></A
   603 >.</P
   604 ></DD
   605 ><DT
   606 ><TT
   607 CLASS="LITERAL"
   608 >SDL_VIDEO_YUV_HWACCEL</TT
   609 ></DT
   610 ><DD
   611 ><P
   612 >If not set or set to a nonzero value, SDL will attempt to use
   613 hardware YUV acceleration for video playback.</P
   614 ></DD
   615 ><DT
   616 ><TT
   617 CLASS="LITERAL"
   618 >SDL_WINDOWID</TT
   619 ></DT
   620 ><DD
   621 ><P
   622 >For X11 or Win32, contains the ID number of the window to be used by
   623 SDL instead of creating its own window. Either in decimal or
   624 in hex (prefixed by 0x).</P
   625 ></DD
   626 ></DL
   627 ></DIV
   628 ></DIV
   629 ><DIV
   630 CLASS="REFSECT1"
   631 ><A
   632 NAME="AEN866"
   633 ></A
   634 ><H2
   635 >Events/Input</H2
   636 ><P
   637 ></P
   638 ><DIV
   639 CLASS="VARIABLELIST"
   640 ><DL
   641 ><DT
   642 ><TT
   643 CLASS="LITERAL"
   644 >SDL_MOUSE_RELATIVE</TT
   645 ></DT
   646 ><DD
   647 ><P
   648 >If set to 0, do not use mouse relative mode in X11. The default is
   649 to use it if the mouse is hidden and input is grabbed.</P
   650 ></DD
   651 ><DT
   652 ><TT
   653 CLASS="LITERAL"
   654 >SDL_MOUSEDEV</TT
   655 ></DT
   656 ><DD
   657 ><P
   658 >The mouse device to use for the linux fbcon driver. If not set,
   659 SDL first tries to use GPM in repeater mode, then various other
   660 devices (/dev/pcaux, /dev/adbmouse, /dev/mouse etc).</P
   661 ></DD
   662 ><DT
   663 ><TT
   664 CLASS="LITERAL"
   665 >SDL_MOUSEDEV_IMPS2</TT
   666 ></DT
   667 ><DD
   668 ><P
   669 >If set, SDL will not try to auto-detect	the IMPS/2 protocol of
   670 a PS/2 mouse but use it right away. For the fbcon and ps2gs drivers.</P
   671 ></DD
   672 ><DT
   673 ><TT
   674 CLASS="LITERAL"
   675 >SDL_MOUSEDRV</TT
   676 ></DT
   677 ><DD
   678 ><P
   679 >For the linux fbcon driver: if set to ELO, use the ELO touchscreen
   680 controller as a pointer device</P
   681 ></DD
   682 ><DT
   683 ><TT
   684 CLASS="LITERAL"
   685 >SDL_NO_RAWKBD</TT
   686 ></DT
   687 ><DD
   688 ><P
   689 >For the libvga driver: If set, do not attempt to put the keyboard in raw mode.</P
   690 ></DD
   691 ><DT
   692 ><TT
   693 CLASS="LITERAL"
   694 >SDL_NOMOUSE</TT
   695 ></DT
   696 ><DD
   697 ><P
   698 >If set, the linux fbcon driver will not use a mouse at all.</P
   699 ></DD
   700 ></DL
   701 ></DIV
   702 ></DIV
   703 ><DIV
   704 CLASS="REFSECT1"
   705 ><A
   706 NAME="AEN899"
   707 ></A
   708 ><H2
   709 >Audio</H2
   710 ><P
   711 ></P
   712 ><DIV
   713 CLASS="VARIABLELIST"
   714 ><DL
   715 ><DT
   716 ><TT
   717 CLASS="LITERAL"
   718 >AUDIODEV</TT
   719 ></DT
   720 ><DD
   721 ><P
   722 >The audio device to use, if <TT
   723 CLASS="LITERAL"
   724 >SDL_PATH_DSP</TT
   725 > isn't set.</P
   726 ></DD
   727 ><DT
   728 ><TT
   729 CLASS="LITERAL"
   730 >SDL_AUDIODRIVER</TT
   731 ></DT
   732 ><DD
   733 ><P
   734 >Selects the audio driver for SDL to use. Possible values, in the
   735 order they are tried if this variable is not set:</P
   736 ><DIV
   737 CLASS="INFORMALTABLE"
   738 ><A
   739 NAME="AEN913"
   740 ></A
   741 ><P
   742 ></P
   743 ><TABLE
   744 BORDER="0"
   745 CLASS="CALSTABLE"
   746 ><TBODY
   747 ><TR
   748 ><TD
   749 ALIGN="LEFT"
   750 VALIGN="TOP"
   751 ><TT
   752 CLASS="LITERAL"
   753 >openbsd</TT
   754 ></TD
   755 ><TD
   756 ALIGN="LEFT"
   757 VALIGN="TOP"
   758 ><P
   759 >(OpenBSD)</P
   760 ></TD
   761 ></TR
   762 ><TR
   763 ><TD
   764 ALIGN="LEFT"
   765 VALIGN="TOP"
   766 ><TT
   767 CLASS="LITERAL"
   768 >dsp</TT
   769 ></TD
   770 ><TD
   771 ALIGN="LEFT"
   772 VALIGN="TOP"
   773 ><P
   774 >(OSS /dev/dsp: Linux, Solaris, BSD etc)</P
   775 ></TD
   776 ></TR
   777 ><TR
   778 ><TD
   779 ALIGN="LEFT"
   780 VALIGN="TOP"
   781 ><TT
   782 CLASS="LITERAL"
   783 >alsa</TT
   784 ></TD
   785 ><TD
   786 ALIGN="LEFT"
   787 VALIGN="TOP"
   788 ><P
   789 >(Linux)</P
   790 ></TD
   791 ></TR
   792 ><TR
   793 ><TD
   794 ALIGN="LEFT"
   795 VALIGN="TOP"
   796 ><TT
   797 CLASS="LITERAL"
   798 >audio</TT
   799 ></TD
   800 ><TD
   801 ALIGN="LEFT"
   802 VALIGN="TOP"
   803 ><P
   804 >(Unix style /dev/audio: SunOS, Solaris etc)</P
   805 ></TD
   806 ></TR
   807 ><TR
   808 ><TD
   809 ALIGN="LEFT"
   810 VALIGN="TOP"
   811 ><TT
   812 CLASS="LITERAL"
   813 >AL</TT
   814 ></TD
   815 ><TD
   816 ALIGN="LEFT"
   817 VALIGN="TOP"
   818 ><P
   819 >(Irix)</P
   820 ></TD
   821 ></TR
   822 ><TR
   823 ><TD
   824 ALIGN="LEFT"
   825 VALIGN="TOP"
   826 ><TT
   827 CLASS="LITERAL"
   828 >artsc</TT
   829 ></TD
   830 ><TD
   831 ALIGN="LEFT"
   832 VALIGN="TOP"
   833 ><P
   834 >(ARTS audio daemon)</P
   835 ></TD
   836 ></TR
   837 ><TR
   838 ><TD
   839 ALIGN="LEFT"
   840 VALIGN="TOP"
   841 ><TT
   842 CLASS="LITERAL"
   843 >esd</TT
   844 ></TD
   845 ><TD
   846 ALIGN="LEFT"
   847 VALIGN="TOP"
   848 ><P
   849 >(esound audio daemon)</P
   850 ></TD
   851 ></TR
   852 ><TR
   853 ><TD
   854 ALIGN="LEFT"
   855 VALIGN="TOP"
   856 ><TT
   857 CLASS="LITERAL"
   858 >nas</TT
   859 ></TD
   860 ><TD
   861 ALIGN="LEFT"
   862 VALIGN="TOP"
   863 ><P
   864 >(NAS audio daemon)</P
   865 ></TD
   866 ></TR
   867 ><TR
   868 ><TD
   869 ALIGN="LEFT"
   870 VALIGN="TOP"
   871 ><TT
   872 CLASS="LITERAL"
   873 >dma</TT
   874 ></TD
   875 ><TD
   876 ALIGN="LEFT"
   877 VALIGN="TOP"
   878 ><P
   879 >(OSS /dev/dsp, using DMA)</P
   880 ></TD
   881 ></TR
   882 ><TR
   883 ><TD
   884 ALIGN="LEFT"
   885 VALIGN="TOP"
   886 ><TT
   887 CLASS="LITERAL"
   888 >dsound</TT
   889 ></TD
   890 ><TD
   891 ALIGN="LEFT"
   892 VALIGN="TOP"
   893 ><P
   894 >(Win32 DirectX)</P
   895 ></TD
   896 ></TR
   897 ><TR
   898 ><TD
   899 ALIGN="LEFT"
   900 VALIGN="TOP"
   901 ><TT
   902 CLASS="LITERAL"
   903 >waveout</TT
   904 ></TD
   905 ><TD
   906 ALIGN="LEFT"
   907 VALIGN="TOP"
   908 ><P
   909 >(Win32 WaveOut)</P
   910 ></TD
   911 ></TR
   912 ><TR
   913 ><TD
   914 ALIGN="LEFT"
   915 VALIGN="TOP"
   916 ><TT
   917 CLASS="LITERAL"
   918 >baudio</TT
   919 ></TD
   920 ><TD
   921 ALIGN="LEFT"
   922 VALIGN="TOP"
   923 ><P
   924 >(BeOS)</P
   925 ></TD
   926 ></TR
   927 ><TR
   928 ><TD
   929 ALIGN="LEFT"
   930 VALIGN="TOP"
   931 ><TT
   932 CLASS="LITERAL"
   933 >sndmgr</TT
   934 ></TD
   935 ><TD
   936 ALIGN="LEFT"
   937 VALIGN="TOP"
   938 ><P
   939 >(MacOS SoundManager)</P
   940 ></TD
   941 ></TR
   942 ><TR
   943 ><TD
   944 ALIGN="LEFT"
   945 VALIGN="TOP"
   946 ><TT
   947 CLASS="LITERAL"
   948 >paud</TT
   949 ></TD
   950 ><TD
   951 ALIGN="LEFT"
   952 VALIGN="TOP"
   953 ><P
   954 >(AIX)</P
   955 ></TD
   956 ></TR
   957 ><TR
   958 ><TD
   959 ALIGN="LEFT"
   960 VALIGN="TOP"
   961 ><TT
   962 CLASS="LITERAL"
   963 >AHI</TT
   964 ></TD
   965 ><TD
   966 ALIGN="LEFT"
   967 VALIGN="TOP"
   968 ><P
   969 >(Amiga)</P
   970 ></TD
   971 ></TR
   972 ><TR
   973 ><TD
   974 ALIGN="LEFT"
   975 VALIGN="TOP"
   976 ><TT
   977 CLASS="LITERAL"
   978 >disk</TT
   979 ></TD
   980 ><TD
   981 ALIGN="LEFT"
   982 VALIGN="TOP"
   983 ><P
   984 >(all; output to file)</P
   985 ></TD
   986 ></TR
   987 ></TBODY
   988 ></TABLE
   989 ><P
   990 ></P
   991 ></DIV
   992 ></DD
   993 ><DT
   994 ><TT
   995 CLASS="LITERAL"
   996 >SDL_DISKAUDIOFILE</TT
   997 ></DT
   998 ><DD
   999 ><P
  1000 >The name of the output file for the "disk" audio driver. If not
  1001 set, the name <TT
  1002 CLASS="LITERAL"
  1003 >sdlaudio.raw</TT
  1004 > is used.</P
  1005 ></DD
  1006 ><DT
  1007 ><TT
  1008 CLASS="LITERAL"
  1009 >SDL_DISKAUDIODELAY</TT
  1010 ></DT
  1011 ><DD
  1012 ><P
  1013 >For the "disk" audio driver, how long to wait (in ms) before writing
  1014 a full sound buffer. The default is 150 ms.</P
  1015 ></DD
  1016 ><DT
  1017 ><TT
  1018 CLASS="LITERAL"
  1019 >SDL_DSP_NOSELECT</TT
  1020 ></DT
  1021 ><DD
  1022 ><P
  1023 >For some audio drivers (alsa, paud, dma and dsp), don't use select()
  1024 but a timed method instead. May cure some audio problems, or cause
  1025 others.</P
  1026 ></DD
  1027 ><DT
  1028 ><TT
  1029 CLASS="LITERAL"
  1030 >SDL_PATH_DSP</TT
  1031 ></DT
  1032 ><DD
  1033 ><P
  1034 >The audio device to use. If not set, SDL tries AUDIODEV and then
  1035 a platform-dependent default value (/dev/audio on Solaris,
  1036 /dev/dsp on Linux etc).</P
  1037 ></DD
  1038 ></DL
  1039 ></DIV
  1040 ></DIV
  1041 ><DIV
  1042 CLASS="REFSECT1"
  1043 ><A
  1044 NAME="AEN1017"
  1045 ></A
  1046 ><H2
  1047 >CD-ROM</H2
  1048 ><P
  1049 ></P
  1050 ><DIV
  1051 CLASS="VARIABLELIST"
  1052 ><DL
  1053 ><DT
  1054 ><TT
  1055 CLASS="LITERAL"
  1056 >SDL_CDROM</TT
  1057 ></DT
  1058 ><DD
  1059 ><P
  1060 >A colon-separated list of CD-ROM devices to use, in addition to
  1061 the standard devices (typically /dev/cdrom, platform-dependent).</P
  1062 ></DD
  1063 ></DL
  1064 ></DIV
  1065 ></DIV
  1066 ><DIV
  1067 CLASS="REFSECT1"
  1068 ><A
  1069 NAME="AEN1025"
  1070 ></A
  1071 ><H2
  1072 >Debugging</H2
  1073 ><P
  1074 ></P
  1075 ><DIV
  1076 CLASS="VARIABLELIST"
  1077 ><DL
  1078 ><DT
  1079 ><TT
  1080 CLASS="LITERAL"
  1081 >SDL_DEBUG</TT
  1082 ></DT
  1083 ><DD
  1084 ><P
  1085 >If set, causes every call to <TT
  1086 CLASS="FUNCTION"
  1087 >SDL_SetError</TT
  1088 > (that
  1089 is, every time SDL signals an error) to also print an error message on
  1090 stderr.</P
  1091 ></DD
  1092 ></DL
  1093 ></DIV
  1094 ></DIV
  1095 ><DIV
  1096 CLASS="REFSECT1"
  1097 ><A
  1098 NAME="AEN1034"
  1099 ></A
  1100 ><H2
  1101 >Joystick</H2
  1102 ><P
  1103 ></P
  1104 ><DIV
  1105 CLASS="VARIABLELIST"
  1106 ><DL
  1107 ><DT
  1108 ><TT
  1109 CLASS="LITERAL"
  1110 >SDL_JOYSTICK_DEVICE</TT
  1111 ></DT
  1112 ><DD
  1113 ><P
  1114 >Joystick device to use in the linux joystick driver, in addition
  1115 to the usual: /dev/js*, /dev/input/event*, /dev/input/js*</P
  1116 ></DD
  1117 ><DT
  1118 ><TT
  1119 CLASS="LITERAL"
  1120 >SDL_LINUX_JOYSTICK</TT
  1121 ></DT
  1122 ><DD
  1123 ><P
  1124 >Special joystick configuration string for linux. The format is</P
  1125 ><P
  1126 >"<TT
  1127 CLASS="PARAMETER"
  1128 ><I
  1129 >name</I
  1130 ></TT
  1131 > <TT
  1132 CLASS="PARAMETER"
  1133 ><I
  1134 >numaxes</I
  1135 ></TT
  1136 > <TT
  1137 CLASS="PARAMETER"
  1138 ><I
  1139 >numhats</I
  1140 ></TT
  1141 > <TT
  1142 CLASS="PARAMETER"
  1143 ><I
  1144 >numballs</I
  1145 ></TT
  1146 >"</P
  1147 ><P
  1148 >where <TT
  1149 CLASS="PARAMETER"
  1150 ><I
  1151 >name</I
  1152 ></TT
  1153 > is the name string of the joystick
  1154 (possibly in single quotes), and the rest are the number of axes, hats
  1155 and balls respectively.</P
  1156 ></DD
  1157 ></DL
  1158 ></DIV
  1159 ></DIV
  1160 ><DIV
  1161 CLASS="NAVFOOTER"
  1162 ><HR
  1163 ALIGN="LEFT"
  1164 WIDTH="100%"><TABLE
  1165 SUMMARY="Footer navigation table"
  1166 WIDTH="100%"
  1167 BORDER="0"
  1168 CELLPADDING="0"
  1169 CELLSPACING="0"
  1170 ><TR
  1171 ><TD
  1172 WIDTH="33%"
  1173 ALIGN="left"
  1174 VALIGN="top"
  1175 ><A
  1176 HREF="sdlgeterror.html"
  1177 ACCESSKEY="P"
  1178 >Prev</A
  1179 ></TD
  1180 ><TD
  1181 WIDTH="34%"
  1182 ALIGN="center"
  1183 VALIGN="top"
  1184 ><A
  1185 HREF="index.html"
  1186 ACCESSKEY="H"
  1187 >Home</A
  1188 ></TD
  1189 ><TD
  1190 WIDTH="33%"
  1191 ALIGN="right"
  1192 VALIGN="top"
  1193 ><A
  1194 HREF="video.html"
  1195 ACCESSKEY="N"
  1196 >Next</A
  1197 ></TD
  1198 ></TR
  1199 ><TR
  1200 ><TD
  1201 WIDTH="33%"
  1202 ALIGN="left"
  1203 VALIGN="top"
  1204 >SDL_GetError</TD
  1205 ><TD
  1206 WIDTH="34%"
  1207 ALIGN="center"
  1208 VALIGN="top"
  1209 ><A
  1210 HREF="general.html"
  1211 ACCESSKEY="U"
  1212 >Up</A
  1213 ></TD
  1214 ><TD
  1215 WIDTH="33%"
  1216 ALIGN="right"
  1217 VALIGN="top"
  1218 >Video</TD
  1219 ></TR
  1220 ></TABLE
  1221 ></DIV
  1222 ></BODY
  1223 ></HTML
  1224 >