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

Function SDL_ConvertSurface

pub unsafe extern "C" fn SDL_ConvertSurface(
    surface: *mut SDL_Surface,
    format: SDL_PixelFormat,
) -> *mut SDL_Surface
Available on crate feature dep_sdl3 only.
Expand description

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.

§Parameters

  • surface: the existing SDL_Surface structure to convert.
  • format: the new pixel format.

§Return value

Returns the new SDL_Surface structure that is created or NULL on failure; call SDL_GetError() for more information.

§Availability

This function is available since SDL 3.2.0.

§See also