xcb_input_xi_...e_grab_device(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

πŸ’… NAME πŸ’…

xcb_input_xi_passive_grab_device β€” bestie this one is just a name, there's literally no description here, not a single crumb 😭

(also hi, this is a page from the XCB Requests corner of the libxcb universe, iykyk πŸ¦‹)


✨ SYNOPSIS ✨

First things first, you gotta invite the header in:

#include <xcb/xinput.h>

πŸŽ€ Request function

xcb_input_xi_passive_grab_device_cookie_t
       xcb_input_xi_passive_grab_device(xcb_connection_t *conn,
       xcb_timestamp_t time, xcb_window_t grab_window,
       xcb_cursor_t cursor, uint32_t detail,
       xcb_input_device_id_t deviceid, uint16_t num_modifiers,
       uint16_t mask_len, uint8_t grab_type, uint8_t grab_mode,
       uint8_t paired_device_mode, uint8_t owner_events, const
       uint32_t *mask, const uint32_t *modifiers);

πŸ¦‹ Reply datastructure

typedef struct xcb_input_xi_passive_grab_device_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    uint16_t num_modifiers;
    uint8_t  pad1[22];
} xcb_input_xi_passive_grab_device_reply_t;

🌸 Reply function

xcb_input_xi_passive_grab_device_reply_t
       *xcb_input_xi_passive_grab_device_reply(xcb_connection_t *conn,
       xcb_input_xi_passive_grab_device_cookie_t cookie,
       xcb_generic_error_t **e);

⭐ Reply accessors

xcb_input_grab_modifier_info_t
       *xcb_input_xi_passive_grab_device_modifiers(const
       xcb_input_xi_passive_grab_device_request_t *reply);

int xcb_input_xi_passive_grab_device_modifiers_length(const
       xcb_input_xi_passive_grab_device_reply_t *reply);

xcb_input_grab_modifier_info_iterator_t
       xcb_input_xi_passive_grab_device_modifiers_iterator(const
       xcb_input_xi_passive_grab_device_reply_t *reply);

πŸ’– REQUEST ARGUMENTS πŸ’–

okay so these are the things you hand over to the request, and ngl most of them are giving "we'll get to it later" energy:

  • conn β€” the XCB connection to X11. your lil hotline to the server, periodt.
  • time β€” TODO: NOT YET DOCUMENTED. (not me, bestie, the docs said that)
  • grab_window β€” TODO: NOT YET DOCUMENTED.
  • cursor β€” TODO: NOT YET DOCUMENTED.
  • detail β€” TODO: NOT YET DOCUMENTED.
  • deviceid β€” TODO: NOT YET DOCUMENTED.
  • num_modifiers β€” TODO: NOT YET DOCUMENTED.
  • mask_len β€” TODO: NOT YET DOCUMENTED.
  • grab_type β€” TODO: NOT YET DOCUMENTED.
  • grab_mode β€” TODO: NOT YET DOCUMENTED.
  • paired_device_mode β€” TODO: NOT YET DOCUMENTED.
  • owner_events β€” TODO: NOT YET DOCUMENTED.
  • mask β€” TODO: NOT YET DOCUMENTED.
  • modifiers β€” TODO: NOT YET DOCUMENTED.
bestie the whole argument list is TODO, this is the manpage equivalent of a group chat where everyone left you on read πŸ™ˆ

🌈 REPLY FIELDS 🌈

what the server sends back to you, and it's a whole vibe check:

  • response_type β€” the type of this reply, in this case XCB_INPUT_XI_PASSIVE_GRAB_DEVICE. this field is also present in the xcb_generic_reply_t and can be used to tell replies apart from each other. it's the little name tag at the 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). math girlies stay winning.
  • num_modifiers β€” TODO: NOT YET DOCUMENTED.

🫢 DESCRIPTION 🫢

literally nothing here. the original page has the heading and then… silence. iconic of it, honestly. the void said no thoughts head empty ✨


πŸ”₯ RETURN VALUE πŸ”₯

Returns an xcb_input_xi_passive_grab_device_cookie_t. Errors have to be handled when calling the reply function xcb_input_xi_passive_grab_device_reply.

If you want to handle errors in the event loop instead, use xcb_input_xi_passive_grab_device_unchecked. See xcb-requests(3) for details.

cookie first, consequences later. that's the XCB way, no cap πŸ“

πŸ’€ ERRORS πŸ’€

This request does never generate any errors.

zero errors, zero drama, she's unbothered and thriving πŸ‘‘

πŸ‘€ SEE ALSO πŸ‘€

nothing listed here in the original either. the see-also section is giving empty plate at the function 😭


🧚 AUTHOR 🧚

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


and that's the whole page, bestie!! πŸ’– this was brought to you by X Version 11 and libxcb 1.17.0, mwah, go forth and grab passively πŸŽ€βœ¨