xcb_unmap_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_unmap_window β€” the XCB Requests page, bestie edition ✨

okay so this is xcb_unmap_window(3), from the XCB Requests manual. it's the little guy you call when you want a window to just… ✨disappear✨ (visually, anyway). let's get into it πŸ’…


🌸 NAME 🌸

xcb_unmap_window β€” makes a window invisible πŸ«₯


πŸŽ€ SYNOPSIS πŸŽ€

#include <xcb/xproto.h>

πŸ’– Request function πŸ’–

xcb_void_cookie_t xcb_unmap_window(xcb_connection_t *conn,
       xcb_window_t window);

πŸ¦‹ REQUEST ARGUMENTS πŸ¦‹

  • conn β€” your XCB connection to X11. the whole vibe pipeline, the link between you and the server 🫢
  • window β€” the window you're about to make invisible. say bye bestie πŸ‘‹

🌈 DESCRIPTION 🌈

Unmaps the specified window. which is a fancy way of saying: it makes that window invisible, and all of its child windows too. the whole little family goes ghost mode πŸ«₯✨

and because nothing in X ever happens quietly, unmapping a window leads to the UnmapNotify event being generated. also? Expose events get generated for formerly obscured windows β€” so everything that was hiding behind your window is about to wake up and be like "oh we're visible now?!" 😭


πŸ’œ RETURN VALUE πŸ’œ

Returns an xcb_void_cookie_t. and ngl, that's the tea: errors (if any) have to be handled in the event loop, not right here. the cookie is just the receipt, the drama arrives later πŸ“¬

if you'd rather handle errors directly with xcb_request_check instead, use xcb_unmap_window_checked. see xcb-requests(3) for details. iykyk πŸ‘‘


πŸ’€ ERRORS πŸ’€

  • xcb_window_error_t β€” the specified window does not exist. like, you tried to unmap a window that isn't there. nothing to unmute, bestie, it's giving ghost 🫠

🌟 SEE ALSO 🌟


πŸ‘‘ AUTHOR πŸ‘‘

Generated from xproto.xml. Contact xcb@lists.freedesktop.org for corrections and improvements. so if you spot something off, you know who to email fr fr πŸ’Œ


and that's the whole page, no cap. this came to you from X Version 11, libxcb 1.17.0, dated as ever and looking iconic πŸ’…βœ¨ thanks for reading, mwah 🫢