pygame / src / doc / image_doc.h

/* Auto generated file: with .  Docs go in src/ *.doc . */
#define DOC_PYGAMEIMAGE "pygame module for image transfer"

#define DOC_PYGAMEIMAGELOAD "pygame.image.load(filename): return Surface\npygame.image.load(fileobj, namehint=""): return Surface\nload new image from a file"

#define DOC_PYGAMEIMAGESAVE ", filename): return None\nsave an image to disk"

#define DOC_PYGAMEIMAGEGETEXTENDED "pygame.image.get_extended(): return bool\ntest if extended image formats can be loaded"

#define DOC_PYGAMEIMAGETOSTRING "pygame.image.tostring(Surface, format, flipped=False): return string\ntransfer image to string buffer"

#define DOC_PYGAMEIMAGEFROMSTRING "pygame.image.fromstring(string, size, format, flipped=False): return Surface\ncreate new Surface from a string buffer"

#define DOC_PYGAMEIMAGEFROMBUFFER "pygame.image.frombuffer(string, size, format): return Surface\ncreate a new Surface that shares data inside a string buffer"

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


 pygame module for image transfer

 pygame.image.load(filename): return Surface
pygame.image.load(fileobj, namehint=""): return Surface
load new image from a file, filename): return None
save an image to disk

 pygame.image.get_extended(): return bool
test if extended image formats can be loaded

 pygame.image.tostring(Surface, format, flipped=False): return string
transfer image to string buffer

 pygame.image.fromstring(string, size, format, flipped=False): return Surface
create new Surface from a string buffer

 pygame.image.frombuffer(string, size, format): return Surface
create a new Surface that shares data inside a string buffer