env-vars.txt

   1 Useful Environment Variables
   2
   3 Below is a list of environment variables that can be set to aid with running or
   4 debugging apps that use OpenAL Soft. They should be set before the app is run.
   5
   6 *** Logging ***
   7
   8 ALSOFT_LOGLEVEL
   9 Specifies the amount of logging OpenAL Soft will write out:
  10 0 - Effectively disables all logging
  11 1 - Prints out errors only
  12 2 - Prints out warnings and errors
  13 3 - Prints out additional information, as well as warnings and errors
  14 4 - Same as 3, but also device and context reference count changes. This will
  15     print out *a lot* of info, and is generally not useful unless you're trying
  16     to track a reference leak within the library.
  17
  18 ALSOFT_LOGFILE
  19 Specifies a filename that logged output will be written to. Note that the file
  20 will be first cleared when logging is initialized.
  21
  22 *** Overrides ***
  23
  24 ALSOFT_CONF
  25 Specifies an additional configuration file to load settings from. These
  26 settings will take precedence over the global and user configs, but not other
  27 environment variable settings.
  28
  29 ALSOFT_DRIVERS
  30 Overrides the drivers config option. This specifies which backend drivers to
  31 consider or not consider for use. Please see the drivers option in
  32 alsoftrc.sample for a list of available drivers.
  33
  34 ALSOFT_DEFAULT_REVERB
  35 Specifies the default reverb preset to apply to sources. Please see the
  36 default-reverb option in alsoftrc.sample for additional information and a list
  37 of available presets.
  38
  39 ALSOFT_TRAP_AL_ERROR
  40 Set to "true" or "1" to force trapping AL errors. Like the trap-al-error config
  41 option, this will raise a SIGTRAP signal (or a breakpoint exception under
  42 Windows) when a context-level error is generated. Useful when run under a
  43 debugger as it will break execution right when the error occurs, making it
  44 easier to track the cause.
  45
  46 ALSOFT_TRAP_ALC_ERROR
  47 Set to "true" or "1" to force trapping ALC errors. Like the trap-alc-error
  48 config option, this will raise a SIGTRAP signal (or a breakpoint exception
  49 under Windows) when a device-level error is generated. Useful when run under a
  50 debugger as it will break execution right when the error occurs, making it
  51 easier to track the cause.
  52
  53 ALSOFT_TRAP_ERROR
  54 Set to "true" or "1" to force trapping both ALC and AL errors.
  55
  56 *** Compatibility ***
  57
  58 __ALSOFT_HALF_ANGLE_CONES
  59 Older versions of OpenAL Soft incorrectly calculated the cone angles to range
  60 between 0 and 180 degrees, instead of the expected range of 0 to 360 degrees.
  61 Setting this to "true" or "1" restores the old buggy behavior, for apps that
  62 were written to expect the incorrect range.
  63
  64 __ALSOFT_REVERSE_Z
  65 Applications that don't natively use OpenAL's coordinate system have to convert
  66 to it before passing in 3D coordinates. Depending on how exactly this is done,
  67 it can cause correct output for stereo but incorrect Z panning for surround
  68 sound (i.e., sounds that are supposed to be behind you sound like they're in
  69 front, and vice-versa). Setting this to "true" or "1" will negate the localized
  70 Z coordinate to attempt to fix output for apps that have incorrect front/back
  71 panning.