(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_AddSurfaceAlternateImage

Add an alternate version of a surface.

Header File

Syntax

SDL_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

(SDL_bool) Returns SDL_TRUE on success or SDL_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.