Mercurial > pygame

annotate src/doc/surface_doc.h @ 3172:d1b367fc08bc tests-returncode

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Use a return code of 1 when the tests fail.
author Thomas Kluyver <takowl@gmail.com>
date Wed, 09 Jan 2013 10:13:57 +0000
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 . */
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
2 #define DOC_PYGAMESURFACE "Surface((width, height), flags=0, depth=0, masks=None) -> Surface\nSurface((width, height), flags=0, Surface) -> Surface\npygame object for representing images"
1937
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: 2166
diff changeset
4 #define DOC_SURFACEBLIT "blit(source, dest, area=None, special_flags = 0) -> Rect\ndraw one image onto another"
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: 2166
diff changeset
6 #define DOC_SURFACECONVERT "convert(Surface) -> Surface\nconvert(depth, flags=0) -> Surface\nconvert(masks, flags=0) -> Surface\nconvert() -> Surface\nchange the pixel format of an image"
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: 2166
diff changeset
8 #define DOC_SURFACECONVERTALPHA "convert_alpha(Surface) -> Surface\nconvert_alpha() -> Surface\nchange the pixel format of an image including per pixel alphas"
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: 2166
diff changeset
10 #define DOC_SURFACECOPY "copy() -> Surface\ncreate a new copy of a Surface"
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: 2166
diff changeset
12 #define DOC_SURFACEFILL "fill(color, rect=None, special_flags=0) -> Rect\nfill Surface with a solid color"
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: 2166
diff changeset
14 #define DOC_SURFACESCROLL "scroll(dx=0, dy=0) -> None\nShift the surface image in place"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
15
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
16 #define DOC_SURFACESETCOLORKEY "set_colorkey(Color, flags=0) -> None\nset_colorkey(None) -> None\nSet the transparent colorkey"
1937
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: 2166
diff changeset
18 #define DOC_SURFACEGETCOLORKEY "get_colorkey() -> RGB or None\nGet the current transparent colorkey"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
19
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
20 #define DOC_SURFACESETALPHA "set_alpha(value, flags=0) -> None\nset_alpha(None) -> None\nset the alpha value for the full Surface image"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
21
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
22 #define DOC_SURFACEGETALPHA "get_alpha() -> int_value or None\nget the current Surface transparency value"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
23
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
24 #define DOC_SURFACELOCK "lock() -> None\nlock the Surface memory for pixel access"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
25
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
26 #define DOC_SURFACEUNLOCK "unlock() -> None\nunlock the Surface memory from pixel access"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
27
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
28 #define DOC_SURFACEMUSTLOCK "mustlock() -> bool\ntest if the Surface requires locking"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
29
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
30 #define DOC_SURFACEGETLOCKED "get_locked() -> bool\ntest if the Surface is current locked"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
31
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
32 #define DOC_SURFACEGETLOCKS "get_locks() -> tuple\nGets the locks for the Surface"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
33
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
34 #define DOC_SURFACEGETAT "get_at((x, y)) -> Color\nget the color value at a single pixel"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
35
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
36 #define DOC_SURFACESETAT "set_at((x, y), Color) -> None\nset the color value for a single pixel"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
37
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
38 #define DOC_SURFACEGETATMAPPED "get_at_mapped((x, y)) -> Color\nget the mapped color value at a single pixel"
2137
e4a059ae7977 add updates to surface.c, etc that were skipped in the merge with the surface_buffer branch
Lenard Lindstrom <len-l@telus.net>
parents: 2131
diff changeset
39
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
40 #define DOC_SURFACEGETPALETTE "get_palette() -> [RGB, RGB, RGB, ...]\nget the color index palette for an 8bit Surface"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
41
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
42 #define DOC_SURFACEGETPALETTEAT "get_palette_at(index) -> RGB\nget the color for a single entry in a palette"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
43
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
44 #define DOC_SURFACESETPALETTE "set_palette([RGB, RGB, RGB, ...]) -> None\nset the color palette for an 8bit Surface"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
45
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
46 #define DOC_SURFACESETPALETTEAT "set_palette_at(index, RGB) -> None\nset the color for a single index in an 8bit Surface palette"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
47
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
48 #define DOC_SURFACEMAPRGB "map_rgb(Color) -> mapped_int\nconvert a color into a mapped color value"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
49
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
50 #define DOC_SURFACEUNMAPRGB "unmap_rgb(mapped_int) -> Color\nconvert a mapped integer color value into a Color"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
51
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
52 #define DOC_SURFACESETCLIP "set_clip(rect) -> None\nset_clip(None) -> None\nset the current clipping area of the Surface"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
53
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
54 #define DOC_SURFACEGETCLIP "get_clip() -> Rect\nget the current clipping area of the Surface"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
55
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
56 #define DOC_SURFACESUBSURFACE "subsurface(Rect) -> Surface\ncreate a new surface that references its parent"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
57
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
58 #define DOC_SURFACEGETPARENT "get_parent() -> Surface\nfind the parent of a subsurface"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
59
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
60 #define DOC_SURFACEGETABSPARENT "get_abs_parent() -> Surface\nfind the top level parent of a subsurface"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
61
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
62 #define DOC_SURFACEGETOFFSET "get_offset() -> (x, y)\nfind the position of a child subsurface inside a parent"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
63
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
64 #define DOC_SURFACEGETABSOFFSET "get_abs_offset() -> (x, y)\nfind the absolute position of a child subsurface inside its top level parent"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
65
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
66 #define DOC_SURFACEGETSIZE "get_size() -> (width, height)\nget the dimensions of the Surface"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
67
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
68 #define DOC_SURFACEGETWIDTH "get_width() -> width\nget the width of the Surface"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
69
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
70 #define DOC_SURFACEGETHEIGHT "get_height() -> height\nget the height of the Surface"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
71
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
72 #define DOC_SURFACEGETRECT "get_rect(**kwargs) -> Rect\nget the rectangular area of the Surface"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
73
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
74 #define DOC_SURFACEGETBITSIZE "get_bitsize() -> int\nget the bit depth of the Surface pixel format"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
75
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
76 #define DOC_SURFACEGETBYTESIZE "get_bytesize() -> int\nget the bytes used per Surface pixel"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
77
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
78 #define DOC_SURFACEGETFLAGS "get_flags() -> int\nget the additional flags used for the Surface"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
79
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
80 #define DOC_SURFACEGETPITCH "get_pitch() -> int\nget the number of bytes used per Surface row"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
81
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
82 #define DOC_SURFACEGETMASKS "get_masks() -> (R, G, B, A)\nthe bitmasks needed to convert between a color and a mapped integer"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
83
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
84 #define DOC_SURFACESETMASKS "set_masks((r,g,b,a)) -> None\nset the bitmasks needed to convert between a color and a mapped integer"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
85
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
86 #define DOC_SURFACEGETSHIFTS "get_shifts() -> (R, G, B, A)\nthe bit shifts needed to convert between a color and a mapped integer"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
87
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
88 #define DOC_SURFACESETSHIFTS "set_shifts((r,g,b,a)) -> None\nsets the bit shifts needed to convert between a color and a mapped integer"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
89
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
90 #define DOC_SURFACEGETLOSSES "get_losses() -> (R, G, B, A)\nthe significant bits used to convert between a color and a mapped integer"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
91
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
92 #define DOC_SURFACEGETBOUNDINGRECT "get_bounding_rect(min_alpha = 1) -> Rect\nfind the smallest rect containing data"
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
93
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
94 #define DOC_SURFACEGETVIEW "get_view(kind='2') -> <view>\nreturn a view of a surface's pixel data."
2131
018779fb04f5 Merge the buffer branch back into trunk.
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
95
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
96 #define DOC_SURFACEGETBUFFER "get_buffer() -> BufferProxy\nacquires a buffer object for the pixels of the Surface."
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
97
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
98
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
99
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
100 /* Docs in a comment... slightly easier to read. */
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
101
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
102 /*
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
103
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
104 pygame.Surface
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
105 Surface((width, height), flags=0, depth=0, masks=None) -> Surface
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
106 Surface((width, height), flags=0, Surface) -> Surface
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
107 pygame object for representing images
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
108
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
109 pygame.Surface.blit
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
110 blit(source, dest, area=None, special_flags = 0) -> Rect
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
111 draw one image onto another
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
112
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
113 pygame.Surface.convert
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
114 convert(Surface) -> Surface
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
115 convert(depth, flags=0) -> Surface
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
116 convert(masks, flags=0) -> Surface
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
117 convert() -> Surface
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
118 change the pixel format of an image
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
119
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
120 pygame.Surface.convert_alpha
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
121 convert_alpha(Surface) -> Surface
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
122 convert_alpha() -> Surface
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
123 change the pixel format of an image including per pixel alphas
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
124
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
125 pygame.Surface.copy
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
126 copy() -> Surface
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
127 create a new copy of a Surface
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
128
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
129 pygame.Surface.fill
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
130 fill(color, rect=None, special_flags=0) -> Rect
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
131 fill Surface with a solid color
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
132
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
133 pygame.Surface.scroll
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
134 scroll(dx=0, dy=0) -> None
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
135 Shift the surface image in place
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
136
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
137 pygame.Surface.set_colorkey
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
138 set_colorkey(Color, flags=0) -> None
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
139 set_colorkey(None) -> None
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
140 Set the transparent colorkey
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
141
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
142 pygame.Surface.get_colorkey
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
143 get_colorkey() -> RGB or None
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
144 Get the current transparent colorkey
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
145
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
146 pygame.Surface.set_alpha
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
147 set_alpha(value, flags=0) -> None
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
148 set_alpha(None) -> None
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
149 set the alpha value for the full Surface image
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
150
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
151 pygame.Surface.get_alpha
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
152 get_alpha() -> int_value or None
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
153 get the current Surface transparency value
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
154
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
155 pygame.Surface.lock
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
156 lock() -> None
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
157 lock the Surface memory for pixel access
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
158
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
159 pygame.Surface.unlock
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
160 unlock() -> None
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
161 unlock the Surface memory from pixel access
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
162
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
163 pygame.Surface.mustlock
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
164 mustlock() -> bool
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
165 test if the Surface requires locking
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
166
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
167 pygame.Surface.get_locked
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
168 get_locked() -> bool
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
169 test if the Surface is current locked
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
170
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
171 pygame.Surface.get_locks
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
172 get_locks() -> tuple
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
173 Gets the locks for the Surface
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
174
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
175 pygame.Surface.get_at
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
176 get_at((x, y)) -> Color
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
177 get the color value at a single pixel
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
178
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
179 pygame.Surface.set_at
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
180 set_at((x, y), Color) -> None
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
181 set the color value for a single pixel
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
182
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
183 pygame.Surface.get_at_mapped
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
184 get_at_mapped((x, y)) -> Color
2137
e4a059ae7977 add updates to surface.c, etc that were skipped in the merge with the surface_buffer branch
Lenard Lindstrom <len-l@telus.net>
parents: 2131
diff changeset
185 get the mapped color value at a single pixel
e4a059ae7977 add updates to surface.c, etc that were skipped in the merge with the surface_buffer branch
Lenard Lindstrom <len-l@telus.net>
parents: 2131
diff changeset
186
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
187 pygame.Surface.get_palette
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
188 get_palette() -> [RGB, RGB, RGB, ...]
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
189 get the color index palette for an 8bit Surface
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
190
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
191 pygame.Surface.get_palette_at
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
192 get_palette_at(index) -> RGB
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
193 get the color for a single entry in a palette
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
194
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
195 pygame.Surface.set_palette
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
196 set_palette([RGB, RGB, RGB, ...]) -> None
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
197 set the color palette for an 8bit Surface
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
198
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
199 pygame.Surface.set_palette_at
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
200 set_palette_at(index, RGB) -> None
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
201 set the color for a single index in an 8bit Surface palette
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
202
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
203 pygame.Surface.map_rgb
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
204 map_rgb(Color) -> mapped_int
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
205 convert a color into a mapped color value
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
206
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
207 pygame.Surface.unmap_rgb
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
208 unmap_rgb(mapped_int) -> Color
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
209 convert a mapped integer color value into a Color
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
210
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
211 pygame.Surface.set_clip
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
212 set_clip(rect) -> None
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
213 set_clip(None) -> None
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
214 set the current clipping area of the Surface
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
215
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
216 pygame.Surface.get_clip
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
217 get_clip() -> Rect
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
218 get the current clipping area of the Surface
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
219
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
220 pygame.Surface.subsurface
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
221 subsurface(Rect) -> Surface
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
222 create a new surface that references its parent
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
223
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
224 pygame.Surface.get_parent
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
225 get_parent() -> Surface
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
226 find the parent of a subsurface
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
227
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
228 pygame.Surface.get_abs_parent
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
229 get_abs_parent() -> Surface
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
230 find the top level parent of a subsurface
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
231
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
232 pygame.Surface.get_offset
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
233 get_offset() -> (x, y)
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
234 find the position of a child subsurface inside a parent
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
235
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
236 pygame.Surface.get_abs_offset
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
237 get_abs_offset() -> (x, y)
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
238 find the absolute position of a child subsurface inside its top level parent
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
239
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
240 pygame.Surface.get_size
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
241 get_size() -> (width, height)
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
242 get the dimensions of the Surface
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
243
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
244 pygame.Surface.get_width
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
245 get_width() -> width
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
246 get the width of the Surface
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
247
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
248 pygame.Surface.get_height
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
249 get_height() -> height
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
250 get the height of the Surface
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
251
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
252 pygame.Surface.get_rect
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
253 get_rect(**kwargs) -> Rect
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
254 get the rectangular area of the Surface
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
255
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
256 pygame.Surface.get_bitsize
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
257 get_bitsize() -> int
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
258 get the bit depth of the Surface pixel format
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
259
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
260 pygame.Surface.get_bytesize
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
261 get_bytesize() -> int
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
262 get the bytes used per Surface pixel
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
263
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
264 pygame.Surface.get_flags
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
265 get_flags() -> int
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
266 get the additional flags used for the Surface
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
267
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
268 pygame.Surface.get_pitch
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
269 get_pitch() -> int
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
270 get the number of bytes used per Surface row
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
271
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
272 pygame.Surface.get_masks
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
273 get_masks() -> (R, G, B, A)
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
274 the bitmasks needed to convert between a color and a mapped integer
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
275
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
276 pygame.Surface.set_masks
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
277 set_masks((r,g,b,a)) -> None
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
278 set the bitmasks needed to convert between a color and a mapped integer
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
279
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
280 pygame.Surface.get_shifts
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
281 get_shifts() -> (R, G, B, A)
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
282 the bit shifts needed to convert between a color and a mapped integer
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
283
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
284 pygame.Surface.set_shifts
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
285 set_shifts((r,g,b,a)) -> None
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
286 sets the bit shifts needed to convert between a color and a mapped integer
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
287
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
288 pygame.Surface.get_losses
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
289 get_losses() -> (R, G, B, A)
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
290 the significant bits used to convert between a color and a mapped integer
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
291
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
292 pygame.Surface.get_bounding_rect
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
293 get_bounding_rect(min_alpha = 1) -> Rect
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
294 find the smallest rect containing data
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
295
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
296 pygame.Surface.get_view
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
297 get_view(kind='2') -> <view>
2131
018779fb04f5 Merge the buffer branch back into trunk.
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
298 return a view of a surface's pixel data.
018779fb04f5 Merge the buffer branch back into trunk.
Lenard Lindstrom <len-l@telus.net>
parents: 1937
diff changeset
299
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
300 pygame.Surface.get_buffer
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
301 get_buffer() -> BufferProxy
1937
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
302 acquires a buffer object for the pixels of the Surface.
0d661c00c1aa Merged FreeType branch into trunk.
tanoku
parents:
diff changeset
303
2198
da4302429d3b replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents: 2166
diff changeset
304 */