---
name: "SDL_SaveBMP_IO"
section: "3"
platform: "linux"
package: "libsdl3-doc"
version: "3.2.10+ds-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/SDL_SaveBMP_IO"
---

# SDL\_SaveBMP\_IO(3)

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

## NAME

SDL\_SaveBMP\_IO - Save a surface to a seekable SDL data stream in BMP format.

## HEADER FILE

Defined in SDL3/SDL\_surface.h

## SYNOPSIS

```
#include "SDL3/SDL.h"
```

**bool SDL\_SaveBMP\_IO(SDL\_Surface \*surface, SDL\_IOStream \*dst, bool closeio);**

## DESCRIPTION

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.

- *dst*

  a data stream to save to.

- *closeio*

  if true, calls  **SDL\_CloseIO** () on **dst** before returning, even in the case of an error.

## RETURN VALUE

Returns true on success or false on failure; call

**SDL\_GetError** () for more information.

## THREAD SAFETY

This function is not thread safe.

## AVAILABILITY

This function is available since SDL 3.2.0.

## SEE ALSO

**•**(3), [**SDL\_LoadBMP\_IO**(3)](/SDL_LoadBMP_IO/3.md), **•**(3), [**SDL\_SaveBMP**(3)](/SDL_SaveBMP/3.md)
