xcb_set_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_set_pointer_mapping(3) πŸ’–

okay so bestie, welcome to the manual page for xcb_set_pointer_mapping β€” it's a lil XCB request function living in section 3 of the manual, and we're gonna get you all the way together on it. no gatekeeping here, we're learning this together fr fr 🫢


🌸 NAME 🌸

xcb_set_pointer_mapping -

and yeah the description is literally just blank after the dash 😭 the original page has nothing there, so I'm not gonna make something up. it's giving mysterious. it's giving "we'll find out together." moving on! πŸ’…


✨ SYNOPSIS ✨

first things first, the include:

#include <xcb/xproto.h>

πŸŽ€ Request function

xcb_set_pointer_mapping_cookie_t
       xcb_set_pointer_mapping(xcb_connection_t *conn, uint8_t map_len,
       const uint8_t *map);

πŸŽ€ Reply datastructure

typedef struct xcb_set_pointer_mapping_reply_t {
    uint8_t  response_type;
    uint8_t  status;
    uint16_t sequence;
    uint32_t length;
} xcb_set_pointer_mapping_reply_t;

πŸŽ€ Reply function

xcb_set_pointer_mapping_reply_t
       *xcb_set_pointer_mapping_reply(xcb_connection_t *conn,
       xcb_set_pointer_mapping_cookie_t cookie,
       xcb_generic_error_t **e);

πŸ¦‹ REQUEST ARGUMENTS πŸ¦‹

  • conn β€” the XCB connection to X11. your lil lifeline to the server, the main character of every single one of these pages, no cap.
  • map_len β€” TODO: NOT YET DOCUMENTED. bestie the docs literally say that. I'm not gonna gaslight you with a made-up answer πŸ™ˆ
  • map β€” TODO: NOT YET DOCUMENTED. yeah. same energy. the original really said "figure it out" and honestly? iconic of it.

πŸ”₯ REPLY FIELDS πŸ”₯

  • response_type β€” the type of this reply, which in this case is XCB_SET_POINTER_MAPPING. this field is ALSO hanging out in the xcb_generic_reply_t, so you can use it to tell your replies apart from each other. very "how do you do, fellow replies" of it πŸ’€
  • sequence β€” the sequence number of the last request processed by the X11 server. it's the receipts, basically.
  • length β€” the length of the reply, measured in words. and reminder bestie: a word here is 4 bytes. don't get caught slipping on that.
  • status β€” one of these values right here:
    • XCB_MAPPING_STATUS_SUCCESS β€” TODO: NOT YET DOCUMENTED.
    • XCB_MAPPING_STATUS_BUSY β€” TODO: NOT YET DOCUMENTED.
    • XCB_MAPPING_STATUS_FAILURE β€” TODO: NOT YET DOCUMENTED.
    • TODO: NOT YET DOCUMENTED. β€” yes there's a fourth stray TODO just vibing there with no label. the original really said "and one more for the road" 😭 I'm keeping it exactly as it is, periodt.

🌈 DESCRIPTION 🌈

so the DESCRIPTION section is empty. like, completely. not a single word. the original page just... moves on. and I respect the commitment to minimalism but I also cannot invent lore that isn't there, so here we are: an empty description, beautifully preserved. it's giving "the silence is the message." 🧚


⭐ RETURN VALUE ⭐

Returns an xcb_set_pointer_mapping_cookie_t. πŸͺ

Errors have to be handled when you call the reply function, xcb_set_pointer_mapping_reply.

If you'd rather handle errors in the event loop instead, use xcb_set_pointer_mapping_unchecked. See xcb-requests(3) for details β€” that page is your bestie for the whole checked/unchecked situation, iykyk.


πŸ’€ ERRORS πŸ’€

This request does never generate any errors.

literally never. zero. none. no errors, no drama, no mess. the calmest function in the whole library and we love that for it 🫢

πŸ‘‘ SEE ALSO πŸ‘‘

empty. nothing here. not a single cross-reference. the original just left the heading and dipped πŸ’…


🌟 AUTHOR 🌟

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


and that's the whole page, bestie!! you ate that πŸŽ€

one last thing before you go β€” this page ships as part of X Version 11, libxcb 1.17.0, and it's the xcb_set_pointer_mapping(3) page you've been reading this whole time. so that's the source, the version, and the date-ish situation all wrapped up with a bow for you. go forth and map those pointers, queen πŸ‘‘βœ¨πŸ¦‹