XCB_GLX_GET_HISTOGRAM_PARAMETERIV_DATA(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_glx_get_histogram_parameteriv β€” okay so this is a request function from the XCB GLX family, and the original page literally just leaves the description hanging after the dash, so that's the vibe we're keeping, bestie. It's the GLX "get histogram parameteriv" request, and it lives in the xcb/glx.h cinematic universe.


✨ SYNOPSIS ✨

First thing, the include. You need this or nothing works, fr fr:

#include <xcb/glx.h>

πŸŽ€ Request function

xcb_glx_get_histogram_parameteriv_cookie_t
       xcb_glx_get_histogram_parameteriv(xcb_connection_t *conn,
       xcb_glx_context_tag_t context_tag, uint32_t target,
       uint32_t pname);

πŸ¦‹ Reply datastructure

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

🌸 Reply function

xcb_glx_get_histogram_parameteriv_reply_t
       *xcb_glx_get_histogram_parameteriv_reply(xcb_connection_t *conn,
       xcb_glx_get_histogram_parameteriv_cookie_t cookie,
       xcb_generic_error_t **e);

πŸ’– Reply accessors

int32_t *xcb_glx_get_histogram_parameteriv_data(const
       xcb_glx_get_histogram_parameteriv_request_t *reply);

int xcb_glx_get_histogram_parameteriv_data_length(const
       xcb_glx_get_histogram_parameteriv_reply_t *reply);

xcb_generic_iterator_t xcb_glx_get_histogram_parameteriv_data_end(const
       xcb_glx_get_histogram_parameteriv_reply_t *reply);

πŸ”₯ REQUEST ARGUMENTS πŸ”₯

  • conn β€” bestie this is just your XCB connection to X11. The whole plugging-into-the-server moment. πŸ”Œ
  • context_tag β€” the docs say TODO: NOT YET DOCUMENTED. So like... nobody wrote it down. It's giving mystery. πŸ™ˆ
  • target β€” also TODO: NOT YET DOCUMENTED. Same energy, same silence. πŸ’€
  • pname β€” you guessed it: TODO: NOT YET DOCUMENTED. Three for three, iconic of the docs honestly.

πŸ‘‘ REPLY FIELDS πŸ‘‘

  • response_type β€” this tells you what kind of reply you got back, and in this case it's XCB_GLX_GET_HISTOGRAM_PARAMETERIV. Lowkey the same field lives in xcb_generic_reply_t too, so you can use it to tell your replies apart from each other when they're all piling up in the queue. 🌈
  • sequence β€” the sequence number of the last request the X11 server actually processed. It's the little receipt number of your request. 🧾
  • length β€” how long the reply is, measured in words. And reminder bestie: a word here is 4 bytes, not vibes. ✨
  • n β€” TODO: NOT YET DOCUMENTED. We know nothing. It's fine. 🫢
  • datum β€” TODO: NOT YET DOCUMENTED. Also a mystery. Slay I guess. πŸ’…

πŸ’œ DESCRIPTION πŸ’œ

Okay so the DESCRIPTION section on the original page is... literally empty. Nothing. A void. The silence is deafening, no cap. So we're all just out here knowing the function name and the fields and nothing else. πŸ•³οΈ


πŸŽ€ RETURN VALUE πŸŽ€

You get back an xcb_glx_get_histogram_parameteriv_cookie_t. A whole cookie. πŸͺ

And here's the important part: any errors have to be handled when you call the reply function, xcb_glx_get_histogram_parameteriv_reply.

If you'd rather handle errors in the event loop instead, then use xcb_glx_get_histogram_parameteriv_unchecked. Head over to xcb-requests(3) for the deets on how that works, iykyk. πŸ’«


🚨 ERRORS 🚨

This request does never generate any errors. Periodt. Zero drama, zero error codes, it simply does not do that. πŸ’…

🌟 SEE ALSO 🌟

Okay so this section on the original page is just an empty heading β€” no cross-references listed at all. So there's nothing to point you toward here. Ngl it's a little lonely in this section. πŸ¦‹


⭐ AUTHOR ⭐

Generated from glx.xml. If you wanna send corrections or improvements, hit up xcb@lists.freedesktop.org. They're the ones who actually know things. πŸ“¬


And that's a wrap on the xcb_glx_get_histogram_parameteriv(3) page, bestie! 🫢 It comes to you courtesy of X Version 11, from libxcb 1.17.0. Go forth and get those histogram parameters, mwah. πŸ’–βœ¨πŸŽ€