xcb_randr_create_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_randr_create_mode — bestie edition 💖

okay so this one is an XCB Requests page, from the libxcb girlies over at X Version 11. It's xcb_randr_create_mode(3) and she's here to make you a brand new RandR mode. Let's get into it ✨

✨ NAME ✨

xcb_randr_create_mode — no description bestie, the NAME line is literally just vibing there empty 💀

🌸 SYNOPSIS 🌸

First things first, you gotta pull in the header:

#include <xcb/randr.h>

🦋 Request function

xcb_randr_create_mode_cookie_t
       xcb_randr_create_mode(xcb_connection_t *conn,
       xcb_window_t window, xcb_randr_mode_info_t mode_info,
       uint32_t name_len, const char *name);

🦋 Reply datastructure

typedef struct xcb_randr_create_mode_reply_t {
    uint8_t          response_type;
    uint8_t          pad0;
    uint16_t         sequence;
    uint32_t         length;
    xcb_randr_mode_t mode;
    uint8_t          pad1[20];
} xcb_randr_create_mode_reply_t;

🦋 Reply function

xcb_randr_create_mode_reply_t
       *xcb_randr_create_mode_reply(xcb_connection_t *conn,
       xcb_randr_create_mode_cookie_t cookie, xcb_generic_error_t **e);

🎀 REQUEST ARGUMENTS 🎀

  • conn — the XCB connection to X11. your lil hotline to the server, periodt 💅
  • window — TODO: NOT YET DOCUMENTED. (not me getting left on read by the docs 😭)
  • mode_info — TODO: NOT YET DOCUMENTED.
  • name_len — TODO: NOT YET DOCUMENTED.
  • name — TODO: NOT YET DOCUMENTED.
bestie the docs really said "no thoughts, head empty" for four whole arguments and honestly? iconic. the facts stay the facts tho 🫶

💜 REPLY FIELDS 💜

  • response_type — the type of this reply, and in this case it's XCB_RANDR_CREATE_MODE. this field is also chillin' in the xcb_generic_reply_t, and you can use it to tell your replies apart from each other. vibe check: passed ✅
  • sequence — the sequence number of the last request processed by the X11 server. tracking numbers but make it X11 🧚
  • length — the length of the reply, in words (and a word is 4 bytes, so do your little math, bestie).
  • mode — TODO: NOT YET DOCUMENTED. 💀

🌈 DESCRIPTION 🌈

literally nothing here. the DESCRIPTION section is empty. the silence is deafening. no cap. 🙈

⭐ RETURN VALUE ⭐

She returns an xcb_randr_create_mode_cookie_t. 🍪

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

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

🔥 ERRORS 🔥

This request does never generate any errors. clean. pristine. no drama. we love a low-maintenance queen 👑

👑 SEE ALSO 👑

empty bestie, there's nothing linked here 💅

🫶 AUTHOR 🫶

Generated from randr.xml. Contact xcb@lists.freedesktop.org for corrections and improvements. (yes, actually email them, they're nice 🌸)

and that's the whole page, bestie!! this one comes to you courtesy of X Version 11 and libxcb 1.17.0, straight from the libxcb girlies. go forth and create modes responsibly. mwah 💋✨

📦 where this page comes from