xcb_glx_get_lightiv(3)

💖 xcb_glx_get_lightiv 💖

okay bestie, welcome to the xcb_glx_get_lightiv page from the XCB Requests family, manual section 3. it's a lil GLX request, it's giving "ask the server about a light parameter and get integers back", and we're gonna walk through it together. no gatekeeping 💅

---

✨ NAME ✨

xcb_glx_get_lightiv — the description line in the original is literally empty 🙈 so that's all we got, and we're keeping it that way, fr fr.

---

🌸 SYNOPSIS 🌸

first up, the include, because obviously:

#include <xcb/glx.h>

🎀 Request function 🎀

xcb_glx_get_lightiv_cookie_t xcb_glx_get_lightiv(xcb_connection_t *conn,
       xcb_glx_context_tag_t context_tag, uint32_t light,
       uint32_t pname);

🦋 Reply datastructure 🦋

this is the struct the reply comes back in, look at her:

typedef struct xcb_glx_get_lightiv_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    uint8_t  pad1[4];
    uint32_t n;
    int32_t  datum;
    uint8_t  pad2[12];
} xcb_glx_get_lightiv_reply_t;

💜 Reply function 💜

xcb_glx_get_lightiv_reply_t
       *xcb_glx_get_lightiv_reply(xcb_connection_t *conn,
       xcb_glx_get_lightiv_cookie_t cookie, xcb_generic_error_t **e);

⭐ Reply accessors ⭐

these are the lil helpers that reach into the reply for you, iconic behaviour honestly:

int32_t *xcb_glx_get_lightiv_data(const xcb_glx_get_lightiv_request_t
       *reply);

int xcb_glx_get_lightiv_data_length(const xcb_glx_get_lightiv_reply_t
       *reply);

xcb_generic_iterator_t xcb_glx_get_lightiv_data_end(const
       xcb_glx_get_lightiv_reply_t *reply);

---

🌈 REQUEST ARGUMENTS 🌈

• conn — the XCB connection to X11. she's the link to the server, your main character connection 🔥
• context_tag — TODO: NOT YET DOCUMENTED. yeah. the docs said "we'll get to it" and then did not get to it 😭
• light — TODO: NOT YET DOCUMENTED. same energy, bestie 💀
• pname — TODO: NOT YET DOCUMENTED. the trio of mystery args, we love a cliffhanger 🙈

---

🍓 REPLY FIELDS 🍓

• response_type — the type of this reply, and in this case it's XCB_GLX_GET_LIGHTIV. plot twist: this field is also chillin' in the xcb_generic_reply_t, so you can use it to tell your replies apart from each other. very "which one of y'all is this" 💅
• sequence — the sequence number of the last request the X11 server actually processed. receipts! 🧾
• length — the length of the reply, measured in words. and just so we're clear: a word is 4 bytes. no cap 📏
• n — TODO: NOT YET DOCUMENTED. 🫶
• datum — TODO: NOT YET DOCUMENTED. the second mystery of the reply, we stay guessing 😭

---

🧚 DESCRIPTION 🧚

there is genuinely no description text in the original. empty. a void. the page said "description:" and then just ✨vibed✨. so we're not inventing one, that's the rules bestie 🌸

---

👑 RETURN VALUE 👑

you get back an xcb_glx_get_lightiv_cookie_t. cute, right? but here's the thing — errors are not handled here. you handle them later, when you call the reply function xcb_glx_get_lightiv_reply.

and if you'd rather handle errors in the event loop instead? then use xcb_glx_get_lightiv_unchecked. see xcb-requests(3) for the details, iykyk 🫶

---

💀 ERRORS 💀

this request does never generate any errors. periodt. zero drama, zero errors, she's unproblematic 💅✨

---

🌈 SEE ALSO 🌈

the original lists nothing here. an empty section, a blank canvas, we respect the minimalist queen 🙈

---

💜 AUTHOR 💜

generated from glx.xml. got corrections or improvements? hit up xcb@lists.freedesktop.org — they're taking notes 📝

---

that's the whole page bestie, you ate it up 🎀

X Version 11 · libxcb 1.17.0 · xcb_glx_get_lightiv(3) — signing off, love u, go read xcb-requests(3) 💖🦋✨