xcb_put_image(3)

💖 xcb_put_image — the manual page, but make it cute 💖

okay bestie, gather round, because this one is from the XCB Requests corner of the universe and it's a <cyan>xcb_put_image(3)</cyan> situation. it's a request function. it puts an image. that's the whole vibe. ✨

---

✨ NAME ✨

xcb_put_image —

(yeah, that's it. the description is literally blank. the manpage said nothing. iconic, honestly. 🫶)

---

🌸 SYNOPSIS 🌸

first things first, you gotta pull in the header:

#include <xcb/xproto.h>

Request function 🎀

xcb_void_cookie_t xcb_put_image(xcb_connection_t *conn, uint8_t format,
       xcb_drawable_t drawable, xcb_gcontext_t gc, uint16_t width,
       uint16_t height, int16_t dst_x, int16_t dst_y, uint8_t left_pad,
       uint8_t depth, uint32_t data_len, const uint8_t *data);

like. look at all those arguments. twelve of them. twelve!! she's got range, no cap. 💅

---

🦋 REQUEST ARGUMENTS 🦋

• conn — the XCB connection to X11. your lil hotline to the server, bestie. 📞
• format — okay so this one takes one of the following values:
  • XCB_IMAGE_FORMAT_XY_BITMAP — TODO: NOT YET DOCUMENTED.
  • XCB_IMAGE_FORMAT_XY_PIXMAP — TODO: NOT YET DOCUMENTED.
  • XCB_IMAGE_FORMAT_Z_PIXMAP — TODO: NOT YET DOCUMENTED.
    • TODO: NOT YET DOCUMENTED.

and yes, there really is an extra stray TODO: NOT YET DOCUMENTED. hanging out under Z_PIXMAP with zero explanation. the docs are mysterious. we respect the mystery. 🔥

• drawable — TODO: NOT YET DOCUMENTED.
• gc — TODO: NOT YET DOCUMENTED.
• width — TODO: NOT YET DOCUMENTED.
• height — TODO: NOT YET DOCUMENTED.
• dst_x — TODO: NOT YET DOCUMENTED.
• dst_y — TODO: NOT YET DOCUMENTED.
• left_pad — TODO: NOT YET DOCUMENTED.
• depth — TODO: NOT YET DOCUMENTED.
• data_len — TODO: NOT YET DOCUMENTED.
• data — TODO: NOT YET DOCUMENTED.

lowkey the entire argument list is a group chat where nobody replied. 😭 that's not me being shady, that's literally what the page says. every single one. respect.

---

🌈 DESCRIPTION 🌈

nothing. it's blank. there is no description. the void. the silence. the drama of it all. 💀

---

⭐ RETURN VALUE ⭐

Returns an xcb_void_cookie_t. and listen — errors (if any) have to be handled in the event loop. you don't get them handed to you here, bestie, you gotta go get them.

if you'd rather handle errors directly with xcb_request_check instead, then use xcb_put_image_checked. go see xcb-requests(3) for the deets. 🎀

---

👑 ERRORS 👑

this request does never generate any errors.

zero. none. not a single one. she's unbothered, she's flawless, she's not giving you error codes. 💅✨

---

🧚 SEE ALSO 🧚

nothing listed. empty. blank. a moment of peace before the AUTHOR section. 🌸

---

💜 AUTHOR 💜

Generated from xproto.xml. Contact xcb@lists.freedesktop.org for corrections and improvements. 📧

---

okay that's the whole page, and yes it's mostly TODOs, but honestly? main character energy. we love an underdocumented XCB request. 🫶

this was xcb_put_image(3) from X Version 11, libxcb 1.17.0, and that's the tea. drink up, bestie. 🍓✨💖