XcupStoreColors(3)

✨ XcupStoreColors ✨

okay bestie, so this one is a lil X function from the Xcup extension, and she's basically the colormap glow-up you call when you want your colors to be shareable instead of hogged by one app 💅 we're talking XcupStoreColors(3) today. let's get into it 🫶

---

🌸 SYNOPSIS 🌸

cc [ flag ... ] file ... -lXext [ library ... ]
#include <X11/extensions/Xcup.h>

Status XcupStoreColors(Display *display, Colormap colormap,
       XColor *colors_in_out, int ncolors);

---

🎀 ARGUMENTS 🎀

• display — the connection to the X server, obvi 🖥️
• colormap — the colormap, the one we're messing with
• colors_in_out — here's the ✨iconic✨ part: this one is both input and output. You hand her values, she gives you back the values that actually got used in the colormap 🔁
• ncolors — how many items live in colors_in_out, so count them correctly bestie, she's not psychic 💀

---

💖 DESCRIPTION 💖

So XcupStoreColors changes the colormap entries of the pixel values sitting in the pixel members of the XColor structures. the way she allocates them? exactly as if an AllocColor had been used — which means the colors are read-only and shareable. no hogging, we're all sharing the vibe here 🧚

And what does she give you back? XcupStoreColors returns the number of colors that were successfully allocated in the colormap. not all of them necessarily — just the ones that slayed 💅

⚠️ now the important part, no cap: a Value error is generated if a pixel is not a valid index into the colormap. and a BadMatch error is generated if the colormap does not belong to a GrayScale, PseudoColor, or DirectColor visual. so like, check your visual first, bestie 😭

okay so why should you care?? apps that allocate a LOT of colors in a screen's default colormap — think a color-cube or a gray-ramp, the heavy stuff — should allocate them with XCupStoreColors. by using XCupStoreColors the colors get allocated shareable (read-only) and any other application that allocates the same color will share that color cell. literally communal color ownership, it's giving community garden but for pixels 🌈🔥

---

👑 SEE ALSO 👑

• XcupQueryVersion(3Xext)
• XcupGetReservedColormapEntries(3Xext)
• Colormap Utilization Policy and Extension

---

and that's the whole thing, bestie 🫶 this page came to you straight outta X Version 11, with libXext 1.3.6 holding it down — XcupStoreColors(3), periodt 💜✨