NAME¶

IMG_SaveBMP - Save an SDL_Surface into a BMP image file.

SYNOPSIS¶

#include <SDL3_image/SDL_image.h>

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

DESCRIPTION¶

If the file already exists, it will be overwritten.

FUNCTION PARAMETERS¶

surface

the SDL surface to save.

file

path on the filesystem to write new file to.

RETURN VALUE¶

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

AVAILABILITY¶

This function is available since SDL_image 3.4.0.

SEE ALSO¶

IMG_SaveBMP_IO(3)