|
pygame.image.load | load new image from a file |
pygame.image.save | save an image to disk |
pygame.image.get_extended | test if extended image formats can be loaded |
pygame.image.tostring | transfer image to string buffer |
pygame.image.fromstring | create new Surface from a string buffer |
pygame.image.frombuffer | create a new Surface that shares data inside a string buffer |
The image module contains functions for loading and saving Surface images, as well as transferring surfaces to formats usable by other packages.
The image module is a required dependency of Pygame, but it only optionally supports any extended file formats. By default it can only load uncompressed BMP images. When built with full image support, the pygame.image.load function can support the following formats.
Saving images only supports a limited set of uncompressed formats. You can save to the following formats.
Load an image from a file source. You can pass either a filename or a python file-like object.
Pygame will determine the type of image the file points to and create a new Surface object from the data. Some file formats are not easy to guess. If you pass a raw file-like object, you may also want to pass the original filename as the namehint argument.
The returned Surface will contain the same color format, colorkey and alpha transparency as the file it came from. You will often want to call Surface.convert with no arguments, to create a copy that will draw as fast as possible.
Pygame may not always be built to support all image formats. At minimum it will support uncompressed BMP. If pygame.image.get_extended returns 'True', you should be able to load most images.
This will save your Surface as either a BMP or TGA image. If the filename extension is unrecognized it will default to BMP. Both file formats create uncompressed files.
If pygame is built with extended image formats this function will return True. It is still not possible to determine which formats will be available, but generally you will be able to load them all.
Creates a string that can be transferred with the 'fromstring' method in other Python imaging packages. Some Python image packages prefer their images in bottom-to-top format (PyOpenGL for example). If you pass True for the flipped argument, the string buffer will be vertically flipped.
The format argument is a string of one of the following values. Note that only 8bit Surfaces can use the "P" format. The other formats will work for any Surface. Also note that other Python image packages support more formats than Pygame.
This function takes arguments similar to pygame.image.tostring. The size argument is a pair of numbers representing the width and height. Once the new Surface is created you can destroy the string buffer.
The size and format image must compute the exact same size as the passed string buffer. Otherwise an exception will be raised.
See the pygame.image.frombuffer method for a potentially faster way to transfer images into Pygame.
Create a new Surface that shares pixel data directly from the string buffer. This method takes the same arguments as pygame.image.fromstring, but is unable to vertically flip the source data.
This will run much faster than pygame.image.fromstring, since no pixel data must be allocated and copied.