xcb_circulate_window(3)

📦
version 1.17.0 · 4 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_circulate_window — from the xcb_circulate_window(3) manual, bestie 💖

okay so picture this: you're deep in the XCB docs (iconic of you), and you found the one that literally just shuffles windows around in the stack. that's it. that's the girl. no cap, she does one job and she does it flawlessly. 🦋

✨ NAME ✨

xcb_circulate_window — change window stacking order 💅

🌸 SYNOPSIS 🌸

#include <xcb/xproto.h>

🎀 Request function 🎀

xcb_void_cookie_t xcb_circulate_window(xcb_connection_t *conn,
       uint8_t direction, xcb_window_t window);

💜 REQUEST ARGUMENTS 💜

  • conn — the XCB connection to X11. your lil hotline to the server, basically 🫶
  • direction — one of these values, periodt:
    • XCB_CIRCULATE_RAISE_LOWEST — TODO: NOT YET DOCUMENTED. 😭 yeah bestie, the docs really said "we'll get to it" and then didn't. not our fault, we're just reporting the facts fr fr.
    • XCB_CIRCULATE_LOWER_HIGHEST — TODO: NOT YET DOCUMENTED. 🙈 same energy, same missing tea.
  • window — the window to raise/lower (depends on which direction you picked, obviously 💅).

🔥 DESCRIPTION 🔥

so here's the vibe check. if direction is XCB_CIRCULATE_RAISE_LOWEST, the lowest mapped child (if there even is one, no pressure) gets raised all the way to the top of the stack. glow up moment. 👑

and if direction is XCB_CIRCULATE_LOWER_HIGHEST, then the highest mapped child gets lowered straight to the bottom of the stack. it's giving humble era. 🌈

⭐ RETURN VALUE ⭐

she returns an xcb_void_cookie_t. any errors? those have to be handled in the event loop, bestie — that's just how the cookie crumbles 🍓.

but wait, if you'd rather handle errors directly with xcb_request_check instead, then use xcb_circulate_window_checked. head to xcb-requests(3) for the full details, iykyk.

💀 ERRORS 💀

  • xcb_value_error_t — the specified direction is invalid. like, pick a real one bestie 😭
  • xcb_window_error_t — the specified window does not exist. she's not here. she never was. 💀

🦋 SEE ALSO 🦋

👑 AUTHOR 👑

Generated from xproto.xml. Contact xcb@lists.freedesktop.org for corrections and improvements. (they're literally asking for your input, so speak up bestie 🫶)

and that's the whole page, no notes. this one ships as part of X Version 11, specifically libxcb 1.17.0 — go forth and stack your windows exactly how you want them. slay, stay hydrated, and remember: mapped children only. 💖✨🎀

📦 where this page comes from