sdlConvertSurface function

Pointer<SdlSurface> sdlConvertSurface(
  1. Pointer<SdlSurface> surface,
  2. int format
)

Copy an existing surface to a new surface of the specified format.

This function is used to optimize images for faster repeat blitting. This is accomplished by converting the original and storing the result as a new surface. The new, optimized surface can then be used as the source for future blits, making them faster.

If you are converting to an indexed surface and want to map colors to a palette, you can use SDL_ConvertSurfaceAndColorspace() instead.

If the original surface has alternate images, the new surface will have a reference to them as well.

\param surface the existing SDL_Surface structure to convert. \param format the new pixel format. \returns the new SDL_Surface structure that is created or NULL on failure; call SDL_GetError() for more information.

\since This function is available since SDL 3.1.3.

\sa SDL_ConvertSurfaceAndColorspace \sa SDL_DestroySurface

extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_ConvertSurface(SDL_Surface *surface, SDL_PixelFormat format)

Implementation

Pointer<SdlSurface> sdlConvertSurface(Pointer<SdlSurface> surface, int format) {
  final sdlConvertSurfaceLookupFunction = libSdl3.lookupFunction<
      Pointer<SdlSurface> Function(Pointer<SdlSurface> surface, Int32 format),
      Pointer<SdlSurface> Function(
          Pointer<SdlSurface> surface, int format)>('SDL_ConvertSurface');
  return sdlConvertSurfaceLookupFunction(surface, format);
}