SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)


Save a surface to a file.


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

Function Parameters


the SDL_Surface structure containing the image to be saved


a file to save to

Return Value

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


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.


This function is available since SDL 3.0.0.

Code Examples


    SDL_Surface *sfc = ...

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

CategoryAPI, CategorySurface

[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.