SDL_SaveBMP_IO - Man Page
Save a surface to a seekable SDL data stream in BMP format.
Synopsis
#include <SDL3/SDL_surface.h> bool SDL_SaveBMP_IO(SDL_Surface *surface, SDL_IOStream *dst, bool closeio);
Description
Surfaces with a 24-bit, 32-bit and paletted 8-bit format get saved in the BMP directly. Other RGB formats with 8-bit or higher get converted to a 24-bit surface or, if they have an alpha mask or a colorkey, to a 32-bit surface before they are saved. YUV and paletted 1-bit and 4-bit formats are not supported.
Function Parameters
- surface
the SDL_Surface structure containing the image to be saved.
- dst
a data stream to save to.
- closeio
if true, calls SDL_CloseIO() on dst before returning, even in the case of an error.
Return Value
Returns true on success or false on failure; call SDL_GetError() for more information.
Thread Safety
This function can be called on different threads with different surfaces.
Availability
This function is available since SDL 3.2.0.
See Also
Referenced By
SDL_LoadBMP_IO(3), SDL_SaveBMP(3).