xcb_randr_set_panning(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_randr_set_panning πŸ’–

okay bestie, we're doing an XCB request today β€” it's xcb_randr_set_panning from the <xcb/randr.h> era, part of XCB Requests. this one lives in libxcb and it's giving "pan the screen around like a lil camera viewport" energy. strap in, we're going through literally every single field 🫢


✨ NAME ✨

xcb_randr_set_panning β€” no description given in the original, bestie. that's it. that's the name. iconic minimalism πŸ’…


✨ SYNOPSIS ✨

first up, the include. don't forget her:

#include <xcb/randr.h>

🌸 Request function 🌸

xcb_randr_set_panning_cookie_t
       xcb_randr_set_panning(xcb_connection_t *conn,
       xcb_randr_crtc_t crtc, xcb_timestamp_t timestamp, uint16_t left,
       uint16_t top, uint16_t width, uint16_t height,
       uint16_t track_left, uint16_t track_top, uint16_t track_width,
       uint16_t track_height, int16_t border_left, int16_t border_top,
       int16_t border_right, int16_t border_bottom);

look at that argument list. it's LONG long. she's not like other requests πŸ’œ

🌈 Reply datastructure 🌈

typedef struct xcb_randr_set_panning_reply_t {
    uint8_t         response_type;
    uint8_t         status;
    uint16_t        sequence;
    uint32_t        length;
    xcb_timestamp_t timestamp;
} xcb_randr_set_panning_reply_t;

πŸ¦‹ Reply function πŸ¦‹

xcb_randr_set_panning_reply_t
       *xcb_randr_set_panning_reply(xcb_connection_t *conn,
       xcb_randr_set_panning_cookie_t cookie, xcb_generic_error_t **e);

✨ REQUEST ARGUMENTS ✨

  • conn β€” the XCB connection to X11. your lil red string telephone to the server, fr fr.
  • crtc β€” TODO: NOT YET DOCUMENTED. bestie the docs just did not show up for work today 😭
  • timestamp β€” TODO: NOT YET DOCUMENTED.
  • left β€” TODO: NOT YET DOCUMENTED.
  • top β€” TODO: NOT YET DOCUMENTED.
  • width β€” TODO: NOT YET DOCUMENTED.
  • height β€” TODO: NOT YET DOCUMENTED.
  • track_left β€” TODO: NOT YET DOCUMENTED.
  • track_top β€” TODO: NOT YET DOCUMENTED.
  • track_width β€” TODO: NOT YET DOCUMENTED.
  • track_height β€” TODO: NOT YET DOCUMENTED.
  • border_left β€” TODO: NOT YET DOCUMENTED.
  • border_top β€” TODO: NOT YET DOCUMENTED.
  • border_right β€” TODO: NOT YET DOCUMENTED.
  • border_bottom β€” TODO: NOT YET DOCUMENTED.
not me listing fifteen args and fourteen of them are TODO: NOT YET DOCUMENTED πŸ’€ we stay humble. we stay mysterious. slay.

✨ REPLY FIELDS ✨

  • response_type β€” the type of this reply, in this case XCB_RANDR_SET_PANNING. this field is also present in the xcb_generic_reply_t and can be used to tell replies apart from each other. she's the name tag at the party πŸŽ€
  • sequence β€” the sequence number of the last request processed by the X11 server. your receipt number basically 🧾
  • length β€” the length of the reply, in words (a word is 4 bytes). yes bestie, words. not bytes. four bytes each. keep up πŸ’…
  • status β€” TODO: NOT YET DOCUMENTED.
  • timestamp β€” TODO: NOT YET DOCUMENTED.

✨ DESCRIPTION ✨

there is no description here. the section exists, it's just... empty. a vibe. a moment of silence πŸ•―οΈ


✨ RETURN VALUE ✨

returns an xcb_randr_set_panning_cookie_t. πŸͺ

errors have to be handled when calling the reply function xcb_randr_set_panning_reply.

if you want to handle errors in the event loop instead, use xcb_randr_set_panning_unchecked. see xcb-requests(3) for details. pick your fighter, bestie πŸ‘‘


✨ ERRORS ✨

this request does never generate any errors.

no cap. zero errors. she's a good girl. ✨ (which is also why the whole cookie/reply dance still wants you to pass a pointer for errors β€” the xcb_generic_error_t **e β€” even though this one's out here never generating any. we love a consistent API πŸ™ˆ)


✨ SEE ALSO ✨

nothing listed in the original here β€” it's an empty section, so consider this your little moment of calm before the credits. 🌸


✨ AUTHOR ✨

generated from randr.xml. contact xcb@lists.freedesktop.org for corrections and improvements. go off, xml generator, you did that πŸ’–


okay that's the whole page bestie, every flag, every field, every TODO: NOT YET DOCUMENTED, nothing skipped, we ate and left no crumbs πŸ“

mwah πŸ’‹ this was X Version 11, libxcb 1.17.0, xcb_randr_set_panning(3) β€” signing off, love u, bye πŸ‘‘βœ¨