xcb_randr_create_lease(3)

💖 xcb_randr_create_lease 💖

okay bestie, welcome to the xcb_randr_create_lease page from the XCB Requests fam (that's xcb_randr_create_lease(3) if you're being formal at the function's birthday party 🎂). grab a lil snack, we're doing randr leases today and honestly? iconic behaviour.

---

✨ NAME ✨

xcb_randr_create_lease — literally no description here 😭 the original page leaves this blank, so we're leaving it blank too. the vibes are mysterious, the function is named, that's the whole story fr fr.

---

🌈 SYNOPSIS 🌈

First things first, you gotta pull in the header, no cap:

#include <xcb/randr.h>

🎀 Request function

xcb_randr_create_lease_cookie_t
       xcb_randr_create_lease(xcb_connection_t *conn,
       xcb_window_t window, xcb_randr_lease_t lid, uint16_t num_crtcs,
       uint16_t num_outputs, const xcb_randr_crtc_t *crtcs, const
       xcb_randr_output_t *outputs);

🦋 Reply datastructure

the lil struct you get back, exactly as written:

typedef struct xcb_randr_create_lease_reply_t {
    uint8_t  response_type;
    uint8_t  nfd;
    uint16_t sequence;
    uint32_t length;
    uint8_t  pad0[24];
} xcb_randr_create_lease_reply_t;

🌸 Reply function

xcb_randr_create_lease_reply_t
       *xcb_randr_create_lease_reply(xcb_connection_t *conn,
       xcb_randr_create_lease_cookie_t cookie, xcb_generic_error_t **e);

---

💅 REQUEST ARGUMENTS 💅

the tea on every single thing you're passing in:

• conn — your XCB connection to X11. it's giving "the whole reason we're here" energy.
• window — TODO: NOT YET DOCUMENTED. 🙈 the docs just did not show up to class today.
• lid — TODO: NOT YET DOCUMENTED. same, bestie. same.
• num_crtcs — TODO: NOT YET DOCUMENTED. the mystery continues.
• num_outputs — TODO: NOT YET DOCUMENTED. not a single clue was provided 😭
• crtcs — TODO: NOT YET DOCUMENTED. undoc'd and unbothered.
• outputs — TODO: NOT YET DOCUMENTED. we truly know nothing and that's the situation.

ngl, this whole arguments section is a group chat where everyone left you on read. that's just how the page is, we're not inventing lore 🔥

---

👑 REPLY FIELDS 👑

what's inside that reply when it comes back to you:

• response_type — the type of this reply, which in this case is XCB_RANDR_CREATE_LEASE. this field is also chilling in the xcb_generic_reply_t, and you can use it to tell replies apart from each other. it's basically the reply's little name tag 🏷️
• sequence — the sequence number of the last request that got processed by the X11 server.
• length — how long the reply is, in words (and a word is 4 bytes, so do your lil math 🧮).
• nfd — TODO: NOT YET DOCUMENTED. 🫠
• master_fd — TODO: NOT YET DOCUMENTED. also undocumented, also mysterious, also somehow on the list. periodt.

---

🧚 DESCRIPTION 🧚

okay so. the original page has a DESCRIPTION section and it is... completely empty. nothing. a void. a blank canvas. a main character with no backstory 💀 we are preserving that emptiness exactly as it came, because we keep every single detail, including the details that are literally nothing. respect the emptiness bestie ✨

---

⭐ RETURN VALUE ⭐

it hands you back an xcb_randr_create_lease_cookie_t. 🍪 (a cookie!! how cute is that)

errors? you gotta deal with those yourself, and specifically when you call the reply function xcb_randr_create_lease_reply.

and if you'd rather handle errors in the event loop instead, use xcb_randr_create_lease_unchecked. see xcb-requests(3) for the deets. iykyk 💜

---

🍓 ERRORS 🍓

this request does never generate any errors. ✨

zero drama, zero errors, the most well-behaved request in the whole building. we love a low-maintenance icon 👑

---

🔥 SEE ALSO 🔥

nothing listed here! the original SEE ALSO section is empty, so there's nothing to point you at. a moment of silence for the cross-references that never were 😭🌸

---

🌈 AUTHOR 🌈

generated from randr.xml. if you've got corrections and improvements, hit up xcb@lists.freedesktop.org — they're literally waiting for your feedback, bestie 🫶

---

and that's the whole page! 💖 this beauty came to you from X Version 11, libxcb 1.17.0, and yes it's xcb_randr_create_lease(3) — go forth, make leases, slay the randr game. mwah 💅✨🎀