pygame / src / doc / sndarray_doc.h

/* 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.

*/
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.