MRMFETCHBITMAPLITERAL(3)

💖 MrmFetchBitmapLiteral 💖

okay bestie, so this one is a <rainbow>library call</rainbow> and it's literally the glow-up pipeline for bitmaps: it yanks a bitmap literal out of a hierarchy and turns it into an actual X pixmap. let's get into it ✨

---

🌸 NAME 🌸

MrmFetchBitmapLiteral — fetches a bitmap literal from a hierarchy 🎀

---

✨ SYNOPSIS ✨

#include <Mrm/MrmPublic.h>
Cardinal MrmFetchBitmapLiteral(
MrmHierarchy hierarchy_id,
String index,
Screen *screen,
Display *display,
Pixmap *pixmap_return,
Dimension *width,
Dimension *height);

---

🦋 DESCRIPTION 🦋

The MrmFetchBitmapLiteral function fetches a bitmap literal from an MRM hierarchy, and converts the bitmap literal to an X pixmap of depth 1. The function returns this pixmap and its width and height. no cap, that's the whole vibe 💅

• hierarchy_id — specifies the ID of the UID hierarchy that contains the specified icon literal. The value of hierarchy_id was returned in a previous call to MrmOpenHierarchyPerDisplay. so like, you can't just make one up, bestie, it has to come from that earlier call 👑
• index — specifies the UIL name of the bitmap literal to fetch. this is the name you're looking for in the hierarchy 🍓
• screen — specifies the screen used for the pixmap. The screen argument specifies a pointer to the Xlib structure Screen which contains the information about that screen and is linked to the Display structure. For more information on the Display and Screen structures, see the Xlib function XOpenDisplay and the associated screen information macros. ✨
• display — specifies the display used for the pixmap. The display argument specifies the connection to the X server. For more information on the Display structure, see the Xlib function XOpenDisplay. that's your link to the server, periodt 💜
• pixmap_return — returns the resulting X pixmap value. The function allocates space for this pixmap. The application is responsible for managing the allocated space. The application can recover the allocated space by calling XmDestroyPixmap. > so heads up bestie, this function hands you memory and then it's your job to deal with it. don't be the girl who forgets to call XmDestroyPixmap, it's giving leak 😭
• width — specifies a pointer to the width of the pixmap. 📏
• height — specifies a pointer to the height of the pixmap. 📐

---

🔥 RETURN 🔥

This function returns one of the following status return constants:

• MrmSUCCESS — The function executed successfully. slay! 🎉
• MrmBAD_HIERARCHY — The hierarchy ID was invalid. 💀
• MrmNOT_FOUND — The bitmap literal was not found in the hierarchy. she's not here 🙈
• MrmWRONG_TYPE — The caller tried to fetch a literal of a type not supported by this function. wrong vibe check 🚫
• MrmFAILURE — The function failed. it happens, bestie 😭

---

🌈 RELATED 🌈

MrmFetchIconLiteral(3), MrmFetchLiteral(3), and XOpenDisplay(3). go read those next, iykyk 🫶

---

and that's the whole page, bestie 💖 this was MrmFetchBitmapLiteral, a library call, straight out of the Mrm manual — mwah, iconic, no notes ✨🎀