SDL Wiki
(This function is part of SDL_image, a separate library from SDL.)


Load an XPM image from a memory array.

Header File

Defined in <SDL3_image/SDL_image.h>


SDL_Surface * IMG_ReadXPMFromArray(char **xpm);

Function Parameters

char ** xpm a null-terminated array of strings that comprise XPM data.

Return Value

(SDL_Surface *) Returns a new SDL surface, or NULL on error.


The returned surface will be an 8bpp indexed surface, if possible, otherwise it will be 32bpp. If you always want 32-bit data, use IMG_ReadXPMFromArrayToRGB888() instead.

When done with the returned surface, the app should dispose of it with a call to SDL_DestroySurface().


This function is available since SDL_image 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction

[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.