File: image_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 (77 lines) | stat: -rw-r--r-- 3,540 bytes parent folder | download | duplicates (2)
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
/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
#define DOC_PYGAMEIMAGE "pygame module for image transfer"
#define DOC_PYGAMEIMAGELOAD "load(filename) -> Surface\nload(fileobj, namehint="") -> Surface\nload new image from a file (or file-like object)"
#define DOC_PYGAMEIMAGESAVE "save(Surface, filename) -> None\nsave(Surface, fileobj, namehint="") -> None\nsave an image to file (or file-like object)"
#define DOC_PYGAMEIMAGEGETSDLIMAGEVERSION "get_sdl_image_version(linked=True) -> None\nget_sdl_image_version(linked=True) -> (major, minor, patch)\nget version number of the SDL_Image library being used"
#define DOC_PYGAMEIMAGEGETEXTENDED "get_extended() -> bool\ntest if extended image formats can be loaded"
#define DOC_PYGAMEIMAGETOSTRING "tostring(Surface, format, flipped=False) -> bytes\ntransfer image to byte buffer"
#define DOC_PYGAMEIMAGETOBYTES "tobytes(Surface, format, flipped=False) -> bytes\ntransfer image to byte buffer"
#define DOC_PYGAMEIMAGEFROMSTRING "fromstring(bytes, size, format, flipped=False) -> Surface\ncreate new Surface from a byte buffer"
#define DOC_PYGAMEIMAGEFROMBYTES "frombytes(bytes, size, format, flipped=False) -> Surface\ncreate new Surface from a byte buffer"
#define DOC_PYGAMEIMAGEFROMBUFFER "frombuffer(buffer, size, format) -> Surface\ncreate a new Surface that shares data inside a bytes buffer"
#define DOC_PYGAMEIMAGELOADBASIC "load_basic(file) -> Surface\nload new BMP image from a file (or file-like object)"
#define DOC_PYGAMEIMAGELOADEXTENDED "load_extended(filename) -> Surface\nload_extended(fileobj, namehint="") -> Surface\nload an image from a file (or file-like object)"
#define DOC_PYGAMEIMAGESAVEEXTENDED "save_extended(Surface, filename) -> None\nsave_extended(Surface, fileobj, namehint="") -> None\nsave a png/jpg image to file (or file-like object)"


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

/*

pygame.image
pygame module for image transfer

pygame.image.load
 load(filename) -> Surface
 load(fileobj, namehint="") -> Surface
load new image from a file (or file-like object)

pygame.image.save
 save(Surface, filename) -> None
 save(Surface, fileobj, namehint="") -> None
save an image to file (or file-like object)

pygame.image.get_sdl_image_version
 get_sdl_image_version(linked=True) -> None
 get_sdl_image_version(linked=True) -> (major, minor, patch)
get version number of the SDL_Image library being used

pygame.image.get_extended
 get_extended() -> bool
test if extended image formats can be loaded

pygame.image.tostring
 tostring(Surface, format, flipped=False) -> bytes
transfer image to byte buffer

pygame.image.tobytes
 tobytes(Surface, format, flipped=False) -> bytes
transfer image to byte buffer

pygame.image.fromstring
 fromstring(bytes, size, format, flipped=False) -> Surface
create new Surface from a byte buffer

pygame.image.frombytes
 frombytes(bytes, size, format, flipped=False) -> Surface
create new Surface from a byte buffer

pygame.image.frombuffer
 frombuffer(buffer, size, format) -> Surface
create a new Surface that shares data inside a bytes buffer

pygame.image.load_basic
 load_basic(file) -> Surface
load new BMP image from a file (or file-like object)

pygame.image.load_extended
 load_extended(filename) -> Surface
 load_extended(fileobj, namehint="") -> Surface
load an image from a file (or file-like object)

pygame.image.save_extended
 save_extended(Surface, filename) -> None
 save_extended(Surface, fileobj, namehint="") -> None
save a png/jpg image to file (or file-like object)

*/