xcb_sync_initialize(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_sync_initialize πŸ’–

okay bestie, welcome to the xcb_sync_initialize page β€” it lives in the XCB Requests corner of the manual (section 3, for all you keeping score at home) πŸ’…. It's giving ✨sync extension handshake✨ and honestly? We're obsessed.


✨ NAME ✨

xcb_sync_initialize β€” no description here, the original literally just leaves it blank, and we respect the mystery 🫢


🌸 SYNOPSIS 🌸

#include <xcb/sync.h>

πŸŽ€ Request function πŸŽ€

xcb_sync_initialize_cookie_t xcb_sync_initialize(xcb_connection_t *conn,
       uint8_t desired_major_version, uint8_t desired_minor_version);

πŸ¦‹ Reply datastructure πŸ¦‹

typedef struct xcb_sync_initialize_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    uint8_t  major_version;
    uint8_t  minor_version;
    uint8_t  pad1[22];
} xcb_sync_initialize_reply_t;

⭐ Reply function ⭐

xcb_sync_initialize_reply_t
       *xcb_sync_initialize_reply(xcb_connection_t *conn,
       xcb_sync_initialize_cookie_t cookie, xcb_generic_error_t **e);

πŸ’œ REQUEST ARGUMENTS πŸ’œ

  • conn β€” the XCB connection to X11, obvi. your lil hotline to the server πŸ”₯
  • desired_major_version β€” TODO: NOT YET DOCUMENTED. yeah bestie, the docs said "idk yet" and we're just relaying that fr fr 😭
  • desired_minor_version β€” also TODO: NOT YET DOCUMENTED. same energy, same void πŸ™ˆ

πŸ“ REPLY FIELDS πŸ“

  • response_type β€” the type of this reply, which in this case is XCB_SYNC_INITIALIZE. This field is also chillin' inside the xcb_generic_reply_t, and you can use it to tell your replies apart from each other, like name tags at a party πŸŽ€
  • sequence β€” the sequence number of the last request processed by the X11 server. it's the receipts, basically 🧾
  • length β€” the length of the reply, in words. and yes, a word is 4 bytes, not a vibe πŸ’€
  • major_version β€” TODO: NOT YET DOCUMENTED. the plot hole remains πŸ•³οΈ
  • minor_version β€” TODO: NOT YET DOCUMENTED. same hole, different field πŸ™ˆ

🌈 DESCRIPTION 🌈

...there is literally nothing here. the DESCRIPTION section is empty. an absolute icon of leaving you on read. no cap, that's the whole thing πŸ’…


πŸ‘‘ RETURN VALUE πŸ‘‘

Returns an xcb_sync_initialize_cookie_t. Errors have to be handled when you call the reply function xcb_sync_initialize_reply.

If you'd rather handle errors in the event loop instead, use xcb_sync_initialize_unchecked. See xcb-requests(3) for the deets 🫢


πŸ’€ ERRORS πŸ’€

This request never generates any errors. not one. zero. a truly unproblematic fave, we love to see it ✨


πŸ”₯ SEE ALSO πŸ”₯

...yeah the SEE ALSO section is empty too. it's giving "no thoughts, head empty" and honestly, iconic behavior πŸŽ€


🌸 AUTHOR 🌸

Generated from sync.xml. Contact xcb@lists.freedesktop.org for corrections and improvements.


🫢 quick reminder bestie: all those TODO: NOT YET DOCUMENTED. fields are straight from the source, so don't come for me, I'm just the messenger πŸ’–

X Version 11 🌈 libxcb 1.17.0 πŸ¦‹ that's the version and the date-of-record, and xcb_sync_initialize(3) is the page you're on, mwah πŸ’…βœ¨ periodt.