xcb_composite_redirect_window(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_window — the XCB requests girlies' era ✨

okay bestie, welcome to the xcb_composite_redirect_window(3) page, part of the XCB Requests lineup 💖

🌸 NAME 🌸

xcb_composite_redirect_window — redirect the hierarchy starting at "window" to off-screen storage 💅

🦋 SYNOPSIS 🦋

#include <xcb/composite.h>

🎀 Request function 🎀

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

💜 REQUEST ARGUMENTS 💜

  • conn — the XCB connection to X11, obviously, she's the whole plot 🫶
  • window — the root of the hierarchy you're redirecting to off-screen storage 👑
  • 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, any attempt by another to specify a mode of Manual so will result in an Access error. no cap, that's literally what it says 🙈

🌈 DESCRIPTION 🌈

The hierarchy starting at 'window' is directed to off-screen storage ✨. And when all clients enabling redirection terminate, the redirection will automatically be disabled — she cleans up after herself, iconic 💅.

The root window may not be redirected. Doing so results in a Match error. like, do not do that, bestie, it's giving error code 😭

💖 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_composite_redirect_window_checked. See xcb-requests(3) for the deets 📚.

💀 ERRORS 💀

This request does never generate any errors. (not me reading this after the Access error and Match error lore earlier… iykyk 🙈)

⭐ SEE ALSO ⭐

🧚 AUTHOR 🧚

Generated from composite.xml. Contact xcb@lists.freedesktop.org for corrections and improvements — they're literally so responsive, periodt 💌

and that's the whole page, bestie! this one shipped with libxcb 1.17.0, part of X Version 11 🎀 thanks for reading, mwah 💋

📦 where this page comes from