SDL_ConvertSurface3
Copy an existing surface to a new surface of the specified format.
Usage
#include "SDL3/SDL.h"
SDL_Surface * SDL_ConvertSurface(SDL_Surface *surface, SDL_PixelFormat format);
Header file
Defined in SDL3/SDL_surface.h
Overview
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.
Function parameters
surface
|
the existing |
|---|---|
format
|
the new pixel format. |
Return value
( SDL_Surface
*) Returns the new SDL_Surface
structure that is created or NULL on failure; call
SDL_GetError () for more information.
Thread safety
This function is not thread safe.
Releases
12 releases since Debian 3.0 (Woody); the text changed 2 times.