XpmCreateBuffer(3)

💖 XpmCreateBuffer(3) 💖

okay bestie, welcome to the libXpm functions page for XpmCreateBuffer — she's the one who hands you a buffer instead of a whole file, and honestly? she ate. 🎀

---

✨ NAME ✨

XpmCreateBuffer — create an XPM Buffer 🦋

🎀 SYNOPSIS 🎀

int XpmCreateBufferFromImage(Display *display , char **buffer_return,
       XImage *image, XImage *shapeimage, XpmAttributes *attributes);

int XpmCreateBufferFromPixmap(Display *display, char **buffer_return,
       Pixmap pixmap, Pixmap shapemask, XpmAttributes *attributes);

int XpmCreateBufferFromXpmImage(char **buffer_return, XpmImage *image,
       XpmInfo *info);

three little functions, all giving buffer energy. 💅

🌸 ARGUMENTS 🌸

• display — specifies the connection to the X server. your lil hotline to X, fr fr.
• buffer_return — returns the buffer which is created. this is where the magic gets dropped off, no cap.
• image — specifies the image.
• shapeimage — specifies the shape mask image.
• attributes — specifies the location of a structure containing information (or NULL). like, info optional, queen behavior.
• info — specifies the location of a structure to get possible information (or NULL).

💜 DESCRIPTION 💜

🌈 XpmCreateBufferFromPixmap

XpmCreateBufferFromPixmap() creates an XPM buffer from a Pixmap. lowkey the same energy as XpmWriteFileFromPixmap(3) — it just calls XpmCreateBufferFromImage() instead of XpmWriteFileFromImage(3). and once again, bestie, the caller should free the buffer using XpmFree(3) when finished. don't leave her hanging 😭

As a convenience, the XpmReadFileToBuffer(3) and XpmWriteFileFromBuffer(3) functions are provided to copy a file to a buffer and to write a file from a buffer. so like, for instance, one may decide to use XpmCreateBufferFromPixmap(), XpmWriteFileFromBuffer(3), and XpmFree(3) instead of XpmWriteFileFromPixmap(3). On some systems this may lead to a performance improvement, since the processing will be performed in memory — but it uses more memory. trade-offs, babes, it's giving "choose your fighter". ⚖️

🦋 XpmCreateBufferFromImage

The XpmCreateBufferFromImage() function works as XpmWriteFileFromImage(3), it just writes to a malloc'ed buffer instead of to a file. The caller should free the buffer using XpmFree(3) when finished. yes, again. free your buffer. it's self-care. 💆‍♀️

⭐ XpmCreateBufferFromXpmImage.

To create an XPM buffer from an XpmImage, use XpmCreateBufferFromXpmImage(). The XpmCreateBufferFromXpmImage() function writes out the given image to a single block malloc'ed buffer in XPM format. If insufficient working storage is allocated, it returns XpmNoMemory, and returns XpmSuccess on success. ✨

If the passed XpmInfo structure pointer is not NULL, XpmCreateBufferFromXpmImage() looks for the following attributes: XpmComments, XpmExtensions, and XpmHotspot, and writes the related information out as well. so extra lore gets included, periodt. 👑

The caller should free the buffer using XpmFree(3) when finished. (third time's the charm, bestie — free it.)

🔥 SEE ALSO 🔥

• XpmFree(3)
• XpmWriteFileFromBuffer(3)
• XpmWriteFileFromImage(3)
• XpmWriteFileFromPixmap(3)

---

and that's the whole page, gorgeous 🌈 this one came from X Version 11, and the version of libXpm is 3.5.17 — yeah, she's been around and she still slays. go free your buffers, mwah 💅💖