(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_SaveBMP_RW

Save a surface to a seekable SDL data stream in BMP format.

Header File

Syntax

int SDL_SaveBMP_RW
    (SDL_Surface * surface, SDL_RWops * dst, int freedst);

Function Parameters

SDL_Surface *	surface	the SDL_Surface structure containing the image to be saved.
SDL_RWops *	dst	a data stream to save to.
int	freedst	non-zero to close the stream after being written.

Return Value

(int) Returns 0 on success or a negative error code 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 2.0.0.