Scroll to navigation

SDL_LoadBMP_IO(3) SDL3 FUNCTIONS SDL_LoadBMP_IO(3)

NAME

SDL_LoadBMP_IO - Load a BMP image from a seekable SDL data stream.

SYNOPSIS

#include <SDL3/SDL_surface.h>
SDL_Surface * SDL_LoadBMP_IO(SDL_IOStream *src, bool closeio);

DESCRIPTION

The new surface should be freed with SDL_DestroySurface(). Not doing so will result in a memory leak.

FUNCTION PARAMETERS

the data stream for the surface.
if true, calls SDL_CloseIO() on src before returning, even in the case of an error.

RETURN VALUE

Returns a pointer to a new SDL_Surface structure or NULL on failure; call SDL_GetError() for more information.

THREAD SAFETY

It is safe to call this function from any thread.

AVAILABILITY

This function is available since SDL 3.2.0.

SEE ALSO

SDL_DestroySurface(3), SDL_LoadBMP(3), SDL_SaveBMP_IO(3)

SDL 3.2.14 Simple Directmedia Layer