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

SDL_SaveBMP

Save a surface to a file.

Header File

Syntax

bool SDL_SaveBMP(SDL_Surface *surface, const char *file);

Function Parameters

SDL_Surface *	surface	the SDL_Surface structure containing the image to be saved.
const char *	file	a file to save to.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

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.

Version

This function is available since SDL 3.1.3.