SDL_AddSurfaceAlternateImage - Add an alternate version of a surface.
Contents
Availability
This function is available since SDL 3.2.0.
Description
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.
Function Parameters
surface
the SDL_Surface structure to update.
image a pointer to an alternate SDL_Surface to associate with this surface.
Name
SDL_AddSurfaceAlternateImage - Add an alternate version of a surface.
Return Value
for more information.
See Also
SDL_RemoveSurfaceAlternateImages(3), SDL_GetSurfaceImages(3), SDL_SurfaceHasAlternateImages(3) Simple Directmedia Layer SDL 3.2.20 SDL_AddSurfaceAlternateImage(3)
Synopsis
#include<SDL3/SDL_surface.h>boolSDL_AddSurfaceAlternateImage(SDL_Surface*surface,SDL_Surface*image);
Thread Safety
This function is not thread safe.
