xcb_glx_get_pixel_mapfv(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_glx_get_pixel_mapfv πŸ’–

okay so bestie, welcome to the xcb_glx_get_pixel_mapfv(3) page β€” it's part of the XCB Requests fam, and it's giving "niche but essential" energy ngl. buckle up πŸŽ€


✨ NAME ✨

xcb_glx_get_pixel_mapfv β€” and that's literally it, that's the whole name section, the original page leaves it at that, no cap 😭


🌸 SYNOPSIS 🌸

first up, the include, iconic as always:

#include <xcb/glx.h>

πŸ¦‹ Request function

xcb_glx_get_pixel_mapfv_cookie_t
xcb_glx_get_pixel_mapfv(xcb_connection_t *conn,
                        xcb_glx_context_tag_t context_tag,
                        uint32_t map);

πŸ¦‹ Reply datastructure

typedef struct xcb_glx_get_pixel_mapfv_reply_t {
    uint8_t           response_type;
    uint8_t           pad0;
    uint16_t          sequence;
    uint32_t          length;
    uint8_t           pad1[4];
    uint32_t          n;
    xcb_glx_float32_t datum;
    uint8_t           pad2[12];
} xcb_glx_get_pixel_mapfv_reply_t;

πŸ¦‹ Reply function

xcb_glx_get_pixel_mapfv_reply_t
*xcb_glx_get_pixel_mapfv_reply(xcb_connection_t *conn,
                               xcb_glx_get_pixel_mapfv_cookie_t cookie,
                               xcb_generic_error_t **e);

πŸ¦‹ Reply accessors

xcb_glx_float32_t *xcb_glx_get_pixel_mapfv_data(const
        xcb_glx_get_pixel_mapfv_request_t *reply);

int xcb_glx_get_pixel_mapfv_data_length(const
        xcb_glx_get_pixel_mapfv_reply_t *reply);

xcb_generic_iterator_t xcb_glx_get_pixel_mapfv_data_end(const
        xcb_glx_get_pixel_mapfv_reply_t *reply);
bestie look at that accessor block β€” one of them says xcb_glx_get_pixel_mapfv_request_t and the others say xcb_glx_get_pixel_mapfv_reply_t. that's exactly how it's written in the original, so i'm not touching it, i'm just ✨observing✨ πŸ’€

πŸŽ€ REQUEST ARGUMENTS πŸŽ€

  • conn β€” the XCB connection to X11. your lil hotline to the server, periodt.
  • context_tag β€” TODO: NOT YET DOCUMENTED. yeah. the docs said "idk her" πŸ™ˆ
  • map β€” TODO: NOT YET DOCUMENTED. also mysterious. also "idk her" 🫢

πŸ’… REPLY FIELDS πŸ’…

  • response_type β€” the type of this reply, which in this case is XCB_GLX_GET_PIXEL_MAPFV. this field also lives in the xcb_generic_reply_t, so you can use it to tell your replies apart from each other. it's like a name tag at a party but for structs πŸŽ‰
  • sequence β€” the sequence number of the last request processed by the X11 server. lowkey the receipt number of the X11 world 🧾
  • length β€” the length of the reply, in words. and a word is 4 bytes, so do the math bestie πŸ“
  • n β€” TODO: NOT YET DOCUMENTED. yeah again 😭
  • datum β€” TODO: NOT YET DOCUMENTED. the mystery continues πŸ’€

🌈 DESCRIPTION 🌈

so, um. there is a DESCRIPTION section on this page. and it is completely empty. the original has the heading and then absolutely nothing under it. she said "no thoughts, head empty" πŸ’– i'm keeping it exactly that way because the facts stay the facts.


⭐ RETURN VALUE ⭐

it hands you back an xcb_glx_get_pixel_mapfv_cookie_t πŸͺ β€” like a lil voucher you redeem later.

errors? you don't deal with those here. you handle them when you call the reply function xcb_glx_get_pixel_mapfv_reply.

but if you'd rather handle errors in the event loop instead, use xcb_glx_get_pixel_mapfv_unchecked. and for the full deets on that whole vibe, go read xcb-requests(3). iykyk πŸ¦‹


πŸ”₯ ERRORS πŸ”₯

this request does never generate any errors. not a single one. she's unproblematic, she's drama-free, she's the main character who never starts anything πŸ‘‘


🌸 SEE ALSO 🌸

nothing here bestie β€” the original SEE ALSO section is empty, so i'm leaving it empty too. the vibes are immaculate, the links are nonexistent πŸŽ€


πŸ’œ AUTHOR πŸ’œ

generated from glx.xml. got corrections or improvements? contact xcb@lists.freedesktop.org β€” they're the ones who actually wrote this, i'm just the messenger with better emoji usage πŸ’…


and that's the whole page, bestie!! 🫢 this came to you from X Version 11, libxcb 1.17.0, on the xcb_glx_get_pixel_mapfv(3) page β€” mwah, go forth and map those pixels βœ¨πŸ’–