.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_SaveBMP_IO:
.\"   https://wiki.libsdl.org/SDL_SaveBMP_IO
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_SaveBMP_IO
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_SaveBMP_IO 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_SaveBMP_IO \- Save a surface to a seekable SDL data stream in BMP format\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "int SDL_SaveBMP_IO(SDL_Surface *surface, SDL_IOStream *dst, SDL_bool closeio);
.fi
.SH DESCRIPTION
Surfaces with a 24-bit, 32-bit and paletted 8-bit format get saved in the
BMP directly\[char46] 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\[char46] YUV and paletted 1-bit and 4-bit formats are
not supported\[char46]

.SH FUNCTION PARAMETERS
.TP
.I surface
the 
.BR SDL_Surface
 structure containing the image to be saved
.TP
.I dst
a data stream to save to
.TP
.I closeio
if 
.BR SDL_TRUE
, calls 
.BR SDL_CloseIO
() on
.BR dst
before returning, even in the case of an error
.SH RETURN VALUE
Returns 0 on success or a negative error code on failure; call

.BR SDL_GetError
() for more information\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR SDL_LoadBMP_IO (3),
.BR SDL_SaveBMP (3)