Added a note about aligning SDL_AudioCVT data.
authorRyan C. Gordon <icculus@icculus.org>
Tue, 24 Jan 2017 00:55:41 -0500
changeset 10845c2b0d3d180f4
parent 10844 936e8095db14
child 10846 32efb3bc4db5
Added a note about aligning SDL_AudioCVT data.
include/SDL_audio.h
     1.1 --- a/include/SDL_audio.h	Tue Jan 24 00:51:33 2017 -0500
     1.2 +++ b/include/SDL_audio.h	Tue Jan 24 00:55:41 2017 -0500
     1.3 @@ -185,6 +185,12 @@
     1.4  
     1.5  /**
     1.6   *  A structure to hold a set of audio conversion filters and buffers.
     1.7 + *
     1.8 + *  Note that various parts of the conversion pipeline can take advantage
     1.9 + *  of SIMD operations (like SSE2, for example). SDL_AudioCVT doesn't require
    1.10 + *  you to pass it aligned data, but can possibly run much faster if you
    1.11 + *  set both its (buf) field to a pointer that is aligned to 16 bytes, and its
    1.12 + *  (len) field to something that's a multiple of 16, if possible.
    1.13   */
    1.14  #ifdef __GNUC__
    1.15  /* This structure is 84 bytes on 32-bit architectures, make sure GCC doesn't