xcb_dri3_buffer_from_pixmap(3)

💖 xcb_dri3_buffer_from_pixmap(3) 💖

okay bestie, so this is a page from XCB Requests — it's part of libxcb, and it lives in section 3 of the manual (that's the "library functions" section, iykyk). Buckle up, because this one is mostly vibes and TODO notes, and honestly? We respect the honesty. 🫶

---

✨ NAME ✨

xcb_dri3_buffer_from_pixmap — and that's it. That's the whole name section. No description. Empty. A blank canvas. The silence is loud, fr fr. 💀

---

🌸 SYNOPSIS 🌸

First thing you gotta do is pull in the header, no cap:

#include <xcb/dri3.h>

🎀 Request function 🎀

This is the function that sends the request, and it hands you back a cookie (a cookie, bestie, that's the actual XCB terminology, we didn't make it up):

xcb_dri3_buffer_from_pixmap_cookie_t
       xcb_dri3_buffer_from_pixmap(xcb_connection_t *conn,
       xcb_pixmap_t pixmap);

🦋 Reply datastructure 🦋

And here's the struct you get back — look at her, all fields and padding:

typedef struct xcb_dri3_buffer_from_pixmap_reply_t {
    uint8_t  response_type;
    uint8_t  nfd;
    uint16_t sequence;
    uint32_t length;
    uint32_t size;
    uint16_t width;
    uint16_t height;
    uint16_t stride;
    uint8_t  depth;
    uint8_t  bpp;
    uint8_t  pad0[12];
} xcb_dri3_buffer_from_pixmap_reply_t;

💅 Reply function 💅

And this is the one you actually call to redeem that cookie and get the goods:

xcb_dri3_buffer_from_pixmap_reply_t
       *xcb_dri3_buffer_from_pixmap_reply(xcb_connection_t *conn,
       xcb_dri3_buffer_from_pixmap_cookie_t cookie,
       xcb_generic_error_t **e);

---

⭐ REQUEST ARGUMENTS ⭐

• conn — the XCB connection to X11. Your little phone line to the server, basically. ✨
• pixmap — TODO: NOT YET DOCUMENTED. yeah. They said what they said. 🙈

---

🌈 REPLY FIELDS 🌈

• response_type — the type of this reply, and for this one specifically it's XCB_DRI3_BUFFER_FROM_PIXMAP. This field also shows up in the xcb_generic_reply_t, so you can use it to tell your replies apart from each other. It's the reply's little name tag. 👑
• sequence — the sequence number of the last request processed by the X11 server.
• length — the length of the reply, measured in words. And a word is 4 bytes, in case you were about to google it. 💜
• nfd — TODO: NOT YET DOCUMENTED.
• size — TODO: NOT YET DOCUMENTED.
• width — TODO: NOT YET DOCUMENTED.
• height — TODO: NOT YET DOCUMENTED.
• stride — TODO: NOT YET DOCUMENTED.
• depth — TODO: NOT YET DOCUMENTED.
• bpp — TODO: NOT YET DOCUMENTED.
• pixmap_fd — TODO: NOT YET DOCUMENTED.

bestie I'm not gonna lie to you: that is a lot of TODOs. Not me reading an entire field list of "NOT YET DOCUMENTED." 😭 The pad0[12] in the struct up there doesn't even get its own entry, so don't come for me about it.

---

🧚 DESCRIPTION 🧚

...yeah. It's empty. There is no description. It's giving mystery. It's giving figure it out yourself, queen. 🫶

---

🔥 RETURN VALUE 🔥

You get back an xcb_dri3_buffer_from_pixmap_cookie_t. Cute, right? But listen — errors have to be handled when you call the reply function, xcb_dri3_buffer_from_pixmap_reply. That's where they show up. Don't skip that part, I'm begging. 🙏

And if you'd rather handle errors inside your event loop instead (very main character of you), use xcb_dri3_buffer_from_pixmap_unchecked instead. See xcb-requests(3) for all the details on that whole situation.

---

💀 ERRORS 💀

This request does never generate any errors. Not one. Zero. A perfect, error-free angel. ✨

---

👑 SEE ALSO 👑

Nothing here. Empty section, empty heart. Moving on. 💅

---

🍓 AUTHOR 🍓

Generated from dri3.xml. If you've got corrections or improvements, hit up xcb@lists.freedesktop.org — they're literally asking, so slide into their inbox. 💌

---

okay that's the whole page, bestie, you made it to the end 🎉 — this one came from X Version 11 and libxcb 1.17.0, and it's signed off as xcb_dri3_buffer_from_pixmap(3). mwah, go forth and buffer responsibly 💖✨🦋