XCB_COMPOSITE_REDIRECT_SUBWINDOWS_CHECKED(3)

📦
version 1.17.0 · 5 versions
, in alpine 3.22, alpine 3.23, alpine 3.24, arch rolling, centos-stream 10, debian trixie, fedora 43, fedora 44, nixpkgs unstable, opensuse-leap 16.0, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 xcb_composite_redirect_subwindows — bestie edition 💖

okay so this is a page from the XCB Requests corner of the libxcb 1.17.0 world (X Version 11, if you're keeping score), and it's all about snatching up a whole window family and yeeting it off-screen. sit down, hydrate, let's go 🍓

✨ NAME ✨

xcb_composite_redirect_subwindows — redirect all current and future children of window 🫶

like. every child. the ones that exist right now and the ones that haven't even been born yet. no cap.

🌸 SYNOPSIS 🌸

#include <xcb/composite.h>

🎀 Request function

xcb_void_cookie_t
       xcb_composite_redirect_subwindows(xcb_connection_t *conn,
       xcb_window_t window, uint8_t update);

she's a void cookie, she's got three args, she's iconic 💅

🦋 REQUEST ARGUMENTS 🦋

  • conn — the XCB connection to X11. your little phone line to the server, basically.
  • window — the root of the hierarchy to redirect to off-screen storage. this is the main character whose whole bloodline gets redirected 👑
  • update — whether contents are automatically mirrored to the parent window. and here's the tea: if one client already specifies an update type of Manual, then any attempt by another client to specify a mode of Manual too will result in an Access error. so like, one Manual at a time, bestie, there's only one aux cord 😭

💜 DESCRIPTION 💜

Hierarchies starting at all current and future children of window will be redirected as in RedirectWindow. yes, the whole tree. yes, including the future ones. she's thorough like that ✨

and if update is Manual, then painting of the window background during window manipulation and ClearArea requests is inhibited. so the background just… doesn't get painted in those situations. no vibe, no paint, periodt.

⭐ RETURN VALUE ⭐

Returns an xcb_void_cookie_t. any errors (if there are any) have to be handled in the event loop — that's where the drama shows up, not here 🎭

if you'd rather handle errors directly with xcb_request_check instead, then use xcb_composite_redirect_subwindows_checked (yes the checked twin, she's right there). see xcb-requests(3) for the details, iykyk.

💀 ERRORS 💀

This request does never generate any errors. not one. zero. she's on her best behaviour, she's a good girl 🙈✨

🌈 SEE ALSO 🌈

🧚 AUTHOR 🧚

Generated from composite.xml. Contact xcb@lists.freedesktop.org for corrections and improvements — like, if something's off, tell the humans, not me 💖

and that's the whole page, bestie!! X Version 11, libxcb 1.17.0 — go redirect something and slay 💅🫶✨

📦 where this page comes from