(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_LoadBMP_IO

Load a BMP image from a seekable SDL data stream.

Header File

Defined in <SDL3/SDL_surface.h>

Syntax

SDL_Surface * SDL_LoadBMP_IO(SDL_IOStream *src, bool closeio);

Function Parameters

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

Return Value

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

Remarks

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

Version

This function is available since SDL 3.1.3.

See Also

• SDL_DestroySurface
• SDL_LoadBMP
• SDL_SaveBMP_IO

---

CategoryAPI, CategoryAPIFunction, CategorySurface

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.