Source

pygame / src / doc / sndarray_doc.h

Full commit
/* Auto generated file: with makeref.py .  Docs go in src/ *.doc . */
#define DOC_PYGAMESNDARRAY "pygame module for accessing sound sample data"

#define DOC_PYGAMESNDARRAYARRAY "array(Sound) -> array\ncopy Sound samples into an array"

#define DOC_PYGAMESNDARRAYSAMPLES "samples(Sound) -> array\nreference Sound samples into an array"

#define DOC_PYGAMESNDARRAYMAKESOUND "make_sound(array) -> Sound\nconvert an array into a Sound object"

#define DOC_PYGAMESNDARRAYUSEARRAYTYPE "use_arraytype (arraytype) -> None\nSets the array system to be used for sound arrays"

#define DOC_PYGAMESNDARRAYGETARRAYTYPE "get_arraytype () -> str\nGets the currently active array type."

#define DOC_PYGAMESNDARRAYGETARRAYTYPES "get_arraytypes () -> tuple\nGets the array system types currently supported."



/* Docs in a comment... slightly easier to read. */

/*

pygame.sndarray
pygame module for accessing sound sample data

pygame.sndarray.array
 array(Sound) -> array
copy Sound samples into an array

pygame.sndarray.samples
 samples(Sound) -> array
reference Sound samples into an array

pygame.sndarray.make_sound
 make_sound(array) -> Sound
convert an array into a Sound object

pygame.sndarray.use_arraytype
 use_arraytype (arraytype) -> None
Sets the array system to be used for sound arrays

pygame.sndarray.get_arraytype
 get_arraytype () -> str
Gets the currently active array type.

pygame.sndarray.get_arraytypes
 get_arraytypes () -> tuple
Gets the array system types currently supported.

*/