====== (This is the legacy documentation for stable SDL2, the current stable version; [https://wiki.libsdl.org/SDL3/ SDL3] is the current development version.) ======
= SDL_SaveBMP =

Save a surface to a file.

== Header File ==

Defined in [SDL_surface.h](https://github.com/libsdl-org/SDL/blob/SDL2/include/SDL_surface.h), but apps should _only_ `#include "SDL.h"`!

== Syntax ==

<syntaxhighlight lang='c'>
#define SDL_SaveBMP(surface, file) \
        SDL_SaveBMP_RW(surface, SDL_RWFromFile(file, "wb"), 1)</syntaxhighlight>

== Remarks ==

Convenience macro.

== Code Examples ==

<syntaxhighlight lang='c'>

    /* ... */

    SDL_Surface *sfc /* = ... */;

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

----
[[CategoryAPI]], [[CategoryAPIMacro]], [[CategorySurface]]