xcb_randr_get_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

✨ NAME ✨

xcb_randr_get_panning β€” okay so bestie, the official name line here is literally just the function name and then a lil dash with absolutely nothing after it πŸ’€. No description. Nothing. The manpage said "that's it, that's the name." So like… we go in blind and we learn together, fr fr.

This is a page from libxcb, manual name xcb_randr_get_panning, section 3. Now let's get into it 🫢


🌸 SYNOPSIS 🌸

First thing, you gotta pull in the header:

#include <xcb/randr.h>

πŸ’… Request function

xcb_randr_get_panning_cookie_t
       xcb_randr_get_panning(xcb_connection_t *conn,
       xcb_randr_crtc_t crtc);

πŸŽ€ Reply datastructure

Not me being obsessed with this struct, it's giving very structured, very organized:

typedef struct xcb_randr_get_panning_reply_t {
    uint8_t         response_type;
    uint8_t         status;
    uint16_t        sequence;
    uint32_t        length;
    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;
} xcb_randr_get_panning_reply_t;

πŸ¦‹ Reply function

xcb_randr_get_panning_reply_t
       *xcb_randr_get_panning_reply(xcb_connection_t *conn,
       xcb_randr_get_panning_cookie_t cookie, xcb_generic_error_t **e);

⭐ REQUEST ARGUMENTS ⭐

  • conn β€” the XCB connection to X11. Your lil hotline to the server, no cap.
  • crtc β€” TODO: NOT YET DOCUMENTED. Yeah bestie, the docs literally said "we'll finish this later" and never came back 😭. It's an xcb_randr_crtc_t, that's what we know, and we move on.

πŸ‘‘ REPLY FIELDS πŸ‘‘

  • response_type β€” the type of this reply. In this case it's XCB_RANDR_GET_PANNING. This field is also present in the xcb_generic_reply_t, so you can use it to tell replies apart from each other. It's the 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. And reminder: a word is 4 bytes. Words are 4 bytes here, not vibes.
  • status β€” TODO: NOT YET DOCUMENTED. πŸ™ˆ
  • 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 the whole field list being a TODO πŸ’€. It's giving "work in progress" main character energy. But like β€” that's genuinely what the page says, so that's what we're reporting. No inventing, no guessing, periodt.

🌈 DESCRIPTION 🌈

So… the DESCRIPTION section? Completely empty. Not one word. A true minimalist queen, she said nothing and left πŸ’…βœ¨


πŸ“ RETURN VALUE πŸ“

Returns an xcb_randr_get_panning_cookie_t. Yes, a cookie πŸͺ β€” it's your lil claim ticket for the reply.

Errors have to be handled when calling the reply function xcb_randr_get_panning_reply.

If you'd rather handle errors in the event loop instead, use xcb_randr_get_panning_unchecked. See xcb-requests(3) for details β€” that's your homework, bestie, go read it 🫢


πŸ’œ ERRORS πŸ’œ

This request does never generate any errors. Not one. Zero. Flawless, unbothered, no drama. Iconic behavior, honestly πŸ‘‘


🧚 SEE ALSO 🧚

Yeah so… this section is empty too. Nothing listed. The page simply had no friends to introduce you to at the party 😭


🌟 AUTHOR 🌟

Generated from randr.xml. Contact xcb@lists.freedesktop.org for corrections and improvements β€” so if you spot something off, that's the address, slide into those inboxes politely πŸ’Œ


And that's the whole page! Some parts were empty, some were TODO, and we kept all of it exactly as it was β€” nothing added, nothing skipped, no cap.

Signing off with the receipts: this was X Version 11, libxcb 1.17.0, the page xcb_randr_get_panning(3). Stay hydrated, read your manpages, and slay πŸ’–βœ¨πŸŽ€πŸ¦‹πŸŒΈπŸ’