XCB_GLX_GET_CONVOLUTION_PARAMETERIV_DATA_LENGTH(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_convolution_parameteriv πŸ’–

okay bestie, so this is a page from the XCB Requests manual (yes, the xcb_glx_get_c...on_parameteriv(3) one, the name is literally so long it gets truncated with an ellipsis, iconic behavior honestly). She's a GLX request, she's got a cookie, she's got a reply struct, and she's coming to spill all the deets. let's get into it πŸŽ€


✨ NAME ✨

xcb_glx_get_convolution_parameteriv β€” and that's it, that's the whole name section. the original left it blank, so we're leaving it blank. no cap, there's literally no description line here. πŸ’€


🌸 SYNOPSIS 🌸

first up, the include, always the include:

#include <xcb/glx.h>

πŸ¦‹ Request function

xcb_glx_get_convolution_parameteriv_cookie_t
xcb_glx_get_convolution_parameteriv(xcb_connection_t *conn,
        xcb_glx_context_tag_t context_tag, uint32_t target,
        uint32_t pname);

she hands you back a cookie, not the actual answer. the answer comes later. patience, babe. ✨

πŸŽ€ Reply datastructure

typedef struct xcb_glx_get_convolution_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_convolution_parameteriv_reply_t;

look at all those pad fields. they're just vibing. don't touch them, they're doing their job. πŸ™ˆ

🌈 Reply function

xcb_glx_get_convolution_parameteriv_reply_t
*xcb_glx_get_convolution_parameteriv_reply(xcb_connection_t *conn,
        xcb_glx_get_convolution_parameteriv_cookie_t cookie,
        xcb_generic_error_t **e);

this is where you cash in the cookie and actually get your reply. πŸͺ

πŸ‘‘ Reply accessors

int32_t *xcb_glx_get_convolution_parameteriv_data(const
        xcb_glx_get_convolution_parameteriv_request_t *reply);
int xcb_glx_get_convolution_parameteriv_data_length(const
        xcb_glx_get_convolution_parameteriv_reply_t *reply);
xcb_generic_iterator_t
        xcb_glx_get_convolution_parameteriv_data_end(const
        xcb_glx_get_convolution_parameteriv_reply_t *reply);

yes bestie, those signatures are exactly as the original wrote them β€” including the one that takes a ..._request_t in ..._data(). we do not fix. we do not rename. we report. 🫢


πŸ’… REQUEST ARGUMENTS πŸ’…

  • conn β€” your XCB connection to X11. the whole portal to the server, ngl.
  • context_tag β€” TODO: NOT YET DOCUMENTED. yeah. the docs said "not yet documented" and honestly same, girl. 😭
  • target β€” TODO: NOT YET DOCUMENTED. also a mystery. a little enigmatic, a little main character. ✨
  • pname β€” TODO: NOT YET DOCUMENTED. the third mystery parameter. the trio of unknowns. πŸ’€

⭐ REPLY FIELDS ⭐

  • response_type β€” the type of this reply. in this case it's XCB_GLX_GET_CONVOLUTION_PARAMETERIV. this field is also chillin' in the xcb_generic_reply_t, so you can use it to tell replies apart from each other when you're sifting through your inbox of server responses. πŸ¦‹
  • sequence β€” the sequence number of the last request processed by the X11 server. basically a little "I've gotten this far" receipt. 🧾
  • length β€” the length of the reply, in words. and before you ask: a word is 4 bytes. periodt.
  • n β€” TODO: NOT YET DOCUMENTED. πŸ™ˆ
  • datum β€” TODO: NOT YET DOCUMENTED. πŸ™ˆ

πŸ’œ DESCRIPTION πŸ’œ

so… there is no description. the section exists, and it is empty. that's the whole tea. nothing here. not a single sentence. the section is giving minimalism, and honestly? respect. πŸŽ€


πŸ”₯ RETURN VALUE πŸ”₯

she returns an xcb_glx_get_convolution_parameteriv_cookie_t. that's your little voucher for later.

errors are not handled here, bestie β€” you have to deal with them when you call the reply function, xcb_glx_get_convolution_parameteriv_reply.

but wait, there's a plot twist: if you'd rather handle errors in the event loop instead, use xcb_glx_get_convolution_parameteriv_unchecked. see xcb-requests(3) for the details, iykyk. ✨


πŸ’€ ERRORS πŸ’€

this request does never generate any errors. none. zero. not a single one. she's drama-free, she's unproblematic, she's the moment. 🌸

🌈 SEE ALSO 🌈

  • (the original lists nothing here β€” the section is empty, so we're keeping it empty. sometimes the absence is the statement. πŸ’…)

🫢 AUTHOR 🫢

generated from glx.xml. got corrections or improvements? contact xcb@lists.freedesktop.org and tell them. they want to hear from you, fr fr. πŸ’Œ


and that's the whole page, babe β€” brought to you by X Version 11, libxcb 1.17.0. thanks for reading all the way to the end, you're literally the bestie of all time. slay, and go get that convolution parameter. πŸ’–βœ¨πŸ‘‘