Scroll to navigation

SDL_ConvertSurfaceFormatAndColorspace(3) SDL3 FUNCTIONS SDL_ConvertSurfaceFormatAndColorspace(3)

NAME

SDL_ConvertSurfaceFormatAndColorspace - Copy an existing surface to a new surface of the specified format and colorspace.

SYNOPSIS

#include "SDL3/SDL.h"
SDL_Surface* SDL_ConvertSurfaceFormatAndColorspace(SDL_Surface *surface, SDL_PixelFormatEnum pixel_format, 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.

FUNCTION PARAMETERS

the existing SDL_Surface
structure to convert
the new pixel format
the new colorspace
an SDL_PropertiesID
with additional color properties, or 0

RETURN VALUE

Returns the new SDL_Surface
structure that is created or NULL if it fails; call SDL_GetError () for more information.

AVAILABILITY

This function is available since SDL 3.0.0.

SEE ALSO

SDL_ConvertSurface(3), SDL_ConvertSurfaceFormat(3), SDL_DestroySurface(3)

SDL 3.1.0 SDL