SDL_ConvertSurfaceAndColorspace - Man Page
Copy an existing surface to a new surface of the specified format and colorspace.
Synopsis
#include <SDL3/SDL_surface.h> SDL_Surface * SDL_ConvertSurfaceAndColorspace(SDL_Surface *surface, SDL_PixelFormat format, SDL_Palette *palette, SDL_Colorspace colorspace, SDL_PropertiesID props);
Description
This function converts an existing surface to a new format and colorspace and returns the new surface. This will perform any pixel format and colorspace conversion needed.
If the original surface has alternate images, the new surface will have a reference to them as well.
Function Parameters
- surface
the existing SDL_Surface structure to convert.
- format
the new pixel format.
- palette
an optional palette to use for indexed formats, may be NULL.
- colorspace
the new colorspace.
- props
an SDL_PropertiesID with additional color properties, or 0.
Return Value
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.
Availability
This function is available since SDL 3.2.0.
See Also
Referenced By
SDL 3.2.16 Simple Directmedia Layer SDL3 FUNCTIONS