XCB_RES_QUERY_CLIENT_PIXMAP_BYTES_REPLY(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_res_query_client_pixmap_bytes β€” the manual page, but make it make sense πŸ’–

okay bestie, pull up a chair, because we're reading a libxcb page from the XCB Requests fam and honestly? it's giving "the docs left half the homework blank." but we're gonna work with what we got, no cap. ✨


🌸 NAME 🌸

xcb_res_query_client_pixmap_bytes β€” and that's it. that's the whole name. the manpage literally just... stops. iconique of it, honestly. πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

first things first, you gotta bring in the header:

#include <xcb/res.h>

✨ Request function ✨

here's the lil guy you call to send the request off into the void:

xcb_res_query_client_pixmap_bytes_cookie_t
       xcb_res_query_client_pixmap_bytes(xcb_connection_t *conn,
       uint32_t xid);

πŸŽ€ Reply datastructure πŸŽ€

and this is the struct that comes back at you β€” every field, verbatim, do not touch:

typedef struct xcb_res_query_client_pixmap_bytes_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    uint32_t bytes;
    uint32_t bytes_overflow;
} xcb_res_query_client_pixmap_bytes_reply_t;

πŸ’œ Reply function πŸ’œ

and this is how you actually go get that reply, bestie:

xcb_res_query_client_pixmap_bytes_reply_t
       *xcb_res_query_client_pixmap_bytes_reply(xcb_connection_t *conn,
       xcb_res_query_client_pixmap_bytes_cookie_t cookie,
       xcb_generic_error_t **e);

πŸ‘‘ REQUEST ARGUMENTS πŸ‘‘

  • conn β€” your XCB connection to X11. the whole pipeline to the server, the main character of the operation. πŸ”₯
  • xid β€” and the docs say... TODO: NOT YET DOCUMENTED. yeah. that's it. that's the description. we know it's an id, we know it's a uint32_t, and beyond that the manpage is staying mysterious. πŸ™ˆ

🌈 REPLY FIELDS 🌈

  • response_type β€” what kind of reply this is. in this case it's XCB_RES_QUERY_CLIENT_PIXMAP_BYTES. this field also lives in xcb_generic_reply_t, so you can use it to tell your replies apart from each other when they're all just vibing in the same place. πŸ’«
  • sequence β€” the sequence number of the last request the X11 server processed. it's the server's little timestamp of "yeah I got to this point." ⭐
  • length β€” how long the reply is, measured in words. and reminder bestie: a word is 4 bytes. ✨
  • bytes β€” TODO: NOT YET DOCUMENTED. the mystery continues, we love an enigma. 🫢
  • bytes_overflow β€” TODO: NOT YET DOCUMENTED. the sequel to the mystery. also undocumented. also iconic for it. πŸ’€

🧚 DESCRIPTION 🧚

so... there is a DESCRIPTION section. and it is empty. completely, utterly blank. not a single word. it's giving "we made a section and forgot to fill it in," and honestly? relatable. no cap, that's just how this page is. πŸ’–


πŸ’… RETURN VALUE πŸ’…

it hands you back an xcb_res_query_client_pixmap_bytes_cookie_t. cookies are for later, babes β€” errors have to be handled when you call the reply function xcb_res_query_client_pixmap_bytes_reply.

and if you'd rather catch your errors in the event loop instead of right at the reply? use xcb_res_query_client_pixmap_bytes_unchecked. the deets on all that are over in xcb-requests(3). 🌸


πŸ’€ ERRORS πŸ’€

good news for once: this request never generates any errors. not a single one. zero. the vibes are immaculate. πŸŽ€

πŸ¦„ SEE ALSO πŸ¦„

...nothing here either bestie. the section exists and then simply does not elaborate. we move. πŸ“


πŸ’œ AUTHOR πŸ’œ

Generated from res.xml. if you've got corrections or improvements, hit up xcb@lists.freedesktop.org. they're the ones who can fix it. ✨


and that's the whole page, bestie! 🫢 this absolute legend of a manpage is brought to you by X Version 11 and libxcb 1.17.0, and if you ever wondered why half the fields say TODO β€” now you know, and knowing is half the battle. slay, stay connected, and may your xids always resolve. πŸ’–πŸŒˆβœ¨πŸ‘‘