(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetSurfaceImages

Get an array including all versions of a surface.

Header File

Syntax

SDL_Surface ** SDL_GetSurfaceImages(SDL_Surface *surface, int *count);

Function Parameters

SDL_Surface *	surface	the SDL_Surface structure to query.
int *	count	a pointer filled in with the number of surface pointers returned, may be NULL.

Return Value

(SDL_Surface **) Returns a NULL terminated array of SDL_Surface pointers or NULL on failure; call SDL_GetError() for more information. This should be freed with SDL_free() when it is no longer needed.

Remarks

This returns all versions of a surface, with the surface being queried as the first element in the returned array.

Freeing the array of surfaces does not affect the surfaces in the array. They are still referenced by the surface being queried and will be cleaned up normally.

Version

This function is available since SDL 3.0.0.