xcb_copy_plane(3)

💖 xcb_copy_plane — from the XCB Requests manual 💖

okay bestie, we're doing a libxcb deep-dive and this one is short but she's still iconic. it's xcb_copy_plane, and yes she lives in section 3 of the manual, right there next to all the other XCB Requests girlies. let's get into it 🦋

---

✨ NAME ✨

xcb_copy_plane -

ngl the original manpage literally leaves the description blank here. no cap. not me being handed an empty NAME and just... holding it. we love an enigmatic queen 💅 (the function name itself is right there in the heading, so you're not lost, promise.)

---

🌸 SYNOPSIS 🌸

#include <xcb/xproto.h>

🎀 Request function 🎀

xcb_void_cookie_t xcb_copy_plane(xcb_connection_t *conn,
       xcb_drawable_t src_drawable, xcb_drawable_t dst_drawable,
       xcb_gcontext_t gc, int16_t src_x, int16_t src_y, int16_t dst_x,
       int16_t dst_y, uint16_t width, uint16_t height,
       uint32_t bit_plane);

so yeah, she returns an xcb_void_cookie_t and takes a lot of arguments. ten of them, plus conn. it's giving "I have a big friend group and you're meeting all of them at once" 😭

---

💜 REQUEST ARGUMENTS 💜

• conn — the XCB connection to X11. your whole lil link to the X server, the group chat itself 🫶
• src_drawable — TODO: NOT YET DOCUMENTED.
• dst_drawable — TODO: NOT YET DOCUMENTED.
• gc — TODO: NOT YET DOCUMENTED.
• src_x — TODO: NOT YET DOCUMENTED.
• src_y — TODO: NOT YET DOCUMENTED.
• dst_x — TODO: NOT YET DOCUMENTED.
• dst_y — TODO: NOT YET DOCUMENTED.
• width — TODO: NOT YET DOCUMENTED.
• height — TODO: NOT YET DOCUMENTED.
• bit_plane — TODO: NOT YET DOCUMENTED.

bestie I'm not even joking, the manpage says TODO: NOT YET DOCUMENTED. for literally all of those. every single one. the docs said "we'll finish this later" and then never did. the way that this has been the vibe since forever 😭 I'm not about to invent behaviour for them either, so they stay exactly as they are. no cap, no guessing, we respect the source ✋

---

🦋 DESCRIPTION 🦋

...yeah so this section is empty in the original. like, completely. not a single word. the void. the silence. the audacity ✨

(I'm keeping the section because it's supposed to be here — I'm just telling you the truth about what's inside it: nothing. it's giving "empty Google Doc titled final_final_v2" 💀)

---

🔥 RETURN VALUE 🔥

Returns an xcb_void_cookie_t. Errors (if any) have to be handled in the event loop.

If you want to handle errors directly with xcb_request_check instead, use xcb_copy_plane_checked. See xcb-requests(3) for details.

so like — she hands you back a cookie, and if anything went wrong you find out later, when you're already in your event loop era. that's the whole xcb_void_cookie_t lifestyle. if you'd rather find out immediately, the checked twin xcb_copy_plane_checked is right there, and xcb-requests(3) has the full lore 👑

---

⭐ ERRORS ⭐

This request does never generate any errors.

periodt!! zero errors, clean sheet, no drama. she's unbothered, moisturized, in her lane 💅✨

---

🌈 SEE ALSO 🌈

(same situation as DESCRIPTION — the original leaves this one empty too, so there's nothing to list here. no references, no friends to tag, just vibes 💀)

---

👑 AUTHOR 👑

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

the whole thing is auto-generated from xproto.xml, so if you spot something sus, that's the email to hit up. they literally invite corrections and improvements, so go off 🫶

---

and that's the whole page bestie!! short, sweet, and honestly kind of mysterious given how much of it is blank. still iconic tho. slay 💅

this was brought to you by X Version 11 and libxcb 1.17.0 — those are the source/version vibes from the footer of xcb_copy_plane(3) 🌸 stay hydrated, read your manpages, and always check the return cookie 🎀