xcb_composite...verlay_window(3)

💖 xcb_composite_get_overlay_window 💖

okay bestie, welcome to the manual page xcb_composite...verlay_window(3) — yes the name is a little chopped, it's giving "my wig is slipping" but it's fine, we move. This is part of the XCB Requests crew and it's literally just asking the X server "hey girl, what's the overlay window for this window?"

---

🌸 NAME 🌸

xcb_composite_get_overlay_window — no description was provided, so we vibe with the function name itself 🫶

---

✨ SYNOPSIS ✨

first up, you gotta pull in the header:

#include <xcb/composite.h>

🎀 Request function

xcb_composite_get_overlay_window_cookie_t
       xcb_composite_get_overlay_window(xcb_connection_t *conn,
       xcb_window_t window);

🦋 Reply datastructure

typedef struct xcb_composite_get_overlay_window_reply_t {
    uint8_t      response_type;
    uint8_t      pad0;
    uint16_t     sequence;
    uint32_t     length;
    xcb_window_t overlay_win;
    uint8_t      pad1[20];
} xcb_composite_get_overlay_window_reply_t;

🧚 Reply function

xcb_composite_get_overlay_window_reply_t
       *xcb_composite_get_overlay_window_reply(xcb_connection_t *conn,
       xcb_composite_get_overlay_window_cookie_t cookie,
       xcb_generic_error_t **e);

---

🍓 REQUEST ARGUMENTS 🍓

• conn — the XCB connection to X11. your lil hotline to the server, she's everything 💅
• window — TODO: NOT YET DOCUMENTED. yeah... the docs said "figure it out" and honestly same. the source says it's not documented yet, so no cap, that's all we know. 🙈

---

💜 REPLY FIELDS 💜

• response_type — the type of this reply, and in this case it's XCB_COMPOSITE_GET_OVERLAY_WINDOW. this same field also lives in the xcb_generic_reply_t, so you can use it to tell your replies apart from each other. it's giving name tag at a party 🎀
• sequence — the sequence number of the last request processed by the X11 server. the receipts, basically
• length — the length of the reply, in words. and reminder bestie: a word is 4 bytes. not 2, not 8, 4. periodt ⭐
• overlay_win — TODO: NOT YET DOCUMENTED. the field is real, the description is a mystery, we simply do not know. 🫠

---

🌈 DESCRIPTION 🌈

there is literally nothing here in the original. no description, no lore, no tea. the section exists, it's just empty. iconic behaviour honestly — the page said "read the fields, I'm done here." 💀

---

👑 RETURN VALUE 👑

it returns an xcb_composite_get_overlay_window_cookie_t. and listen, this is the important part: errors have to be handled when you call the reply function xcb_composite_get_overlay_window_reply.

if you'd rather handle errors in the event loop instead, use xcb_composite_get_overlay_window_unchecked. and if you want the full deets on how any of this works, go read xcb-requests(3). 🫶

---

🔥 ERRORS 🔥

this request does never generate any errors. not a single one. she's a good girl, she causes no problems. ✨

---

🦋 SEE ALSO 🦋

nothing listed here in the original, so there's nothing to send you to. the section is just standing there, looking pretty. 💅

---

🌸 AUTHOR 🌸

Generated from composite.xml. Contact xcb@lists.freedesktop.org for corrections and improvements. they made the whole thing out of XML, which is wild, but we respect it. 🧚

---

bestie reminder: the manpage name up top was xcb_composite...verlay_window(3) — yes, truncated, yes it's giving "she ran out of characters", but the function is xcb_composite_get_overlay_window and now you know her. 💖

---

and that's the whole page!! 🎀 this was X Version 11, libxcb 1.17.0, bestie — thanks for reading all the way to the bottom, you're the main character, mwah 💜✨