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

SDL_AddSurfaceAlternateImage

Add an alternate version of a surface.

Header File

Syntax

bool SDL_AddSurfaceAlternateImage(SDL_Surface *surface, SDL_Surface *image);

Function Parameters

SDL_Surface *	surface	the SDL_Surface structure to update.
SDL_Surface *	image	a pointer to an alternate SDL_Surface to associate with this surface.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

This function adds an alternate version of this surface, usually used for content with high DPI representations like cursors or icons. The size, format, and content do not need to match the original surface, and these alternate versions will not be updated when the original surface changes.

This function adds a reference to the alternate version, so you should call SDL_DestroySurface() on the image after this call.

Version

This function is available since SDL 3.0.0.