treasurehunting2/PySDL2-0.9.5/doc/html/_sources/modules/sdl2ext_image.txt

28 lines
965 B
Plaintext

.. currentmodule:: sdl2.ext
Image loaders
=============
.. function:: get_image_formats() -> (str, str, ...)
Gets the formats supported by PySDL2 in the default installation.
.. function:: load_image(fname : str[, enforce=None]) -> sdl2.SDL_Surface
Creates a :class:`sdl2.SDL_Surface` from an image file.
This function makes use of the `Python Imaging Library
<http://www.pythonware.com/products/pil/>`_, if it is available on the
target execution environment. The function will try to load the file via
:mod:`sdl2` first. If the file could not be loaded, it will try to load it
via :mod:`sdl2.sdlimage` and PIL.
You can force the function to use only one of them, by passing the
*enforce* as either ``"PIL"`` or ``"SDL"``.
.. note::
This will call :func:`sdl2.sdlimage.IMG_Init()` implicitly with the
default arguments, if the module is available and if
:func:`sdl2.SDL_LoadBMP()` failed to load the image.