SDL_LoadBMP_IO - Man Page

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

src

the data stream for the surface.

closeio

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)

Referenced By

SDL_LoadBMP(3), SDL_SaveBMP_IO(3).

SDL 3.2.16 Simple Directmedia Layer SDL3 FUNCTIONS