IMG_ReadXPMFromArray(3)

💖 IMG_ReadXPMFromArray(3) 💖

okay so bestie, we are in the SDL_image3 FUNCTIONS manual, and the main character today is IMG_ReadXPMFromArray. she loads an XPM image from a memory array. periodt ✨

🌸 NAME 🌸

IMG_ReadXPMFromArray — load an XPM image from a memory array. that's the whole name, no cap 💅

🦋 SYNOPSIS 🦋

#include <SDL3_image/SDL_image.h>

SDL_Surface * IMG_ReadXPMFromArray(char **xpm);

🎀 DESCRIPTION 🎀

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 — she's literally right there for that exact vibe 💖.

When you're done with the returned surface, the app should dispose of it with a call to SDL_DestroySurface(). do not just leave it hanging around, bestie — clean up your surfaces 🧚.

🧚 FUNCTION PARAMETERS 🧚

• xpm — a null-terminated array of strings that comprise XPM data. that's the whole parameter, iconic 🎀

⭐ RETURN VALUE ⭐

Returns a new SDL surface, or NULL on error. yup, on error you get NULL, no cap 😭.

🌈 AVAILABILITY 🌈

This function is available since SDL_image 3.0.0. so yes, she's been available since then 💅.

🫶 SEE ALSO 🫶

• IMG_ReadXPMFromArrayToRGB888(3) — the RGB888 option, iykyk ✨

---

source/version sign-off: SDL_image, version 3.4.4 — mwah 💖