audio: clarified what SDL_AudioSpec::samples is, removed note about power of 2.
authorRyan C. Gordon <icculus@icculus.org>
Mon, 27 Feb 2017 10:11:40 -0500
changeset 10920ffdf6433884c
parent 10919 a4269fba748b
child 10921 f426dbef4aa0
audio: clarified what SDL_AudioSpec::samples is, removed note about power of 2.

These don't have to be power-of-2 sizes anymore because of SDL_AudioStream,
and the new resampler, but also, many platforms don't give you power-of-2 DMA
buffer in the first place!
include/SDL_audio.h
     1.1 --- a/include/SDL_audio.h	Sun Feb 26 21:20:39 2017 +0100
     1.2 +++ b/include/SDL_audio.h	Mon Feb 27 10:11:40 2017 -0500
     1.3 @@ -171,7 +171,7 @@
     1.4      SDL_AudioFormat format;     /**< Audio data format */
     1.5      Uint8 channels;             /**< Number of channels: 1 mono, 2 stereo */
     1.6      Uint8 silence;              /**< Audio buffer silence value (calculated) */
     1.7 -    Uint16 samples;             /**< Audio buffer size in samples (power of 2) */
     1.8 +    Uint16 samples;             /**< Audio buffer size in sample FRAMES (total samples divided by channel count) */
     1.9      Uint16 padding;             /**< Necessary for some compile environments */
    1.10      Uint32 size;                /**< Audio buffer size in bytes (calculated) */
    1.11      SDL_AudioCallback callback; /**< Callback that feeds the audio device (NULL to use SDL_QueueAudio()). */