mirrors/SDL
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

audio: Update docs on channel ordering.

Browse Source
This commit is contained in:
Ryan C. Gordon 2024-06-10 20:56:28 -04:00
parent ed5993d1cb
commit d3a62d8298
No known key found for this signature in database
GPG Key ID: FA148B892AB48044
1 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
include/SDL3/SDL_audio.h
View File

@ -43,20 +43,22 @@
* if you aren't reading from a file) as a basic means to load sound data into
* your program.
*
* For multi-channel audio, the default SDL channel mapping is:
* For multi-channel audio, data is interleaved (one sample for each channel,
* then repeat). The SDL channel order is:
*
* ```
* 2: FL FR (stereo)
* 3: FL FR LFE (2.1 surround)
* 4: FL FR BL BR (quad)
* 5: FL FR LFE BL BR (4.1 surround)
* 6: FL FR FC LFE SL SR (5.1 surround - last two can also be BL BR)
* 7: FL FR FC LFE BC SL SR (6.1 surround)
* 8: FL FR FC LFE BL BR SL SR (7.1 surround)
* ```
* - Stereo: FL, FR
* - 2.1 surround: FL, FR, LFE
* - Quad: FL, FR, BL, BR
* - 4.1 surround: FL, FR, LFE, BL, BR
* - 5.1 surround: FL, FR, FC, LFE, SL, SR (last two can also be BL BR)
* - 6.1 surround: FL, FR, FC, LFE, BC, SL, SR
* - 5.1 surround: FL, FR, FC, LFE, BL, BR, SL, SR
*
* This is the same order as DirectSound expects, but applied to all
* platforms; SDL will swizzle the channels as necessary if a platform
* expects something different.
*/
#ifndef SDL_audio_h_
#define SDL_audio_h_