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

IMG_ReadXPMFromArrayToRGB888

Load an XPM image from a memory array.

Header File

Defined in <SDL_image.h>

Syntax

SDL_Surface * IMG_ReadXPMFromArrayToRGB888(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.

Remarks

The returned surface will always be a 32-bit RGB surface. If you want 8-bit indexed colors (and the XPM data allows it), use IMG_ReadXPMFromArray() instead.

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

Version

This function is available since SDL_image 2.6.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.