sdlSaveBmp function surface

bool sdlSaveBmp(Pointer<SdlSurface> surface, String? file)

Save a surface to a file 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.

\param surface the SDL_Surface structure containing the image to be saved. \param file a file to save to. \returns true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function can be called on different threads with different surfaces.

\since This function is available since SDL 3.2.0.

\sa SDL_LoadBMP \sa SDL_SaveBMP_IO

extern SDL_DECLSPEC bool SDLCALL SDL_SaveBMP(SDL_Surface *surface, const char *file)

Implementation

bool sdlSaveBmp(Pointer<SdlSurface> surface, String? file) {
  final sdlSaveBmpLookupFunction = _libSdl
      .lookupFunction<
        Uint8 Function(Pointer<SdlSurface> surface, Pointer<Utf8> file),
        int Function(Pointer<SdlSurface> surface, Pointer<Utf8> file)
      >('SDL_SaveBMP');
  final filePointer = file != null ? file.toNativeUtf8() : nullptr;
  final result = sdlSaveBmpLookupFunction(surface, filePointer) == 1;
  calloc.free(filePointer);
  return result;
}