Wiki Page Content

Differences between revisions 8 and 9
Revision 8 as of 2020-07-24 17:18:12
Size: 1250
Editor: gerstrong
Comment: Added example
Revision 9 as of 2020-07-24 17:18:55
Size: 1250
Editor: gerstrong
Comment: Typo fix
Deletions are marked like this. Additions are marked like this.
Line 33: Line 33:
        // Srror saving bitmap         // Error saving bitmap


Use this function to save a surface to a BMP file.


int SDL_SaveBMP(SDL_Surface* surface,
                const char*  file)

Function Parameters


the SDL_Surface structure containing the image to be saved


the file to be saved to

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Code Examples


    SDL_Surface *sfc = ...

    if(SDL_SaveBMP(sfc, "somefile.bmp") != 0)
        // Error saving bitmap
        printf("SDL_SaveBMP failed: %s\n", SDL_GetError());


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.

CategoryAPI, CategorySurface

None: SDL_SaveBMP (last edited 2020-07-24 17:18:55 by gerstrong)

Please include your contact information if you'd like to receive a reply.