xcb_query_pointer(3)

💖 xcb_query_pointer — get pointer coordinates 💖

okay bestie, welcome to the xcb_query_pointer(3) page from the XCB Requests fam 🫶 this one's all about asking the X server hey where is that cursor rn and it answers, no cap.

---

✨ NAME ✨

xcb_query_pointer — get pointer coordinates 🦋

---

🌸 SYNOPSIS 🌸

#include <xcb/xproto.h>

🎀 Request function

xcb_query_pointer_cookie_t xcb_query_pointer(xcb_connection_t *conn,
       xcb_window_t window);

🎀 Reply datastructure

typedef struct xcb_query_pointer_reply_t {
    uint8_t      response_type;
    uint8_t      same_screen;
    uint16_t     sequence;
    uint32_t     length;
    xcb_window_t root;
    xcb_window_t child;
    int16_t      root_x;
    int16_t      root_y;
    int16_t      win_x;
    int16_t      win_y;
    uint16_t     mask;
    uint8_t      pad0[2];
} xcb_query_pointer_reply_t;

🎀 Reply function

xcb_query_pointer_reply_t
       *xcb_query_pointer_reply(xcb_connection_t *conn,
       xcb_query_pointer_cookie_t cookie, xcb_generic_error_t **e);

---

💅 REQUEST ARGUMENTS 💅

• conn — the XCB connection to X11. your lil hotline to the server, periodt.
• window — a window to check if the pointer is on the same screen as window (peep the same_screen field in the reply, iykyk). 👀

---

👑 REPLY FIELDS 👑

• response_type — the type of this reply, in this case XCB_QUERY_POINTER. this field is also present in the xcb_generic_reply_t and can be used to tell replies apart from each other. it's giving name tag at a party 🎀
• sequence — the sequence number of the last request processed by the X11 server. ⭐
• length — the length of the reply, in words (a word is 4 bytes). lowkey important math.
• same_screen — if same_screen is False, then the pointer is not on the same screen as the argument window, child is None, and win_x and win_y are zero. if same_screen is True, then win_x and win_y are the pointer coordinates relative to the argument window's origin, and child is the child containing the pointer, if any. this field is carrying the whole reply ngl 😭
• root — the root window the pointer is logically on. 🌈
• child — the child window containing the pointer, if any, if same_screen is true. if same_screen is false, XCB_NONE is returned. 🧚
• root_x — the pointer X position, relative to root. 📍
• root_y — the pointer Y position, relative to root. 📍
• win_x — the pointer X coordinate, relative to child, if same_screen is true. zero otherwise. ✨
• win_y — the pointer Y coordinate, relative to child, if same_screen is true. zero otherwise. ✨
• mask — the current logical state of the modifier keys and the buttons. note that the logical state of a device (as seen by means of the protocol) may lag the physical state if device event processing is frozen. so like, don't trust it to be frame-perfect, bestie 💀

---

🦋 DESCRIPTION 🦋

gets the root window the pointer is logically on and the pointer coordinates relative to the root window's origin. that's it, that's the whole vibe check 🫶

---

🔥 RETURN VALUE 🔥

returns an xcb_query_pointer_cookie_t. errors have to be handled when calling the reply function xcb_query_pointer_reply.

if you want to handle errors in the event loop instead, use xcb_query_pointer_unchecked. see xcb-requests(3) for details. choose your fighter 💅

---

💀 ERRORS 💀

• xcb_window_error_t — the specified window does not exist. ghost window fr fr 👻

---

🌟 SEE ALSO 🌟

• xcb-requests(3)

---

💜 AUTHOR 💜

generated from xproto.xml. contact xcb@lists.freedesktop.org for corrections and improvements. they're literally so responsive, go say hi 🫶

---

ok that's the whole page bestie, go forth and find that cursor ✨🖱️

mwah 💋 this was X Version 11, libxcb 1.17.0, and xcb_query_pointer(3) — stay iconic, queen 👑