docs/html/sdlenvvars.html
changeset 803 355632dca928
child 1589 34cca785be57
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/docs/html/sdlenvvars.html	Tue Feb 10 15:15:40 2004 +0000
     1.3 @@ -0,0 +1,1212 @@
     1.4 +<HTML
     1.5 +><HEAD
     1.6 +><TITLE
     1.7 +>SDL_envvars</TITLE
     1.8 +><META
     1.9 +NAME="GENERATOR"
    1.10 +CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
    1.11 +"><LINK
    1.12 +REL="HOME"
    1.13 +TITLE="SDL Library Documentation"
    1.14 +HREF="index.html"><LINK
    1.15 +REL="UP"
    1.16 +TITLE="General"
    1.17 +HREF="general.html"><LINK
    1.18 +REL="PREVIOUS"
    1.19 +TITLE="SDL_GetError"
    1.20 +HREF="sdlgeterror.html"><LINK
    1.21 +REL="NEXT"
    1.22 +TITLE="Video"
    1.23 +HREF="video.html"></HEAD
    1.24 +><BODY
    1.25 +CLASS="REFENTRY"
    1.26 +BGCOLOR="#FFF8DC"
    1.27 +TEXT="#000000"
    1.28 +LINK="#0000ee"
    1.29 +VLINK="#551a8b"
    1.30 +ALINK="#ff0000"
    1.31 +><DIV
    1.32 +CLASS="NAVHEADER"
    1.33 +><TABLE
    1.34 +SUMMARY="Header navigation table"
    1.35 +WIDTH="100%"
    1.36 +BORDER="0"
    1.37 +CELLPADDING="0"
    1.38 +CELLSPACING="0"
    1.39 +><TR
    1.40 +><TH
    1.41 +COLSPAN="3"
    1.42 +ALIGN="center"
    1.43 +>SDL Library Documentation</TH
    1.44 +></TR
    1.45 +><TR
    1.46 +><TD
    1.47 +WIDTH="10%"
    1.48 +ALIGN="left"
    1.49 +VALIGN="bottom"
    1.50 +><A
    1.51 +HREF="sdlgeterror.html"
    1.52 +ACCESSKEY="P"
    1.53 +>Prev</A
    1.54 +></TD
    1.55 +><TD
    1.56 +WIDTH="80%"
    1.57 +ALIGN="center"
    1.58 +VALIGN="bottom"
    1.59 +></TD
    1.60 +><TD
    1.61 +WIDTH="10%"
    1.62 +ALIGN="right"
    1.63 +VALIGN="bottom"
    1.64 +><A
    1.65 +HREF="video.html"
    1.66 +ACCESSKEY="N"
    1.67 +>Next</A
    1.68 +></TD
    1.69 +></TR
    1.70 +></TABLE
    1.71 +><HR
    1.72 +ALIGN="LEFT"
    1.73 +WIDTH="100%"></DIV
    1.74 +><H1
    1.75 +><A
    1.76 +NAME="SDLENVVARS"
    1.77 +></A
    1.78 +>SDL_envvars</H1
    1.79 +><DIV
    1.80 +CLASS="REFNAMEDIV"
    1.81 +><A
    1.82 +NAME="AEN675"
    1.83 +></A
    1.84 +><H2
    1.85 +>Name</H2
    1.86 +>SDL_envvars&nbsp;--&nbsp;SDL environment variables</DIV
    1.87 +><DIV
    1.88 +CLASS="REFSECT1"
    1.89 +><A
    1.90 +NAME="AEN678"
    1.91 +></A
    1.92 +><H2
    1.93 +>Description</H2
    1.94 +><P
    1.95 +>Not a function, set using setenv()</P
    1.96 +><P
    1.97 +>Several environment variables are available to modify the
    1.98 +behaviour of SDL. Using these variables isn't recommened and the names
    1.99 +and presence of these variables aren't guaranteed from one release to
   1.100 +the next. However, they can be very useful for debugging
   1.101 +purposes.</P
   1.102 +></DIV
   1.103 +><DIV
   1.104 +CLASS="REFSECT1"
   1.105 +><A
   1.106 +NAME="AEN682"
   1.107 +></A
   1.108 +><H2
   1.109 +>Video</H2
   1.110 +><P
   1.111 +></P
   1.112 +><DIV
   1.113 +CLASS="VARIABLELIST"
   1.114 +><DL
   1.115 +><DT
   1.116 +><TT
   1.117 +CLASS="LITERAL"
   1.118 +>SDL_FBACCEL</TT
   1.119 +></DT
   1.120 +><DD
   1.121 +><P
   1.122 +>If set to 0, disable hardware acceleration in the linux fbcon driver.</P
   1.123 +></DD
   1.124 +><DT
   1.125 +><TT
   1.126 +CLASS="LITERAL"
   1.127 +>SDL_FBDEV</TT
   1.128 +></DT
   1.129 +><DD
   1.130 +><P
   1.131 +>Frame buffer device to use in the linux fbcon driver, instead of /dev/fb0</P
   1.132 +></DD
   1.133 +><DT
   1.134 +><TT
   1.135 +CLASS="LITERAL"
   1.136 +>SDL_FULLSCREEN_UPDATE</TT
   1.137 +></DT
   1.138 +><DD
   1.139 +><P
   1.140 +>In the ps2gs driver, sets the <TT
   1.141 +CLASS="LITERAL"
   1.142 +>SDL_ASYNCBLIT</TT
   1.143 +> flag on the
   1.144 +display surface.</P
   1.145 +></DD
   1.146 +><DT
   1.147 +><TT
   1.148 +CLASS="LITERAL"
   1.149 +>SDL_VIDEODRIVER</TT
   1.150 +></DT
   1.151 +><DD
   1.152 +><P
   1.153 +>Selectes the video driver for SDL to use. Possible values, in the
   1.154 +order they are tried if this variable is not set:</P
   1.155 +><DIV
   1.156 +CLASS="INFORMALTABLE"
   1.157 +><A
   1.158 +NAME="AEN706"
   1.159 +></A
   1.160 +><P
   1.161 +></P
   1.162 +><TABLE
   1.163 +BORDER="0"
   1.164 +CLASS="CALSTABLE"
   1.165 +><TBODY
   1.166 +><TR
   1.167 +><TD
   1.168 +ALIGN="LEFT"
   1.169 +VALIGN="TOP"
   1.170 +><TT
   1.171 +CLASS="LITERAL"
   1.172 +>x11</TT
   1.173 +></TD
   1.174 +><TD
   1.175 +ALIGN="LEFT"
   1.176 +VALIGN="TOP"
   1.177 +><P
   1.178 +></P
   1.179 +></TD
   1.180 +></TR
   1.181 +><TR
   1.182 +><TD
   1.183 +ALIGN="LEFT"
   1.184 +VALIGN="TOP"
   1.185 +><TT
   1.186 +CLASS="LITERAL"
   1.187 +>dga</TT
   1.188 +></TD
   1.189 +><TD
   1.190 +ALIGN="LEFT"
   1.191 +VALIGN="TOP"
   1.192 +><P
   1.193 +>(the XFree86 DGA2)</P
   1.194 +></TD
   1.195 +></TR
   1.196 +><TR
   1.197 +><TD
   1.198 +ALIGN="LEFT"
   1.199 +VALIGN="TOP"
   1.200 +><TT
   1.201 +CLASS="LITERAL"
   1.202 +>nanox</TT
   1.203 +></TD
   1.204 +><TD
   1.205 +ALIGN="LEFT"
   1.206 +VALIGN="TOP"
   1.207 +><P
   1.208 +>(Linux)</P
   1.209 +></TD
   1.210 +></TR
   1.211 +><TR
   1.212 +><TD
   1.213 +ALIGN="LEFT"
   1.214 +VALIGN="TOP"
   1.215 +><TT
   1.216 +CLASS="LITERAL"
   1.217 +>fbcon</TT
   1.218 +></TD
   1.219 +><TD
   1.220 +ALIGN="LEFT"
   1.221 +VALIGN="TOP"
   1.222 +><P
   1.223 +>(Linux)</P
   1.224 +></TD
   1.225 +></TR
   1.226 +><TR
   1.227 +><TD
   1.228 +ALIGN="LEFT"
   1.229 +VALIGN="TOP"
   1.230 +><TT
   1.231 +CLASS="LITERAL"
   1.232 +>directfb</TT
   1.233 +></TD
   1.234 +><TD
   1.235 +ALIGN="LEFT"
   1.236 +VALIGN="TOP"
   1.237 +><P
   1.238 +>(Linux)</P
   1.239 +></TD
   1.240 +></TR
   1.241 +><TR
   1.242 +><TD
   1.243 +ALIGN="LEFT"
   1.244 +VALIGN="TOP"
   1.245 +><TT
   1.246 +CLASS="LITERAL"
   1.247 +>ps2gs</TT
   1.248 +></TD
   1.249 +><TD
   1.250 +ALIGN="LEFT"
   1.251 +VALIGN="TOP"
   1.252 +><P
   1.253 +>(Playstation 2)</P
   1.254 +></TD
   1.255 +></TR
   1.256 +><TR
   1.257 +><TD
   1.258 +ALIGN="LEFT"
   1.259 +VALIGN="TOP"
   1.260 +><TT
   1.261 +CLASS="LITERAL"
   1.262 +>ggi</TT
   1.263 +></TD
   1.264 +><TD
   1.265 +ALIGN="LEFT"
   1.266 +VALIGN="TOP"
   1.267 +><P
   1.268 +></P
   1.269 +></TD
   1.270 +></TR
   1.271 +><TR
   1.272 +><TD
   1.273 +ALIGN="LEFT"
   1.274 +VALIGN="TOP"
   1.275 +><TT
   1.276 +CLASS="LITERAL"
   1.277 +>vgl</TT
   1.278 +></TD
   1.279 +><TD
   1.280 +ALIGN="LEFT"
   1.281 +VALIGN="TOP"
   1.282 +><P
   1.283 +>(BSD)</P
   1.284 +></TD
   1.285 +></TR
   1.286 +><TR
   1.287 +><TD
   1.288 +ALIGN="LEFT"
   1.289 +VALIGN="TOP"
   1.290 +><TT
   1.291 +CLASS="LITERAL"
   1.292 +>svgalib</TT
   1.293 +></TD
   1.294 +><TD
   1.295 +ALIGN="LEFT"
   1.296 +VALIGN="TOP"
   1.297 +><P
   1.298 +>(Linux)</P
   1.299 +></TD
   1.300 +></TR
   1.301 +><TR
   1.302 +><TD
   1.303 +ALIGN="LEFT"
   1.304 +VALIGN="TOP"
   1.305 +><TT
   1.306 +CLASS="LITERAL"
   1.307 +>aalib</TT
   1.308 +></TD
   1.309 +><TD
   1.310 +ALIGN="LEFT"
   1.311 +VALIGN="TOP"
   1.312 +><P
   1.313 +></P
   1.314 +></TD
   1.315 +></TR
   1.316 +><TR
   1.317 +><TD
   1.318 +ALIGN="LEFT"
   1.319 +VALIGN="TOP"
   1.320 +><TT
   1.321 +CLASS="LITERAL"
   1.322 +>directx</TT
   1.323 +></TD
   1.324 +><TD
   1.325 +ALIGN="LEFT"
   1.326 +VALIGN="TOP"
   1.327 +><P
   1.328 +>(Win32)</P
   1.329 +></TD
   1.330 +></TR
   1.331 +><TR
   1.332 +><TD
   1.333 +ALIGN="LEFT"
   1.334 +VALIGN="TOP"
   1.335 +><TT
   1.336 +CLASS="LITERAL"
   1.337 +>windib</TT
   1.338 +></TD
   1.339 +><TD
   1.340 +ALIGN="LEFT"
   1.341 +VALIGN="TOP"
   1.342 +><P
   1.343 +>(Win32)</P
   1.344 +></TD
   1.345 +></TR
   1.346 +><TR
   1.347 +><TD
   1.348 +ALIGN="LEFT"
   1.349 +VALIGN="TOP"
   1.350 +><TT
   1.351 +CLASS="LITERAL"
   1.352 +>bwindow</TT
   1.353 +></TD
   1.354 +><TD
   1.355 +ALIGN="LEFT"
   1.356 +VALIGN="TOP"
   1.357 +><P
   1.358 +>(BeOS)</P
   1.359 +></TD
   1.360 +></TR
   1.361 +><TR
   1.362 +><TD
   1.363 +ALIGN="LEFT"
   1.364 +VALIGN="TOP"
   1.365 +><TT
   1.366 +CLASS="LITERAL"
   1.367 +>toolbox</TT
   1.368 +></TD
   1.369 +><TD
   1.370 +ALIGN="LEFT"
   1.371 +VALIGN="TOP"
   1.372 +><P
   1.373 +>(MacOS Classic)</P
   1.374 +></TD
   1.375 +></TR
   1.376 +><TR
   1.377 +><TD
   1.378 +ALIGN="LEFT"
   1.379 +VALIGN="TOP"
   1.380 +><TT
   1.381 +CLASS="LITERAL"
   1.382 +>DSp</TT
   1.383 +></TD
   1.384 +><TD
   1.385 +ALIGN="LEFT"
   1.386 +VALIGN="TOP"
   1.387 +><P
   1.388 +>(MacOS Classic)</P
   1.389 +></TD
   1.390 +></TR
   1.391 +><TR
   1.392 +><TD
   1.393 +ALIGN="LEFT"
   1.394 +VALIGN="TOP"
   1.395 +><TT
   1.396 +CLASS="LITERAL"
   1.397 +>Quartz</TT
   1.398 +></TD
   1.399 +><TD
   1.400 +ALIGN="LEFT"
   1.401 +VALIGN="TOP"
   1.402 +><P
   1.403 +>(MacOS X)</P
   1.404 +></TD
   1.405 +></TR
   1.406 +><TR
   1.407 +><TD
   1.408 +ALIGN="LEFT"
   1.409 +VALIGN="TOP"
   1.410 +><TT
   1.411 +CLASS="LITERAL"
   1.412 +>CGX</TT
   1.413 +></TD
   1.414 +><TD
   1.415 +ALIGN="LEFT"
   1.416 +VALIGN="TOP"
   1.417 +><P
   1.418 +>(Amiga)</P
   1.419 +></TD
   1.420 +></TR
   1.421 +><TR
   1.422 +><TD
   1.423 +ALIGN="LEFT"
   1.424 +VALIGN="TOP"
   1.425 +><TT
   1.426 +CLASS="LITERAL"
   1.427 +>photon</TT
   1.428 +></TD
   1.429 +><TD
   1.430 +ALIGN="LEFT"
   1.431 +VALIGN="TOP"
   1.432 +><P
   1.433 +>(QNX)</P
   1.434 +></TD
   1.435 +></TR
   1.436 +><TR
   1.437 +><TD
   1.438 +ALIGN="LEFT"
   1.439 +VALIGN="TOP"
   1.440 +><TT
   1.441 +CLASS="LITERAL"
   1.442 +>epoc</TT
   1.443 +></TD
   1.444 +><TD
   1.445 +ALIGN="LEFT"
   1.446 +VALIGN="TOP"
   1.447 +><P
   1.448 +>(Epoc)</P
   1.449 +></TD
   1.450 +></TR
   1.451 +><TR
   1.452 +><TD
   1.453 +ALIGN="LEFT"
   1.454 +VALIGN="TOP"
   1.455 +><TT
   1.456 +CLASS="LITERAL"
   1.457 +>dummy</TT
   1.458 +></TD
   1.459 +><TD
   1.460 +ALIGN="LEFT"
   1.461 +VALIGN="TOP"
   1.462 +><P
   1.463 +></P
   1.464 +></TD
   1.465 +></TR
   1.466 +></TBODY
   1.467 +></TABLE
   1.468 +><P
   1.469 +></P
   1.470 +></DIV
   1.471 +></DD
   1.472 +><DT
   1.473 +><TT
   1.474 +CLASS="LITERAL"
   1.475 +>SDL_VIDEO_CENTERED</TT
   1.476 +></DT
   1.477 +><DD
   1.478 +><P
   1.479 +>If set, tries to center the SDL window when running in X11 windowed
   1.480 +mode, or using the CyberGrafix driver.</P
   1.481 +></DD
   1.482 +><DT
   1.483 +><TT
   1.484 +CLASS="LITERAL"
   1.485 +>SDL_VIDEO_GL_DRIVER</TT
   1.486 +></DT
   1.487 +><DD
   1.488 +><P
   1.489 +>The openGL driver (shared library) to use for X11. Default is libGL.so.1</P
   1.490 +></DD
   1.491 +><DT
   1.492 +><TT
   1.493 +CLASS="LITERAL"
   1.494 +>SDL_VIDEO_X11_DGAMOUSE</TT
   1.495 +></DT
   1.496 +><DD
   1.497 +><P
   1.498 +>With XFree86, enables use of DGA mouse if set.</P
   1.499 +></DD
   1.500 +><DT
   1.501 +><TT
   1.502 +CLASS="LITERAL"
   1.503 +>SDL_VIDEO_X11_MOUSEACCEL</TT
   1.504 +></DT
   1.505 +><DD
   1.506 +><P
   1.507 +>For X11, sets the mouse acceleration. The value should be a string
   1.508 +on the form:</P
   1.509 +><P
   1.510 +>"<TT
   1.511 +CLASS="PARAMETER"
   1.512 +><I
   1.513 +>n</I
   1.514 +></TT
   1.515 +>/<TT
   1.516 +CLASS="PARAMETER"
   1.517 +><I
   1.518 +>d</I
   1.519 +></TT
   1.520 +>/<TT
   1.521 +CLASS="PARAMETER"
   1.522 +><I
   1.523 +>t</I
   1.524 +></TT
   1.525 +>"</P
   1.526 +><P
   1.527 +>where <TT
   1.528 +CLASS="PARAMETER"
   1.529 +><I
   1.530 +>n</I
   1.531 +></TT
   1.532 +> and <TT
   1.533 +CLASS="PARAMETER"
   1.534 +><I
   1.535 +>d</I
   1.536 +></TT
   1.537 +> are the
   1.538 +acceleration numerator/denumerators (so	mouse movement is accelerated by
   1.539 +<TT
   1.540 +CLASS="PARAMETER"
   1.541 +><I
   1.542 +>n</I
   1.543 +></TT
   1.544 +>/<TT
   1.545 +CLASS="PARAMETER"
   1.546 +><I
   1.547 +>d</I
   1.548 +></TT
   1.549 +>), and
   1.550 +<TT
   1.551 +CLASS="PARAMETER"
   1.552 +><I
   1.553 +>t</I
   1.554 +></TT
   1.555 +> is the threshold above which acceleration applies
   1.556 +(counted as number of pixels the mouse moves at once).</P
   1.557 +></DD
   1.558 +><DT
   1.559 +><TT
   1.560 +CLASS="LITERAL"
   1.561 +>SDL_VIDEO_X11_NODIRECTCOLOR</TT
   1.562 +></DT
   1.563 +><DD
   1.564 +><P
   1.565 +>If set, don't attempt to use DirectColor visuals even if they are
   1.566 +present. (SDL will use them otherwise for gamma correction).
   1.567 +This is needed with older X servers when using the XVideo extension.</P
   1.568 +></DD
   1.569 +><DT
   1.570 +><TT
   1.571 +CLASS="LITERAL"
   1.572 +>SDL_VIDEO_X11_VISUALID</TT
   1.573 +></DT
   1.574 +><DD
   1.575 +><P
   1.576 +>ID of an X11 visual to use, overriding SDL's default visual selection
   1.577 +algorithm. It can be in decimal or in hex (prefixed by 0x).</P
   1.578 +></DD
   1.579 +><DT
   1.580 +><TT
   1.581 +CLASS="LITERAL"
   1.582 +>SDL_VIDEO_YUV_DIRECT</TT
   1.583 +></DT
   1.584 +><DD
   1.585 +><P
   1.586 +>If set, display YUV overlay directly on the video surface if possible,
   1.587 +instead of on the surface passed to
   1.588 +<A
   1.589 +HREF="sdlcreateyuvoverlay.html"
   1.590 +><TT
   1.591 +CLASS="FUNCTION"
   1.592 +>SDL_CreateYUVOverlay</TT
   1.593 +></A
   1.594 +>.</P
   1.595 +></DD
   1.596 +><DT
   1.597 +><TT
   1.598 +CLASS="LITERAL"
   1.599 +>SDL_VIDEO_YUV_HWACCEL</TT
   1.600 +></DT
   1.601 +><DD
   1.602 +><P
   1.603 +>If not set or set to a nonzero value, SDL will attempt to use
   1.604 +hardware YUV acceleration for video playback.</P
   1.605 +></DD
   1.606 +><DT
   1.607 +><TT
   1.608 +CLASS="LITERAL"
   1.609 +>SDL_WINDOWID</TT
   1.610 +></DT
   1.611 +><DD
   1.612 +><P
   1.613 +>For X11 or Win32, contains the ID number of the window to be used by
   1.614 +SDL instead of creating its own window. Either in decimal or
   1.615 +in hex (prefixed by 0x).</P
   1.616 +></DD
   1.617 +></DL
   1.618 +></DIV
   1.619 +></DIV
   1.620 +><DIV
   1.621 +CLASS="REFSECT1"
   1.622 +><A
   1.623 +NAME="AEN866"
   1.624 +></A
   1.625 +><H2
   1.626 +>Events/Input</H2
   1.627 +><P
   1.628 +></P
   1.629 +><DIV
   1.630 +CLASS="VARIABLELIST"
   1.631 +><DL
   1.632 +><DT
   1.633 +><TT
   1.634 +CLASS="LITERAL"
   1.635 +>SDL_MOUSE_RELATIVE</TT
   1.636 +></DT
   1.637 +><DD
   1.638 +><P
   1.639 +>If set to 0, do not use mouse relative mode in X11. The default is
   1.640 +to use it if the mouse is hidden and input is grabbed.</P
   1.641 +></DD
   1.642 +><DT
   1.643 +><TT
   1.644 +CLASS="LITERAL"
   1.645 +>SDL_MOUSEDEV</TT
   1.646 +></DT
   1.647 +><DD
   1.648 +><P
   1.649 +>The mouse device to use for the linux fbcon driver. If not set,
   1.650 +SDL first tries to use GPM in repeater mode, then various other
   1.651 +devices (/dev/pcaux, /dev/adbmouse, /dev/mouse etc).</P
   1.652 +></DD
   1.653 +><DT
   1.654 +><TT
   1.655 +CLASS="LITERAL"
   1.656 +>SDL_MOUSEDEV_IMPS2</TT
   1.657 +></DT
   1.658 +><DD
   1.659 +><P
   1.660 +>If set, SDL will not try to auto-detect	the IMPS/2 protocol of
   1.661 +a PS/2 mouse but use it right away. For the fbcon and ps2gs drivers.</P
   1.662 +></DD
   1.663 +><DT
   1.664 +><TT
   1.665 +CLASS="LITERAL"
   1.666 +>SDL_MOUSEDRV</TT
   1.667 +></DT
   1.668 +><DD
   1.669 +><P
   1.670 +>For the linux fbcon driver: if set to ELO, use the ELO touchscreen
   1.671 +controller as a pointer device</P
   1.672 +></DD
   1.673 +><DT
   1.674 +><TT
   1.675 +CLASS="LITERAL"
   1.676 +>SDL_NO_RAWKBD</TT
   1.677 +></DT
   1.678 +><DD
   1.679 +><P
   1.680 +>For the libvga driver: If set, do not attempt to put the keyboard in raw mode.</P
   1.681 +></DD
   1.682 +><DT
   1.683 +><TT
   1.684 +CLASS="LITERAL"
   1.685 +>SDL_NOMOUSE</TT
   1.686 +></DT
   1.687 +><DD
   1.688 +><P
   1.689 +>If set, the linux fbcon driver will not use a mouse at all.</P
   1.690 +></DD
   1.691 +></DL
   1.692 +></DIV
   1.693 +></DIV
   1.694 +><DIV
   1.695 +CLASS="REFSECT1"
   1.696 +><A
   1.697 +NAME="AEN899"
   1.698 +></A
   1.699 +><H2
   1.700 +>Audio</H2
   1.701 +><P
   1.702 +></P
   1.703 +><DIV
   1.704 +CLASS="VARIABLELIST"
   1.705 +><DL
   1.706 +><DT
   1.707 +><TT
   1.708 +CLASS="LITERAL"
   1.709 +>AUDIODEV</TT
   1.710 +></DT
   1.711 +><DD
   1.712 +><P
   1.713 +>The audio device to use, if <TT
   1.714 +CLASS="LITERAL"
   1.715 +>SDL_PATH_DSP</TT
   1.716 +> isn't set.</P
   1.717 +></DD
   1.718 +><DT
   1.719 +><TT
   1.720 +CLASS="LITERAL"
   1.721 +>SDL_AUDIODRIVER</TT
   1.722 +></DT
   1.723 +><DD
   1.724 +><P
   1.725 +>Selects the audio driver for SDL to use. Possible values, in the
   1.726 +order they are tried if this variable is not set:</P
   1.727 +><DIV
   1.728 +CLASS="INFORMALTABLE"
   1.729 +><A
   1.730 +NAME="AEN913"
   1.731 +></A
   1.732 +><P
   1.733 +></P
   1.734 +><TABLE
   1.735 +BORDER="0"
   1.736 +CLASS="CALSTABLE"
   1.737 +><TBODY
   1.738 +><TR
   1.739 +><TD
   1.740 +ALIGN="LEFT"
   1.741 +VALIGN="TOP"
   1.742 +><TT
   1.743 +CLASS="LITERAL"
   1.744 +>openbsd</TT
   1.745 +></TD
   1.746 +><TD
   1.747 +ALIGN="LEFT"
   1.748 +VALIGN="TOP"
   1.749 +><P
   1.750 +>(OpenBSD)</P
   1.751 +></TD
   1.752 +></TR
   1.753 +><TR
   1.754 +><TD
   1.755 +ALIGN="LEFT"
   1.756 +VALIGN="TOP"
   1.757 +><TT
   1.758 +CLASS="LITERAL"
   1.759 +>dsp</TT
   1.760 +></TD
   1.761 +><TD
   1.762 +ALIGN="LEFT"
   1.763 +VALIGN="TOP"
   1.764 +><P
   1.765 +>(OSS /dev/dsp: Linux, Solaris, BSD etc)</P
   1.766 +></TD
   1.767 +></TR
   1.768 +><TR
   1.769 +><TD
   1.770 +ALIGN="LEFT"
   1.771 +VALIGN="TOP"
   1.772 +><TT
   1.773 +CLASS="LITERAL"
   1.774 +>alsa</TT
   1.775 +></TD
   1.776 +><TD
   1.777 +ALIGN="LEFT"
   1.778 +VALIGN="TOP"
   1.779 +><P
   1.780 +>(Linux)</P
   1.781 +></TD
   1.782 +></TR
   1.783 +><TR
   1.784 +><TD
   1.785 +ALIGN="LEFT"
   1.786 +VALIGN="TOP"
   1.787 +><TT
   1.788 +CLASS="LITERAL"
   1.789 +>audio</TT
   1.790 +></TD
   1.791 +><TD
   1.792 +ALIGN="LEFT"
   1.793 +VALIGN="TOP"
   1.794 +><P
   1.795 +>(Unix style /dev/audio: SunOS, Solaris etc)</P
   1.796 +></TD
   1.797 +></TR
   1.798 +><TR
   1.799 +><TD
   1.800 +ALIGN="LEFT"
   1.801 +VALIGN="TOP"
   1.802 +><TT
   1.803 +CLASS="LITERAL"
   1.804 +>AL</TT
   1.805 +></TD
   1.806 +><TD
   1.807 +ALIGN="LEFT"
   1.808 +VALIGN="TOP"
   1.809 +><P
   1.810 +>(Irix)</P
   1.811 +></TD
   1.812 +></TR
   1.813 +><TR
   1.814 +><TD
   1.815 +ALIGN="LEFT"
   1.816 +VALIGN="TOP"
   1.817 +><TT
   1.818 +CLASS="LITERAL"
   1.819 +>artsc</TT
   1.820 +></TD
   1.821 +><TD
   1.822 +ALIGN="LEFT"
   1.823 +VALIGN="TOP"
   1.824 +><P
   1.825 +>(ARTS audio daemon)</P
   1.826 +></TD
   1.827 +></TR
   1.828 +><TR
   1.829 +><TD
   1.830 +ALIGN="LEFT"
   1.831 +VALIGN="TOP"
   1.832 +><TT
   1.833 +CLASS="LITERAL"
   1.834 +>esd</TT
   1.835 +></TD
   1.836 +><TD
   1.837 +ALIGN="LEFT"
   1.838 +VALIGN="TOP"
   1.839 +><P
   1.840 +>(esound audio daemon)</P
   1.841 +></TD
   1.842 +></TR
   1.843 +><TR
   1.844 +><TD
   1.845 +ALIGN="LEFT"
   1.846 +VALIGN="TOP"
   1.847 +><TT
   1.848 +CLASS="LITERAL"
   1.849 +>nas</TT
   1.850 +></TD
   1.851 +><TD
   1.852 +ALIGN="LEFT"
   1.853 +VALIGN="TOP"
   1.854 +><P
   1.855 +>(NAS audio daemon)</P
   1.856 +></TD
   1.857 +></TR
   1.858 +><TR
   1.859 +><TD
   1.860 +ALIGN="LEFT"
   1.861 +VALIGN="TOP"
   1.862 +><TT
   1.863 +CLASS="LITERAL"
   1.864 +>dma</TT
   1.865 +></TD
   1.866 +><TD
   1.867 +ALIGN="LEFT"
   1.868 +VALIGN="TOP"
   1.869 +><P
   1.870 +>(OSS /dev/dsp, using DMA)</P
   1.871 +></TD
   1.872 +></TR
   1.873 +><TR
   1.874 +><TD
   1.875 +ALIGN="LEFT"
   1.876 +VALIGN="TOP"
   1.877 +><TT
   1.878 +CLASS="LITERAL"
   1.879 +>dsound</TT
   1.880 +></TD
   1.881 +><TD
   1.882 +ALIGN="LEFT"
   1.883 +VALIGN="TOP"
   1.884 +><P
   1.885 +>(Win32 DirectX)</P
   1.886 +></TD
   1.887 +></TR
   1.888 +><TR
   1.889 +><TD
   1.890 +ALIGN="LEFT"
   1.891 +VALIGN="TOP"
   1.892 +><TT
   1.893 +CLASS="LITERAL"
   1.894 +>waveout</TT
   1.895 +></TD
   1.896 +><TD
   1.897 +ALIGN="LEFT"
   1.898 +VALIGN="TOP"
   1.899 +><P
   1.900 +>(Win32 WaveOut)</P
   1.901 +></TD
   1.902 +></TR
   1.903 +><TR
   1.904 +><TD
   1.905 +ALIGN="LEFT"
   1.906 +VALIGN="TOP"
   1.907 +><TT
   1.908 +CLASS="LITERAL"
   1.909 +>baudio</TT
   1.910 +></TD
   1.911 +><TD
   1.912 +ALIGN="LEFT"
   1.913 +VALIGN="TOP"
   1.914 +><P
   1.915 +>(BeOS)</P
   1.916 +></TD
   1.917 +></TR
   1.918 +><TR
   1.919 +><TD
   1.920 +ALIGN="LEFT"
   1.921 +VALIGN="TOP"
   1.922 +><TT
   1.923 +CLASS="LITERAL"
   1.924 +>sndmgr</TT
   1.925 +></TD
   1.926 +><TD
   1.927 +ALIGN="LEFT"
   1.928 +VALIGN="TOP"
   1.929 +><P
   1.930 +>(MacOS SoundManager)</P
   1.931 +></TD
   1.932 +></TR
   1.933 +><TR
   1.934 +><TD
   1.935 +ALIGN="LEFT"
   1.936 +VALIGN="TOP"
   1.937 +><TT
   1.938 +CLASS="LITERAL"
   1.939 +>paud</TT
   1.940 +></TD
   1.941 +><TD
   1.942 +ALIGN="LEFT"
   1.943 +VALIGN="TOP"
   1.944 +><P
   1.945 +>(AIX)</P
   1.946 +></TD
   1.947 +></TR
   1.948 +><TR
   1.949 +><TD
   1.950 +ALIGN="LEFT"
   1.951 +VALIGN="TOP"
   1.952 +><TT
   1.953 +CLASS="LITERAL"
   1.954 +>AHI</TT
   1.955 +></TD
   1.956 +><TD
   1.957 +ALIGN="LEFT"
   1.958 +VALIGN="TOP"
   1.959 +><P
   1.960 +>(Amiga)</P
   1.961 +></TD
   1.962 +></TR
   1.963 +><TR
   1.964 +><TD
   1.965 +ALIGN="LEFT"
   1.966 +VALIGN="TOP"
   1.967 +><TT
   1.968 +CLASS="LITERAL"
   1.969 +>disk</TT
   1.970 +></TD
   1.971 +><TD
   1.972 +ALIGN="LEFT"
   1.973 +VALIGN="TOP"
   1.974 +><P
   1.975 +>(all; output to file)</P
   1.976 +></TD
   1.977 +></TR
   1.978 +></TBODY
   1.979 +></TABLE
   1.980 +><P
   1.981 +></P
   1.982 +></DIV
   1.983 +></DD
   1.984 +><DT
   1.985 +><TT
   1.986 +CLASS="LITERAL"
   1.987 +>SDL_DISKAUDIOFILE</TT
   1.988 +></DT
   1.989 +><DD
   1.990 +><P
   1.991 +>The name of the output file for the "disk" audio driver. If not
   1.992 +set, the name <TT
   1.993 +CLASS="LITERAL"
   1.994 +>sdlaudio.raw</TT
   1.995 +> is used.</P
   1.996 +></DD
   1.997 +><DT
   1.998 +><TT
   1.999 +CLASS="LITERAL"
  1.1000 +>SDL_DISKAUDIODELAY</TT
  1.1001 +></DT
  1.1002 +><DD
  1.1003 +><P
  1.1004 +>For the "disk" audio driver, how long to wait (in ms) before writing
  1.1005 +a full sound buffer. The default is 150 ms.</P
  1.1006 +></DD
  1.1007 +><DT
  1.1008 +><TT
  1.1009 +CLASS="LITERAL"
  1.1010 +>SDL_DSP_NOSELECT</TT
  1.1011 +></DT
  1.1012 +><DD
  1.1013 +><P
  1.1014 +>For some audio drivers (alsa, paud, dma and dsp), don't use select()
  1.1015 +but a timed method instead. May cure some audio problems, or cause
  1.1016 +others.</P
  1.1017 +></DD
  1.1018 +><DT
  1.1019 +><TT
  1.1020 +CLASS="LITERAL"
  1.1021 +>SDL_PATH_DSP</TT
  1.1022 +></DT
  1.1023 +><DD
  1.1024 +><P
  1.1025 +>The audio device to use. If not set, SDL tries AUDIODEV and then
  1.1026 +a platform-dependent default value (/dev/audio on Solaris,
  1.1027 +/dev/dsp on Linux etc).</P
  1.1028 +></DD
  1.1029 +></DL
  1.1030 +></DIV
  1.1031 +></DIV
  1.1032 +><DIV
  1.1033 +CLASS="REFSECT1"
  1.1034 +><A
  1.1035 +NAME="AEN1017"
  1.1036 +></A
  1.1037 +><H2
  1.1038 +>CD-ROM</H2
  1.1039 +><P
  1.1040 +></P
  1.1041 +><DIV
  1.1042 +CLASS="VARIABLELIST"
  1.1043 +><DL
  1.1044 +><DT
  1.1045 +><TT
  1.1046 +CLASS="LITERAL"
  1.1047 +>SDL_CDROM</TT
  1.1048 +></DT
  1.1049 +><DD
  1.1050 +><P
  1.1051 +>A colon-separated list of CD-ROM devices to use, in addition to
  1.1052 +the standard devices (typically /dev/cdrom, platform-dependent).</P
  1.1053 +></DD
  1.1054 +></DL
  1.1055 +></DIV
  1.1056 +></DIV
  1.1057 +><DIV
  1.1058 +CLASS="REFSECT1"
  1.1059 +><A
  1.1060 +NAME="AEN1025"
  1.1061 +></A
  1.1062 +><H2
  1.1063 +>Debugging</H2
  1.1064 +><P
  1.1065 +></P
  1.1066 +><DIV
  1.1067 +CLASS="VARIABLELIST"
  1.1068 +><DL
  1.1069 +><DT
  1.1070 +><TT
  1.1071 +CLASS="LITERAL"
  1.1072 +>SDL_DEBUG</TT
  1.1073 +></DT
  1.1074 +><DD
  1.1075 +><P
  1.1076 +>If set, causes every call to <TT
  1.1077 +CLASS="FUNCTION"
  1.1078 +>SDL_SetError</TT
  1.1079 +> (that
  1.1080 +is, every time SDL signals an error) to also print an error message on
  1.1081 +stderr.</P
  1.1082 +></DD
  1.1083 +></DL
  1.1084 +></DIV
  1.1085 +></DIV
  1.1086 +><DIV
  1.1087 +CLASS="REFSECT1"
  1.1088 +><A
  1.1089 +NAME="AEN1034"
  1.1090 +></A
  1.1091 +><H2
  1.1092 +>Joystick</H2
  1.1093 +><P
  1.1094 +></P
  1.1095 +><DIV
  1.1096 +CLASS="VARIABLELIST"
  1.1097 +><DL
  1.1098 +><DT
  1.1099 +><TT
  1.1100 +CLASS="LITERAL"
  1.1101 +>SDL_JOYSTICK_DEVICE</TT
  1.1102 +></DT
  1.1103 +><DD
  1.1104 +><P
  1.1105 +>Joystick device to use in the linux joystick driver, in addition
  1.1106 +to the usual: /dev/js*, /dev/input/event*, /dev/input/js*</P
  1.1107 +></DD
  1.1108 +><DT
  1.1109 +><TT
  1.1110 +CLASS="LITERAL"
  1.1111 +>SDL_LINUX_JOYSTICK</TT
  1.1112 +></DT
  1.1113 +><DD
  1.1114 +><P
  1.1115 +>Special joystick configuration string for linux. The format is</P
  1.1116 +><P
  1.1117 +>"<TT
  1.1118 +CLASS="PARAMETER"
  1.1119 +><I
  1.1120 +>name</I
  1.1121 +></TT
  1.1122 +> <TT
  1.1123 +CLASS="PARAMETER"
  1.1124 +><I
  1.1125 +>numaxes</I
  1.1126 +></TT
  1.1127 +> <TT
  1.1128 +CLASS="PARAMETER"
  1.1129 +><I
  1.1130 +>numhats</I
  1.1131 +></TT
  1.1132 +> <TT
  1.1133 +CLASS="PARAMETER"
  1.1134 +><I
  1.1135 +>numballs</I
  1.1136 +></TT
  1.1137 +>"</P
  1.1138 +><P
  1.1139 +>where <TT
  1.1140 +CLASS="PARAMETER"
  1.1141 +><I
  1.1142 +>name</I
  1.1143 +></TT
  1.1144 +> is the name string of the joystick
  1.1145 +(possibly in single quotes), and the rest are the number of axes, hats
  1.1146 +and balls respectively.</P
  1.1147 +></DD
  1.1148 +></DL
  1.1149 +></DIV
  1.1150 +></DIV
  1.1151 +><DIV
  1.1152 +CLASS="NAVFOOTER"
  1.1153 +><HR
  1.1154 +ALIGN="LEFT"
  1.1155 +WIDTH="100%"><TABLE
  1.1156 +SUMMARY="Footer navigation table"
  1.1157 +WIDTH="100%"
  1.1158 +BORDER="0"
  1.1159 +CELLPADDING="0"
  1.1160 +CELLSPACING="0"
  1.1161 +><TR
  1.1162 +><TD
  1.1163 +WIDTH="33%"
  1.1164 +ALIGN="left"
  1.1165 +VALIGN="top"
  1.1166 +><A
  1.1167 +HREF="sdlgeterror.html"
  1.1168 +ACCESSKEY="P"
  1.1169 +>Prev</A
  1.1170 +></TD
  1.1171 +><TD
  1.1172 +WIDTH="34%"
  1.1173 +ALIGN="center"
  1.1174 +VALIGN="top"
  1.1175 +><A
  1.1176 +HREF="index.html"
  1.1177 +ACCESSKEY="H"
  1.1178 +>Home</A
  1.1179 +></TD
  1.1180 +><TD
  1.1181 +WIDTH="33%"
  1.1182 +ALIGN="right"
  1.1183 +VALIGN="top"
  1.1184 +><A
  1.1185 +HREF="video.html"
  1.1186 +ACCESSKEY="N"
  1.1187 +>Next</A
  1.1188 +></TD
  1.1189 +></TR
  1.1190 +><TR
  1.1191 +><TD
  1.1192 +WIDTH="33%"
  1.1193 +ALIGN="left"
  1.1194 +VALIGN="top"
  1.1195 +>SDL_GetError</TD
  1.1196 +><TD
  1.1197 +WIDTH="34%"
  1.1198 +ALIGN="center"
  1.1199 +VALIGN="top"
  1.1200 +><A
  1.1201 +HREF="general.html"
  1.1202 +ACCESSKEY="U"
  1.1203 +>Up</A
  1.1204 +></TD
  1.1205 +><TD
  1.1206 +WIDTH="33%"
  1.1207 +ALIGN="right"
  1.1208 +VALIGN="top"
  1.1209 +>Video</TD
  1.1210 +></TR
  1.1211 +></TABLE
  1.1212 +></DIV
  1.1213 +></BODY
  1.1214 +></HTML
  1.1215 +>
  1.1216 \ No newline at end of file