Mercurial > pygame

annotate src/doc/sndarray_doc.h @ 3194:9fcb7abf3185 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Remove some gcc 4.7.2 compiler warnings
author Lenard Lindstrom <len-l@telus.net>
date Tue, 23 Apr 2013 19:53:36 -0700
parents da4302429d3b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
1 /* Auto generated file: with makeref.py . Docs go in src/ *.doc . */
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
2 #define DOC_PYGAMESNDARRAY "pygame module for accessing sound sample data"
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
3
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
4 #define DOC_PYGAMESNDARRAYARRAY "array(Sound) -> array\ncopy Sound samples into an array"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
5
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
6 #define DOC_PYGAMESNDARRAYSAMPLES "samples(Sound) -> array\nreference Sound samples into an array"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
7
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
8 #define DOC_PYGAMESNDARRAYMAKESOUND "make_sound(array) -> Sound\nconvert an array into a Sound object"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
9
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
10 #define DOC_PYGAMESNDARRAYUSEARRAYTYPE "use_arraytype (arraytype) -> None\nSets the array system to be used for sound arrays"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
11
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
12 #define DOC_PYGAMESNDARRAYGETARRAYTYPE "get_arraytype () -> str\nGets the currently active array type."
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
13
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
14 #define DOC_PYGAMESNDARRAYGETARRAYTYPES "get_arraytypes () -> tuple\nGets the array system types currently supported."
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
15
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
16
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
17
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
18 /* Docs in a comment... slightly easier to read. */
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
19
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
20 /*
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
21
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
22 pygame.sndarray
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
23 pygame module for accessing sound sample data
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
24
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
25 pygame.sndarray.array
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
26 array(Sound) -> array
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
27 copy Sound samples into an array
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
28
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
29 pygame.sndarray.samples
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
30 samples(Sound) -> array
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
31 reference Sound samples into an array
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
32
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
33 pygame.sndarray.make_sound
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
34 make_sound(array) -> Sound
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
35 convert an array into a Sound object
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
36
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
37 pygame.sndarray.use_arraytype
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
38 use_arraytype (arraytype) -> None
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
39 Sets the array system to be used for sound arrays
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
40
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
41 pygame.sndarray.get_arraytype
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
42 get_arraytype () -> str
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
43 Gets the currently active array type.
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
44
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
45 pygame.sndarray.get_arraytypes
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
46 get_arraytypes () -> tuple
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
47 Gets the array system types currently supported.
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
48
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
49 */