xcb_xv_grab_port(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_xv_grab_port β€” the XCB Requests one πŸ’–

okay so bestie, we're looking at xcb_xv_grab_port(3) from the XCB Requests family, part of libxcb πŸ’…


πŸŽ€ NAME πŸŽ€

xcb_xv_grab_port β€” that's literally it, the manpage gives us no description and we respect the mystery 🫢


🌸 SYNOPSIS 🌸

#include <xcb/xv.h>

✨ Request function

xcb_xv_grab_port_cookie_t xcb_xv_grab_port(xcb_connection_t *conn,
       xcb_xv_port_t port, xcb_timestamp_t time);

πŸ¦‹ Reply datastructure

typedef struct xcb_xv_grab_port_reply_t {
    uint8_t  response_type;
    uint8_t  result;
    uint16_t sequence;
    uint32_t length;
} xcb_xv_grab_port_reply_t;

πŸ’œ Reply function

xcb_xv_grab_port_reply_t *xcb_xv_grab_port_reply(xcb_connection_t *conn,
       xcb_xv_grab_port_cookie_t cookie, xcb_generic_error_t **e);

πŸ“ REQUEST ARGUMENTS πŸ“

  • conn β€” your XCB connection to X11, the lil lifeline, the main character 🌈
  • port β€” TODO: NOT YET DOCUMENTED. bestie the docs said "we'll do it later" and never came back 😭
  • time β€” also TODO: NOT YET DOCUMENTED. same energy fr fr πŸ’€

πŸ‘‘ REPLY FIELDS πŸ‘‘

  • response_type β€” the type of this reply, which in this case is XCB_XV_GRAB_PORT. this field is also chillin' in the xcb_generic_reply_t, so you can use it to tell your replies apart from each other πŸ’…
  • sequence β€” the sequence number of the last request the X11 server processed, like a lil receipt number ✨
  • length β€” the length of the reply, in words (and a word is 4 bytes, no cap) πŸ“
  • result β€” TODO: NOT YET DOCUMENTED. yeah. yeah. πŸ™ˆ

πŸ’– DESCRIPTION πŸ’–

<nothing. absolutely nothing. the description section is empty and honestly? iconic.</nothing>


⭐ RETURN VALUE ⭐

Returns an xcb_xv_grab_port_cookie_t. and listen, errors have to be handled when you call the reply function xcb_xv_grab_port_reply β€” that's the whole vibe 🫢

If you'd rather handle errors in the event loop instead, use xcb_xv_grab_port_unchecked. See xcb-requests(3) for details 🌸


πŸ”₯ ERRORS πŸ”₯

This request does never generate any errors. zero. none. flawless behavior, we love to see it πŸ‘‘


🌈 SEE ALSO 🌈

(nothing here bestie, the section is empty, go forth unbothered)


πŸ’€ AUTHOR πŸ’€

Generated from xv.xml. Contact xcb@lists.freedesktop.org for corrections and improvements πŸ’Œ


okay so that's the whole thing, you're welcome, mwah πŸŽ€

signing off from X Version 11, libxcb 1.17.0, on the xcb_xv_grab_port(3) page β€” slay, periodt, bye bestie πŸ’…βœ¨