File: surfarray_doc.h

package info (click to toggle)
pygame 2.6.1-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 43,076 kB
  • sloc: ansic: 66,932; python: 48,797; javascript: 1,153; objc: 224; sh: 121; makefile: 59; cpp: 25
file content (107 lines) | stat: -rw-r--r-- 4,187 bytes parent folder | download | duplicates (3)
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
#define DOC_PYGAMESURFARRAY "pygame module for accessing surface pixel data using array interfaces"
#define DOC_PYGAMESURFARRAYARRAY2D "array2d(Surface) -> array\nCopy pixels into a 2d array"
#define DOC_PYGAMESURFARRAYPIXELS2D "pixels2d(Surface) -> array\nReference pixels into a 2d array"
#define DOC_PYGAMESURFARRAYARRAY3D "array3d(Surface) -> array\nCopy pixels into a 3d array"
#define DOC_PYGAMESURFARRAYPIXELS3D "pixels3d(Surface) -> array\nReference pixels into a 3d array"
#define DOC_PYGAMESURFARRAYARRAYALPHA "array_alpha(Surface) -> array\nCopy pixel alphas into a 2d array"
#define DOC_PYGAMESURFARRAYPIXELSALPHA "pixels_alpha(Surface) -> array\nReference pixel alphas into a 2d array"
#define DOC_PYGAMESURFARRAYARRAYRED "array_red(Surface) -> array\nCopy red pixels into a 2d array"
#define DOC_PYGAMESURFARRAYPIXELSRED "pixels_red (Surface) -> array\nReference pixel red into a 2d array."
#define DOC_PYGAMESURFARRAYARRAYGREEN "array_green(Surface) -> array\nCopy green pixels into a 2d array"
#define DOC_PYGAMESURFARRAYPIXELSGREEN "pixels_green (Surface) -> array\nReference pixel green into a 2d array."
#define DOC_PYGAMESURFARRAYARRAYBLUE "array_blue(Surface) -> array\nCopy blue pixels into a 2d array"
#define DOC_PYGAMESURFARRAYPIXELSBLUE "pixels_blue (Surface) -> array\nReference pixel blue into a 2d array."
#define DOC_PYGAMESURFARRAYARRAYCOLORKEY "array_colorkey(Surface) -> array\nCopy the colorkey values into a 2d array"
#define DOC_PYGAMESURFARRAYMAKESURFACE "make_surface(array) -> Surface\nCopy an array to a new surface"
#define DOC_PYGAMESURFARRAYBLITARRAY "blit_array(Surface, array) -> None\nBlit directly from a array values"
#define DOC_PYGAMESURFARRAYMAPARRAY "map_array(Surface, array3d) -> array2d\nMap a 3d array into a 2d array"
#define DOC_PYGAMESURFARRAYUSEARRAYTYPE "use_arraytype (arraytype) -> None\nSets the array system to be used for surface arrays"
#define DOC_PYGAMESURFARRAYGETARRAYTYPE "get_arraytype () -> str\nGets the currently active array type."
#define DOC_PYGAMESURFARRAYGETARRAYTYPES "get_arraytypes () -> tuple\nGets the array system types currently supported."


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

/*

pygame.surfarray
pygame module for accessing surface pixel data using array interfaces

pygame.surfarray.array2d
 array2d(Surface) -> array
Copy pixels into a 2d array

pygame.surfarray.pixels2d
 pixels2d(Surface) -> array
Reference pixels into a 2d array

pygame.surfarray.array3d
 array3d(Surface) -> array
Copy pixels into a 3d array

pygame.surfarray.pixels3d
 pixels3d(Surface) -> array
Reference pixels into a 3d array

pygame.surfarray.array_alpha
 array_alpha(Surface) -> array
Copy pixel alphas into a 2d array

pygame.surfarray.pixels_alpha
 pixels_alpha(Surface) -> array
Reference pixel alphas into a 2d array

pygame.surfarray.array_red
 array_red(Surface) -> array
Copy red pixels into a 2d array

pygame.surfarray.pixels_red
 pixels_red (Surface) -> array
Reference pixel red into a 2d array.

pygame.surfarray.array_green
 array_green(Surface) -> array
Copy green pixels into a 2d array

pygame.surfarray.pixels_green
 pixels_green (Surface) -> array
Reference pixel green into a 2d array.

pygame.surfarray.array_blue
 array_blue(Surface) -> array
Copy blue pixels into a 2d array

pygame.surfarray.pixels_blue
 pixels_blue (Surface) -> array
Reference pixel blue into a 2d array.

pygame.surfarray.array_colorkey
 array_colorkey(Surface) -> array
Copy the colorkey values into a 2d array

pygame.surfarray.make_surface
 make_surface(array) -> Surface
Copy an array to a new surface

pygame.surfarray.blit_array
 blit_array(Surface, array) -> None
Blit directly from a array values

pygame.surfarray.map_array
 map_array(Surface, array3d) -> array2d
Map a 3d array into a 2d array

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

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

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

*/