devela::_dep::sdl3::sys::surface

Function SDL_SaveBMP_IO

pub unsafe extern "C" fn SDL_SaveBMP_IO(
    surface: *mut SDL_Surface,
    dst: *mut SDL_IOStream,
    closeio: bool,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

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

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.

§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.

§Availability

This function is available since SDL 3.2.0.

§See also