File: sndarray_doc.h

package info (click to toggle)
pygame 2.1.2%2Bdfsg-5
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 32,416 kB
  • sloc: ansic: 66,042; python: 46,176; javascript: 9,214; objc: 273; sh: 78; makefile: 56; cpp: 25
file content (42 lines) | stat: -rw-r--r-- 1,493 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
#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.

*/