XpmCreateImage(3)

💖 XpmCreateImage — the libXpm functions glow-up 💖

okay bestie, sit DOWN, because we're about to make XImages out of XPMs and it's genuinely so cute. this page lives in the libXpm functions section of the manual, and it's giving "three functions, one dream" energy. 🦋

---

✨ NAME ✨

XpmCreateImage — create an XImage from an XPM 💅

---

🌸 SYNOPSIS 🌸

int XpmCreateImageFromData(Display *display, char **data,
       XImage **image_return, XImage **shapeimage_return,
       XpmAttributes *attributes);

int XpmCreateImageFromBuffer(Display *display, char *buffer,
       XImage **image_return, XImage **shapeimage_return,
       XpmAttributes *attributes);

int XpmCreateImageFromXpmImage(Display *display,  XpmImage *image,
       XImage *image_return, XImage *shapeimage_return,
       XpmAttributes *attributes);

---

🎀 ARGUMENTS 🎀

• display — the connection to the X server. your lil phone line to the server, basically 📞
• data — where the data lives. tell me where the data is, bestie.
• image_return — returns the image which is created. yep, it comes back out through here ✨
• shapeimage_return — returns the shape mask image which is created if the color None is used. no None, no shape mask, that's the vibe.
• attributes — where a structure lives that gets and stores info (or NULL, if you're feeling lowkey and don't want any). 💜
• shapeimage — the shape mask image which is created if any.

---

👑 DESCRIPTION 👑

🌈 XpmCreateImageFromData

to create an XImage from XPM data, you use XpmCreateImageFromData(). that's it, that's the whole assignment. 📝

the XpmCreateImageFromData() function lets you embed in your C program an XPM file that was written out by functions like XpmWriteFileFromImage(3) or XpmWriteFileFromPixmap(3) — without reading in the file. no file, no problem. XpmCreateImageFromData() works exactly like XpmReadFileToImage(3) and returns the same way. it just reads data instead of a file. main character but make it data.

and here again, it is the caller's responsibility to free the returned images, the colors, and possibly the data returned into the XpmAttributes structure. yes babe, YOU. you're the one holding the mop. 🧹

🦋 XpmCreateImageFromBuffer

to create an XImage from an XPM buffer, use XpmCreateImageFromBuffer(). XpmCreateImageFromBuffer() works the same way as XpmReadFileToImage(3) — it just parses the buffer instead of the file. slay, same energy, different source.

⚠️ be aware that the feature provided on some systems by XpmReadFileToImage(3) to deal with compressed files is not available here. compressed files? not invited to this party. 💀

💅 XpmCreateImageFromXpmImage

to create an XImage from an XpmImage, use XpmCreateImageFromXpmImage(). from the given XpmImage and XpmAttributes (if not NULL), XpmCreateImageFromXpmImage() allocates colors and creates X images following the same mechanism as XpmReadFileToImage(3). iconic, consistent, no notes.

when finished, the caller must free:

• the images, using XDestroyImage(3)
• the colors, using XFreeColors(3)
• and possibly the data returned into the XpmAttributes, using XpmFreeAttributes(3)

three cleanups, no cap. do them. 🫶

---

🔥 SEE ALSO 🔥

• XpmFreeAttributes(3)
• XpmReadFileToImage(3)

---

and that's the whole page, bestie — X Version 11, libXpm 3.5.17, this is XpmCreateImage(3) signing off 💖 remember to free your images or the leaks will find you, mwah 🎀✨