Function sdl2_sys::SDL_ConvertSurfaceFormat

source · 
pub unsafe extern "C" fn SDL_ConvertSurfaceFormat(
    src: *mut SDL_Surface,
    pixel_format: Uint32,
    flags: Uint32,
) -> *mut SDL_Surface
Expand description

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

This function operates just like SDL_ConvertSurface(), but accepts an SDL_PixelFormatEnum value instead of an SDL_PixelFormat structure. As such, it might be easier to call but it doesn’t have access to palette information for the destination surface, in case that would be important.

\param src the existing SDL_Surface structure to convert \param pixel_format the SDL_PixelFormatEnum that the new surface is optimized for \param flags the flags are unused and should be set to 0; this is a leftover from SDL 1.2’s API \returns the new SDL_Surface structure that is created or NULL if it fails; call SDL_GetError() for more information.

\since This function is available since SDL 2.0.0.

\sa SDL_AllocFormat \sa SDL_ConvertSurface \sa SDL_CreateRGBSurface