ipygame.image

pygame-compatible image module.

FileLike

FileLike = Union[str, Path, BinaryIO]

load

def load(file: FileLike, namehint: str = "") -> Surface

Load an image from a file path or file-like object.

load_basic

def load_basic(file: FileLike) -> Surface

Load a BMP image.

load_extended

def load_extended(file: FileLike, namehint: str = "") -> Surface

Load an image with extended format support.

load_sized_svg

def load_sized_svg(file: FileLike, size: tuple[int, int]) -> Surface

Load an SVG rasterized at the given size.

Requires the cairosvg package. Falls back to Pillow if available.

save

def save(surface: Surface, file: FileLike, namehint: str = "") -> None

Save a Surface to a file (PNG, JPEG, BMP, TGA).

save_extended

def save_extended(surface: Surface,
                  file: FileLike,
                  namehint: str = "") -> None

Save a Surface using extended format support.

get_extended

def get_extended() -> bool

Return True if extended image formats are available.

get_sdl_image_version

def get_sdl_image_version(linked: bool = True)

Return None — SDL_image is not used.

tobytes

def tobytes(surface: Surface,
            format: str = "RGBA",
            flipped: bool = False,
            pitch: int = -1) -> bytes

Transfer Surface pixels to a byte string.

tostring

def tostring(surface: Surface,
             format: str = "RGBA",
             flipped: bool = False,
             pitch: int = -1) -> bytes

Deprecated — use tobytes.

frombytes

def frombytes(data: bytes,
              size: tuple[int, int],
              format: str = "RGBA",
              flipped: bool = False,
              pitch: int = -1) -> Surface

Create a Surface from a byte buffer.

fromstring

def fromstring(data: bytes,
               size: tuple[int, int],
               format: str = "RGBA",
               flipped: bool = False,
               pitch: int = -1) -> Surface

Deprecated — use frombytes.

frombuffer

def frombuffer(data,
               size: tuple[int, int],
               format: str = "RGBA",
               pitch: int = -1) -> Surface

Create a Surface from a buffer object (data is copied).