Document the SDL audio channel mapping
authorSam Lantinga <slouken@libsdl.org>
Fri, 20 Oct 2017 14:48:10 -0700
changeset 11640dc5774b11998
parent 11639 b72de18f13ce
child 11641 e4ffc5a1b7ea
Document the SDL audio channel mapping
include/SDL_audio.h
     1.1 --- a/include/SDL_audio.h	Fri Oct 20 10:45:38 2017 -0700
     1.2 +++ b/include/SDL_audio.h	Fri Oct 20 14:48:10 2017 -0700
     1.3 @@ -164,6 +164,15 @@
     1.4  
     1.5  /**
     1.6   *  The calculated values in this structure are calculated by SDL_OpenAudio().
     1.7 + *
     1.8 + *  For multi-channel audio, the default SDL channel mapping is:
     1.9 + *  2:  FL FR                       (stereo)
    1.10 + *  3:  FL FR LFE                   (2.1 surround)
    1.11 + *  4:  FL FR BL BR                 (quad)
    1.12 + *  5:  FL FR FC BL BR              (quad + center)
    1.13 + *  6:  FL FR FC LFE SL SR          (5.1 surround - last two can also be BL BR)
    1.14 + *  7:  FL FR FC LFE BC SL SR       (6.1 surround)
    1.15 + *  8:  FL FR FC LFE BL BR SL SR    (7.1 surround)
    1.16   */
    1.17  typedef struct SDL_AudioSpec
    1.18  {