xcb_glx_render_mode(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_render_mode β€” the manual page, bestie edition

okay so this is a page from the XCB Requests corner of the X world β€” it's xcb_glx_render_mode, living in section 3 of the manual. pull up a chair, grab a strawberry πŸ“, and let's get into it.


✨ NAME ✨

xcb_glx_render_mode β€”

(yeah bestie, the original really does just leave it blank like that. iconic mystery behaviour, honestly πŸŽ€)


🌸 SYNOPSIS 🌸

first things first, you gotta bring in the header:

#include <xcb/glx.h>

πŸ¦‹ Request function

xcb_glx_render_mode_cookie_t xcb_glx_render_mode(xcb_connection_t *conn,
       xcb_glx_context_tag_t context_tag, uint32_t mode);

πŸ¦‹ Reply datastructure

typedef struct xcb_glx_render_mode_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    uint32_t ret_val;
    uint32_t n;
    uint32_t new_mode;
    uint8_t  pad1[12];
} xcb_glx_render_mode_reply_t;

πŸ¦‹ Reply function

xcb_glx_render_mode_reply_t
       *xcb_glx_render_mode_reply(xcb_connection_t *conn,
       xcb_glx_render_mode_cookie_t cookie, xcb_generic_error_t **e);

πŸ¦‹ Reply accessors

uint32_t *xcb_glx_render_mode_data(const xcb_glx_render_mode_request_t
       *reply);

int xcb_glx_render_mode_data_length(const xcb_glx_render_mode_reply_t
       *reply);

xcb_generic_iterator_t xcb_glx_render_mode_data_end(const
       xcb_glx_render_mode_reply_t *reply);

🫢 REQUEST ARGUMENTS 🫢

  • conn β€” your XCB connection to X11. the whole reason we're here πŸ’œ
  • context_tag β€” TODO: NOT YET DOCUMENTED. (ngl, the docs left us on read on this one 😭)
  • mode β€” TODO: NOT YET DOCUMENTED. (same bestie, same. no cap, nobody wrote it up πŸ™ˆ)

πŸ‘‘ REPLY FIELDS πŸ‘‘

  • response_type β€” the type of this reply, which in this case is XCB_GLX_RENDER_MODE. this field is also chilling inside xcb_generic_reply_t, and you can use it to tell replies apart from each other. lowkey the little name tag of the reply world 🏷️
  • sequence β€” the sequence number of the last request the X11 server processed.
  • length β€” the length of the reply, measured in words (and a word is 4 bytes, periodt).
  • ret_val β€” TODO: NOT YET DOCUMENTED.
  • n β€” TODO: NOT YET DOCUMENTED.
  • new_mode β€” TODO: NOT YET DOCUMENTED.

🌈 DESCRIPTION 🌈

(that's it. that's the section. it's giving minimalism, it's giving silence, it's giving absolutely nothing 😭✨ the original page ships this section empty, so we're honouring the void.)


⭐ RETURN VALUE ⭐

it hands you back an xcb_glx_render_mode_cookie_t. πŸͺ

errors have to be handled when you call the reply function xcb_glx_render_mode_reply.

but if you'd rather handle errors over in the event loop instead, use xcb_glx_render_mode_unchecked. see xcb-requests(3) for the full tea on how that works.


πŸ’€ ERRORS πŸ’€

this request never generates any errors. not one. zero. it's the chillest request in the function, fr fr. 🧚


πŸ”₯ SEE ALSO πŸ”₯

(empty, bestie. nothing linked here. a whole section with nothing in it β€” we love a minimalist queen πŸ‘‘)


πŸ’– AUTHOR πŸ’–

generated from glx.xml. got corrections or improvements? hit up xcb@lists.freedesktop.org and tell them, they'd love that for us 🫢


and that's the whole page! this lil cutie came to you from libxcb 1.17.0, under X Version 11, dated in the classic xcb_glx_render_mode(3) style. slay, stay hydrated, and go read your docs bestie πŸ’…βœ¨πŸŽ€