xcb_present_pixmap_synced(3)

💖 xcb_present_pixmap_synced 💖

okay bestie, sit down, hydrate, because we're looking at xcb_present_pixmap_synced(3) — a section 3 (library call, not a command, so no shell shenanigans) manual page from the XCB Requests crew. this is a libxcb thing, it lives in the X11 world, and it's giving "the Present extension but synced." that's literally the whole name. periodt. 🎀

✨ NAME ✨

xcb_present_pixmap_synced — and then… nothing. the description slot is empty, bestie. blank. a void. we move. 💀

🌸 SYNOPSIS 🌸

first you gotta let the compiler know this exists:

#include <xcb/present.h>

then, the request function itself — look at this signature, it's long, she ate:

xcb_void_cookie_t xcb_present_pixmap_synced(xcb_connection_t *conn,
       xcb_window_t window, xcb_pixmap_t pixmap, uint32_t serial,
       xcb_xfixes_region_t valid, xcb_xfixes_region_t update,
       int16_t x_off, int16_t y_off, xcb_randr_crtc_t target_crtc,
       xcb_dri3_syncobj_t acquire_syncobj,
       xcb_dri3_syncobj_t release_syncobj, uint64_t acquire_point,
       uint64_t release_point, uint32_t options, uint64_t target_msc,
       uint64_t divisor, uint64_t remainder, uint32_t notifies_len,
       const xcb_present_notify_t *notifies);

nineteen parameters. NINETEEN. she's high maintenance and we respect it. 👑

🦋 REQUEST ARGUMENTS 🦋

so like… the docs for every single one of these say the same thing, and I have to keep it 100 with you: they are all TODO: NOT YET DOCUMENTED. every last one. no cap. I'm not gonna make stuff up, that's not the vibe. so here's the full roll call, in order, all of them mysteries:

• conn — The XCB connection to X11.
• window — TODO: NOT YET DOCUMENTED.
• pixmap — TODO: NOT YET DOCUMENTED.
• serial — TODO: NOT YET DOCUMENTED.
• valid — TODO: NOT YET DOCUMENTED.
• update — TODO: NOT YET DOCUMENTED.
• x_off — TODO: NOT YET DOCUMENTED.
• y_off — TODO: NOT YET DOCUMENTED.
• target_crtc — TODO: NOT YET DOCUMENTED.
• acquire_syncobj — TODO: NOT YET DOCUMENTED.
• release_syncobj — TODO: NOT YET DOCUMENTED.
• acquire_point — TODO: NOT YET DOCUMENTED.
• release_point — TODO: NOT YET DOCUMENTED.
• options — TODO: NOT YET DOCUMENTED.
• target_msc — TODO: NOT YET DOCUMENTED.
• divisor — TODO: NOT YET DOCUMENTED.
• remainder — TODO: NOT YET DOCUMENTED.
• notifies_len — TODO: NOT YET DOCUMENTED.
• notifies — TODO: NOT YET DOCUMENTED.

yeah. the whole squad is undocumented. it's giving "we'll write the docs later" and later never came. 🙈

💅 DESCRIPTION 💅

okay so. this section… is empty. truly empty. nothing here. not a single character of description. the manpage said "DESCRIPTION" and then just. didn't. main character energy but make it silence. 🫶

⭐ RETURN VALUE ⭐

this bad girl hands you back an xcb_void_cookie_t. and if errors show up? you don't catch them here, bestie — you handle them in the event loop. that's the deal.

but if you're the type who wants to check errors directly instead — say, with xcb_request_check — then you want the checked variant: xcb_present_pixmap_synced_checked. head to xcb-requests(3) for the full tea on how that works.

💀 ERRORS 💀

good news for once: this request does never generate any errors. clean. flawless. no drama. iconic. ✨

🔥 SEE ALSO 🔥

this section is empty too, bestie. nothing cross-referenced here. just vibes and blank space. 🌈

👑 AUTHOR 👑

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

and that's the whole page! 💖 tysm for reading, go forth and present your pixmaps (synced-ly), and remember: this lil' slice of documentation is from X Version 11, libxcb 1.17.0, dated with the section-3 manual tag xcb_present_pixmap_synced(3). mwah. 🎀✨🦋