1 /* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
2 #define DOC_PYGAMEIMAGE "pygame module for image transfer"
3 #define DOC_PYGAMEIMAGELOAD "load(filename) -> Surface\nload(fileobj, namehint="") -> Surface\nload new image from a file (or file-like object)"
4 #define DOC_PYGAMEIMAGESAVE "save(Surface, filename) -> None\nsave(Surface, fileobj, namehint="") -> None\nsave an image to file (or file-like object)"
5 #define DOC_PYGAMEIMAGEGETSDLIMAGEVERSION "get_sdl_image_version() -> None\nget_sdl_image_version() -> (major, minor, patch)\nget version number of the SDL_Image library being used"
6 #define DOC_PYGAMEIMAGEGETEXTENDED "get_extended() -> bool\ntest if extended image formats can be loaded"
7 #define DOC_PYGAMEIMAGETOSTRING "tostring(Surface, format, flipped=False) -> string\ntransfer image to string buffer"
8 #define DOC_PYGAMEIMAGEFROMSTRING "fromstring(string, size, format, flipped=False) -> Surface\ncreate new Surface from a string buffer"
9 #define DOC_PYGAMEIMAGEFROMBUFFER "frombuffer(bytes, size, format) -> Surface\ncreate a new Surface that shares data inside a bytes buffer"
10 #define DOC_PYGAMEIMAGELOADBASIC "load_basic(file) -> Surface\nload new BMP image from a file (or file-like object)"
11 #define DOC_PYGAMEIMAGELOADEXTENDED "load_extended(filename) -> Surface\nload_extended(fileobj, namehint="") -> Surface\nload an image from a file (or file-like object)"
12 #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)"
13 
14 
15 /* Docs in a comment... slightly easier to read. */
16 
17 /*
18 
19 pygame.image
20 pygame module for image transfer
21 
22 pygame.image.load
23  load(filename) -> Surface
24  load(fileobj, namehint="") -> Surface
25 load new image from a file (or file-like object)
26 
27 pygame.image.save
28  save(Surface, filename) -> None
29  save(Surface, fileobj, namehint="") -> None
30 save an image to file (or file-like object)
31 
32 pygame.image.get_sdl_image_version
33  get_sdl_image_version() -> None
34  get_sdl_image_version() -> (major, minor, patch)
35 get version number of the SDL_Image library being used
36 
37 pygame.image.get_extended
38  get_extended() -> bool
39 test if extended image formats can be loaded
40 
41 pygame.image.tostring
42  tostring(Surface, format, flipped=False) -> string
43 transfer image to string buffer
44 
45 pygame.image.fromstring
46  fromstring(string, size, format, flipped=False) -> Surface
47 create new Surface from a string buffer
48 
49 pygame.image.frombuffer
50  frombuffer(bytes, size, format) -> Surface
51 create a new Surface that shares data inside a bytes buffer
52 
53 pygame.image.load_basic
54  load_basic(file) -> Surface
55 load new BMP image from a file (or file-like object)
56 
57 pygame.image.load_extended
58  load_extended(filename) -> Surface
59  load_extended(fileobj, namehint="") -> Surface
60 load an image from a file (or file-like object)
61 
62 pygame.image.save_extended
63  save_extended(Surface, filename) -> None
64  save_extended(Surface, fileobj, namehint="") -> None
65 save a png/jpg image to file (or file-like object)
66 
67 */