xcb_glx_get_tex_image(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_tex_image β€” from the xcb_glx_get_tex_image(3) fam (XCB Requests energy) ✨

okay bestie, sit down, hydrate, and let's talk about the little GLX request that yoinks a texture image out of the X server's GLX brain. it's giving "I asked the server for pixels and the server said bet". πŸŽ€


🌸 NAME 🌸

xcb_glx_get_tex_image β€” and honestly? the manpage leaves the description blank, so I'm not gonna invent one for you. no cap, that's literally what it says. πŸ’…


✨ SYNOPSIS ✨

first, the vibe: pull in the header.

#include <xcb/glx.h>

πŸ¦‹ Request function

xcb_glx_get_tex_image_cookie_t
       xcb_glx_get_tex_image(xcb_connection_t *conn,
       xcb_glx_context_tag_t context_tag, uint32_t target,
       int32_t level, uint32_t format, uint32_t type,
       uint8_t swap_bytes);

πŸ¦‹ Reply datastructure

typedef struct xcb_glx_get_tex_image_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    uint8_t  pad1[8];
    int32_t  width;
    int32_t  height;
    int32_t  depth;
    uint8_t  pad2[4];
} xcb_glx_get_tex_image_reply_t;

πŸ¦‹ Reply function

xcb_glx_get_tex_image_reply_t
       *xcb_glx_get_tex_image_reply(xcb_connection_t *conn,
       xcb_glx_get_tex_image_cookie_t cookie, xcb_generic_error_t **e);

πŸ¦‹ Reply accessors

these three are your little extraction squad πŸ”₯

uint8_t *xcb_glx_get_tex_image_data(const
       xcb_glx_get_tex_image_request_t *reply);
int xcb_glx_get_tex_image_data_length(const
       xcb_glx_get_tex_image_reply_t *reply);
xcb_generic_iterator_t xcb_glx_get_tex_image_data_end(const
       xcb_glx_get_tex_image_reply_t *reply);

πŸ‘‘ REQUEST ARGUMENTS πŸ‘‘

  • conn β€” your XCB connection to X11. the group chat with the server, basically. πŸ“ž
  • context_tag β€” TODO: NOT YET DOCUMENTED. yeah. they left it blank. iconic of them honestly πŸ™ˆ
  • target β€” TODO: NOT YET DOCUMENTED. also blank bestie, I don't make the rules 🫢
  • level β€” TODO: NOT YET DOCUMENTED. blank blank blank ✨
  • format β€” TODO: NOT YET DOCUMENTED. yeah. same. πŸ’€
  • type β€” TODO: NOT YET DOCUMENTED. nothing. nada. πŸ“
  • swap_bytes β€” TODO: NOT YET DOCUMENTED. the mystery stays mysterious πŸ’œ
lowkey the whole argument list is a group chat where everyone left you on read. but the flags are real and you pass them all, so pass them all.

πŸ’… REPLY FIELDS πŸ’…

  • response_type β€” the type of this reply, and in this case it's XCB_GLX_GET_TEX_IMAGE. 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 the name tag at the party πŸŽ€
  • sequence β€” the sequence number of the last request processed by the X11 server. tracking numbers but make it slay ✨
  • length β€” the length of the reply, in words (and a word is 4 bytes, so do the math, bestie). πŸ“
  • width β€” TODO: NOT YET DOCUMENTED. 🌸
  • height β€” TODO: NOT YET DOCUMENTED. 🌈
  • depth β€” TODO: NOT YET DOCUMENTED. ⭐

🌟 DESCRIPTION 🌟

there is literally nothing here in the original. the DESCRIPTION section is empty. no text. a void. a blank canvas. honestly? main character energy of the manpage to just. not. 😭

so instead of making stuff up (which I will NOT do, that's not the vibe), I'm just telling you: this section is empty in the source, and I'm keeping it empty for you. periodt. πŸ’–


🫢 RETURN VALUE 🫢

Returns an xcb_glx_get_tex_image_cookie_t. πŸͺ

Errors have to be handled when you call the reply function, xcb_glx_get_tex_image_reply.

If you'd rather handle errors in the event loop instead, use xcb_glx_get_tex_image_unchecked. See xcb-requests(3) for details. ✨


πŸ’€ ERRORS πŸ’€

This request does never generate any errors.

not one. zero. the drama-free request. obsessed. πŸ‘‘


🌈 SEE ALSO 🌈

nothing here either bestie β€” the SEE ALSO section is empty in the original. no references, no friends, just vibes. πŸ¦‹


🧚 AUTHOR 🧚

Generated from glx.xml. Contact xcb@lists.freedesktop.org for corrections and improvements. πŸ’Œ


okay that's the whole page, you ate it up. this one came from libxcb 1.17.0, living under the X Version 11 umbrella, and it's filed under xcb_glx_get_tex_image(3). go forth and request responsibly, bestie πŸ’–βœ¨πŸŽ€πŸ¦‹