xcb_xfixes_get_cursor_image(3)

✨ xcb_xfixes_get_cursor_image ✨

okay bestie, so this is a page from the XCB Requests corner of the libxcb manual — it's the xcb_xfixes_get_cursor_image(3) situation and it is exactly what it sounds like: you're asking the X server "hey girl, what does the cursor look like right now" 🖱️✨

ngl the NAME section of this page is literally empty, which is giving mysterious main character energy, but we move 💅

---

🌸 SYNOPSIS 🌸

first, you gotta invite the header in:

#include <xcb/xfixes.h>

Request function

xcb_xfixes_get_cursor_image_cookie_t
       xcb_xfixes_get_cursor_image(xcb_connection_t *conn,

yes, that trailing comma is literally how it's printed on the page. we do not fix. we do not touch. periodt 💀

Reply datastructure

typedef struct xcb_xfixes_get_cursor_image_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    int16_t  x;
    int16_t  y;
    uint16_t width;
    uint16_t height;
    uint16_t xhot;
    uint16_t yhot;
    uint32_t cursor_serial;
    uint8_t  pad1[8];
} xcb_xfixes_get_cursor_image_reply_t;

Reply function

xcb_xfixes_get_cursor_image_reply_t
       *xcb_xfixes_get_cursor_image_reply(xcb_connection_t *conn,
       xcb_xfixes_get_cursor_image_cookie_t cookie,
       xcb_generic_error_t **e);

Reply accessors

uint32_t *xcb_xfixes_get_cursor_image_cursor_image(const
       xcb_xfixes_get_cursor_image_request_t *reply);

int xcb_xfixes_get_cursor_image_cursor_image_length(const
       xcb_xfixes_get_cursor_image_reply_t *reply);

xcb_generic_iterator_t
       xcb_xfixes_get_cursor_image_cursor_image_end(const
       xcb_xfixes_get_cursor_image_reply_t *reply);

---

🎀 REQUEST ARGUMENTS 🎀

• conn — your XCB connection to X11. that's it, that's the whole list, she's lowkey minimal and I respect it 🫶

---

💖 REPLY FIELDS 💖

• response_type — the type of this reply, and in this case it's XCB_XFIXES_GET_CURSOR_IMAGE. this field also lives inside xcb_generic_reply_t, so 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 giving "receipt number" energy 🧾
• length — how long the reply is, in words. and btw a word is 4 bytes, in case anyone was about to ask 🙈
• x — TODO: NOT YET DOCUMENTED.
• y — TODO: NOT YET DOCUMENTED.
• width — TODO: NOT YET DOCUMENTED.
• height — TODO: NOT YET DOCUMENTED.
• xhot — TODO: NOT YET DOCUMENTED.
• yhot — TODO: NOT YET DOCUMENTED.
• cursor_serial — TODO: NOT YET DOCUMENTED.

not the manpage leaving us on read for basically every field 😭 we don't know what they do either bestie, that's literally what it says, so I'm not gonna make anything up. no cap.

---

🌈 DESCRIPTION 🌈

okay so. the DESCRIPTION section on this page is... empty. absolutely nothing. a void. a blank little spot where lore should be 🌸 so we simply do not invent any. moving on!

---

💜 RETURN VALUE 💜

you get back an xcb_xfixes_get_cursor_image_cookie_t. and listen — errors have to be handled when you call the reply function xcb_xfixes_get_cursor_image_reply, okay? you can't just ignore them and hope, that's not the vibe 💅

if you'd rather handle your errors in the event loop instead, use xcb_xfixes_get_cursor_image_unchecked. see xcb-requests(3) for all the details on that whole situation ✨

---

🔥 ERRORS 🔥

this request does never generate any errors. iconic behavior honestly, zero drama, we love a chill request 🫶

---

🦋 SEE ALSO 🦋

this section is empty on the original page — no references listed, nothing to link out to. so there's nothing to pass along here, bestie 🌸

---

👑 AUTHOR 👑

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

---

and that's the whole page, bestie!! 💖 this one came to you from X Version 11 and libxcb 1.17.0 — the xcb_xfixes_get_cursor_image(3) page, out here living its mysterious undocumented life 🌈💅✨