xcb_get_pointer_mapping(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_get_pointer_mapping 💖

okay bestie, so this is a page from XCB Requests — it's xcb_get_pointer_mapping(3), and we're about to get into it. grab a boba, this one's short and sweet fr fr 🧋✨

🌸 NAME 🌸

xcb_get_pointer_mapping -

no cap, the NAME section in the original is literally just the function name followed by a dash and then... nothing. empty. a void. she said "mystery" and left 💀 we respect it tho

✨ SYNOPSIS ✨

First things first, you gotta pull in the header:

#include <xcb/xproto.h>

🎀 Request function

xcb_get_pointer_mapping_cookie_t
       xcb_get_pointer_mapping(xcb_connection_t *conn,

🦋 Reply datastructure

typedef struct xcb_get_pointer_mapping_reply_t {
    uint8_t  response_type;
    uint8_t  map_len;
    uint16_t sequence;
    uint32_t length;
    uint8_t  pad0[24];
} xcb_get_pointer_mapping_reply_t;

💜 Reply function

xcb_get_pointer_mapping_reply_t
       *xcb_get_pointer_mapping_reply(xcb_connection_t *conn,
       xcb_get_pointer_mapping_cookie_t cookie,
       xcb_generic_error_t **e);

🌈 Reply accessors

uint8_t *xcb_get_pointer_mapping_map(const
       xcb_get_pointer_mapping_request_t *reply);
int xcb_get_pointer_mapping_map_length(const
       xcb_get_pointer_mapping_reply_t *reply);
xcb_generic_iterator_t xcb_get_pointer_mapping_map_end(const
       xcb_get_pointer_mapping_reply_t *reply);

🫶 REQUEST ARGUMENTS 🫶

  • conn — your XCB connection to X11. that's the whole list bestie, she's low maintenance 💅

⭐ REPLY FIELDS ⭐

  • response_type — the type of this reply, and in this specific case it's XCB_GET_POINTER_MAPPING. plot twist: this field also lives in the xcb_generic_reply_t, so you can use it to tell your replies apart from each other. it's giving name tag at a party 🎀
  • sequence — the sequence number of the last request that the X11 server processed. it's the receipts, fr fr 🧾
  • length — the length of the reply, measured in words. and before you ask, a word is 4 bytes. math is math 💀
  • map_len — TODO: NOT YET DOCUMENTED. yeah... she's a mystery even to the docs. iconic behaviour, honestly 🙈

💫 DESCRIPTION 💫

so the DESCRIPTION section of the original is empty. nothing. zero words. the girls that get it get it, the girls that don't... also don't, because there's literally nothing here 😭 moving on!

🔥 RETURN VALUE 🔥

You get back an xcb_get_pointer_mapping_cookie_t. a cookie!! 🍪

Any errors? Those have to be handled when you call the reply function, xcb_get_pointer_mapping_reply.

But if you'd rather handle your errors inside the event loop instead, use xcb_get_pointer_mapping_unchecked. and if you wanna know the deets on that whole pattern, go read xcb-requests(3). iykyk 💜

💀 ERRORS 💀

This request does never generate any errors. not one. flawless. unbothered. zero drama, she's not like the other requests 👑

👑 SEE ALSO 👑

...and the SEE ALSO section is empty in the original too. bestie really said "no further reading" and dipped 🌸

🍓 AUTHOR 🍓

Generated from xproto.xml. if you wanna send corrections and improvements, hit up xcb@lists.freedesktop.org — they're taking notes, fr fr 🫶

that's the whole page, no cap. X Version 11, libxcb 1.17.0, and it's a xcb_get_pointer_mapping(3) situation — thanks for coming to my ted talk, love u, bye!! 💖✨🎀🦋🌸💅🫶😭🔥👑🌈⭐💀🙈🍓🧚💜

📦 where this page comes from