xcb_input_get...e_key_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_input_get...e_key_mapping β€” XCB Requests, bestie

okay so bestie, welcome to the manual page for xcb_input_get...e_key_mapping(3) β€” that's the XCB Requests one, in case you were wondering which manual you just opened. it's giving "libxcb's xinput corner" and honestly? we're obsessed. this is where you go when you need to ask the X server "hey queen, what keysyms live on this device's keycodes?" πŸŽ€


🌸 NAME 🌸

xcb_input_get_device_key_mapping β€” (no description in the original, it just is, iconic behaviour, no notes πŸ’…)


✨ SYNOPSIS ✨

#include <xcb/xinput.h>

πŸ¦‹ Request function πŸ¦‹

xcb_input_get_device_key_mapping_cookie_t
       xcb_input_get_device_key_mapping(xcb_connection_t *conn,
       uint8_t device_id, xcb_input_key_code_t first_keycode,
       uint8_t count);

πŸ¦‹ Reply datastructure πŸ¦‹

typedef struct xcb_input_get_device_key_mapping_reply_t {
    uint8_t  response_type;
    uint8_t  xi_reply_type;
    uint16_t sequence;
    uint32_t length;
    uint8_t  keysyms_per_keycode;
    uint8_t  pad0[23];
} xcb_input_get_device_key_mapping_reply_t;

πŸ¦‹ Reply function πŸ¦‹

xcb_input_get_device_key_mapping_reply_t
       *xcb_input_get_device_key_mapping_reply(xcb_connection_t *conn,
       xcb_input_get_device_key_mapping_cookie_t cookie,
       xcb_generic_error_t **e);

πŸ¦‹ Reply accessors πŸ¦‹

xcb_keysym_t *xcb_input_get_device_key_mapping_keysyms(const
       xcb_input_get_device_key_mapping_request_t *reply);

int xcb_input_get_device_key_mapping_keysyms_length(const
       xcb_input_get_device_key_mapping_reply_t *reply);

xcb_generic_iterator_t
       xcb_input_get_device_key_mapping_keysyms_end(const
       xcb_input_get_device_key_mapping_reply_t *reply);

πŸ”₯ REQUEST ARGUMENTS πŸ”₯

  • conn β€” the XCB connection to X11. your lil hotline to the server, periodt πŸ’–
  • device_id β€” TODO: NOT YET DOCUMENTED. (the docs said "figure it out" and honestly, same 😭)
  • first_keycode β€” TODO: NOT YET DOCUMENTED. (mystery behaviour, we love a secretive king πŸ™ˆ)
  • count β€” TODO: NOT YET DOCUMENTED. (again, no notes, the docs are gatekeeping πŸ’€)

πŸ‘‘ REPLY FIELDS πŸ‘‘

  • response_type β€” the type of this reply, and in this case it's XCB_INPUT_GET_DEVICE_KEY_MAPPING. this field is also present in the xcb_generic_reply_t and can be used to tell replies apart from each other. it's basically the reply's little name tag at the function, so you know who's who 🫢
  • sequence β€” the sequence number of the last request processed by the X11 server. the timeline, fr fr ⭐
  • length β€” the length of the reply, in words (a word is 4 bytes). math girlies rise 🧚
  • xi_reply_type β€” TODO: NOT YET DOCUMENTED. (undocumented and unbothered πŸ’œ)
  • keysyms_per_keycode β€” TODO: NOT YET DOCUMENTED. (the mystery continues, lowkey iconic 🌈)

πŸ’– DESCRIPTION πŸ’–

(that's it. that's the description. the original literally left this blank β€” main character energy, saying nothing and letting the vibes speak πŸŽ€)


🌟 RETURN VALUE 🌟

Returns an xcb_input_get_device_key_mapping_cookie_t. Errors have to be handled when calling the reply function xcb_input_get_device_key_mapping_reply.

heads up bestie β€” if you want to handle errors in the event loop instead, use xcb_input_get_device_key_mapping_unchecked. see xcb-requests(3) for details. ✨

πŸ’€ ERRORS πŸ’€

This request does never generate any errors. not one. zero. the drama-free queen we all aspire to be πŸ’…


πŸŽ€ SEE ALSO πŸŽ€

(empty in the original β€” it's giving "no thoughts, head empty," and we respect it πŸ¦‹)


🌸 AUTHOR 🌸

Generated from xinput.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, libxcb 1.17.0, and it's filed under xcb_input_get...e_key_mapping(3). go forth and slay your key mappings, mwah 😘✨