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

include: Fixed up SDL_AudioFormat documentation. 

(this is not currently bridged to the wiki, but will be soon!)
main
Ryan C. Gordon 2024-04-10 16:07:49 -04:00
parent 38c4f29c29
commit f121553082
No known key found for this signature in database
GPG Key ID: FA148B892AB48044
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
include/SDL3/SDL_audio.h
View File

@ -54,24 +54,24 @@ extern "C" {
*/
/**
* Audio format flags.
* Audio format flags.
*
* These are what the 16 bits in SDL_AudioFormat currently mean...
* (Unspecified bits are always zero).
* These are what the 16 bits in SDL_AudioFormat currently mean...
* (Unspecified bits are always zero).
*
* \verbatim
++-----------------------sample is signed if set
||
|| ++-----------sample is bigendian if set
|| ||
|| || ++---sample is float if set
|| || ||
|| || || +---sample bit size---+
|| || || | |
15 14 13 12 11 10 09 08 07 06 05 04 03 02 01 00
\endverbatim
* ```
* ++-----------------------sample is signed if set
* ||
* || ++-----------sample is bigendian if set
* || ||
* || || ++---sample is float if set
* || || ||
* || || || +=--sample bit size--++
* || || || || ||
* 15 14 13 12 11 10 09 08 07 06 05 04 03 02 01 00
* ```
*
* There are macros in SDL 2.0 and later to query these bits.
* There are macros to query these bits.
*/
typedef Uint16 SDL_AudioFormat;