SDL_SaveBMP(3)

SDL_SaveBMP3

Save a surface to a file.

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_surface.h

Overview

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.

Function parameters

surface

the SDL_Surface
structure containing the image to be saved.

file

a file to save to.

Return value

Returns true on success or false on failure; call

SDL_GetError () for more information.

Thread safety

This function is not thread safe.

Releases

12 releases since Debian 3.0 (Woody); the text changed 2 times.

  1. 3.0–5.0
  2. 6.0–12
  3. 13

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.