mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-10-09 11:26:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

include: Fixed SDL_AudioFormat documentation.

Browse Source
This commit is contained in:
Ryan C. Gordon
2024-04-23 10:19:26 -04:00
parent 623a83f2b5
commit a96196c958
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
include/SDL_audio.h
View File

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