XpmCreateData(3)

💖 XpmCreateData(3) 💖

okay bestie, welcome to the libXpm functions corner of the manual, this one is literally called XpmCreateData and it's all about creating a Data structure ✨ buckle up 🎀

---

✨ NAME ✨

XpmCreateData — create an Data structure 💅

(yes, "an Data", she said what she said, we don't edit the queen 🫶)

---

🌸 SYNOPSIS 🌸

int XpmCreateDataFromImage(Display *display, char ***data_return,
       XImage *image, XImage *shapeimage, XpmAttributes *attributes);

int XpmCreateDataFromPixmap(Display *display, char ***data_return,
       Pixmap pixmap, Pixmap shapemask, XpmAttributes *attributes);

int XpmCreateDataFromXpmImage(char ***data_return, XpmImage *image,
       XpmInfo *info);

three whole entry points, we love a trio 👑 no cap

---

🦋 ARGUMENTS 🦋

• display — the connection to the X server, like your group chat connection but for X 🔌
• data_return — this one returns the data that gets created, it's giving output parameter energy 💫
• pixmap — the pixmap, that's it, that's the whole vibe 🖼️
• shapemask — the shape mask pixmap 🌙
• attributes — where a structure lives that's holding information (or NULL, she's flexible like that) 📋
• info — where a structure lives that you're getting information from 👀
• image — the image ✨

---

💜 DESCRIPTION 💜

🌈 XpmCreateDataFromImage

so sometimes you're just sitting there and you're like "bestie I need to create an XPM data from an XImage" — and for that, you use XpmCreateDataFromImage() 💅

XpmCreateDataFromImage() works exactly the way XpmWriteFileFromImage(3) does, and it returns the same way too. the only glow-up difference? it writes to a single block of malloc'ed data instead of to a file. main character behavior fr fr 🔥

okay and this part matters: it is the caller's responsibility to free that data, using XpmFree(3) when you're finished. not optional, not cute to forget, don't leave it hanging 😭

🌈 XpmCreateDataFromPixmap

XpmCreateDataFromPixmap() creates an XPM data from a Pixmap 🎀

the way it does this is very "I'll delegate": XpmCreateDataFromPixmap() uses XGetImage(3) to get the related X images from the given pixmaps, and those images get passed straight to XpmCreateDataFromImage(). then it destroys the created images using XDestroyImage(3) — clean up after yourself, iconic 🧚

and it returns the same errors as XpmCreateDataFromImage(). periodt.

🌈 XpmCreateDataFromXpmImage

XpmCreateDataFromXpmImage() creates an XPM data from an XpmImage 🌸

it writes out the given image to a single block of malloc'ed data in XPM format ✍️ and if there isn't enough working storage allocated, it returns XpmNoMemory 😭, and returns XpmSuccess on success 💖

if the XpmInfo structure pointer you passed is not NULL, then XpmCreateDataFromXpmImage() goes looking for these attributes:

• XpmExtensions
• XpmHotspot

and it writes out the related information as well 👑

and again, bestie, listen: it is the caller's responsibility to free the data, using XpmFree(3) when finished 🫶

---

⭐ SEE ALSO ⭐

• XpmFree(3)
• XpmWriteFileFromImage(3)

---

and that's the whole page, no crumbs left 💅 go forth and free your malloc'ed data, bestie, your future self will thank you 🙈✨

this has been X Version 11, libXpm 3.5.17, brought to you with love and zero memory leaks 🎀💖🦋