xcb_dri2_get_...s_with_format(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_dri2_get_...s_with_format ✨

okay bestie, sit down, hydrate, because we're getting into xcb_dri2_get_...s_with_format β€” a request from the XCB Requests corner of the universe, living its best life in manual section 3. This is the libxcb page for it, so buckle up πŸŽ€


πŸ’– NAME πŸ’–

xcb_dri2_get_buffers_with_format β€” and that's it, that's the whole name section, the original literally left it blank after the dash and honestly? mysterious. iconic. no notes. πŸ’…


🌸 SYNOPSIS 🌸

#include <xcb/dri2.h>

πŸ¦‹ Request function

xcb_dri2_get_buffers_with_format_cookie_t
       xcb_dri2_get_buffers_with_format(xcb_connection_t *conn,
       xcb_drawable_t drawable, uint32_t count,
       uint32_t attachments_len, const
       xcb_dri2_attach_format_t *attachments);

πŸ“ Reply datastructure

typedef struct xcb_dri2_get_buffers_with_format_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    uint32_t width;
    uint32_t height;
    uint32_t count;
    uint8_t  pad1[12];
} xcb_dri2_get_buffers_with_format_reply_t;

🧚 Reply function

xcb_dri2_get_buffers_with_format_reply_t
       *xcb_dri2_get_buffers_with_format_reply(xcb_connection_t *conn,
       xcb_dri2_get_buffers_with_format_cookie_t cookie,
       xcb_generic_error_t **e);

⭐ Reply accessors

xcb_dri2_dri2_buffer_t *xcb_dri2_get_buffers_with_format_buffers(const
       xcb_dri2_get_buffers_with_format_request_t *reply);

int xcb_dri2_get_buffers_with_format_buffers_length(const
       xcb_dri2_get_buffers_with_format_reply_t *reply);

xcb_dri2_dri2_buffer_iterator_t
       xcb_dri2_get_buffers_with_format_buffers_iterator(const
       xcb_dri2_get_buffers_with_format_reply_t *reply);

πŸ‘‘ REQUEST ARGUMENTS πŸ‘‘

  • conn β€” your XCB connection to X11. the whole pipeline to the server, the main character of the connection world 🫢
  • drawable β€” TODO: NOT YET DOCUMENTED. bestie the docs simply did not show up to work today 😭
  • count β€” TODO: NOT YET DOCUMENTED. same energy, same empty energy πŸ’€
  • attachments_len β€” TODO: NOT YET DOCUMENTED. the mystery continues, no cap πŸ™ˆ
  • attachments β€” TODO: NOT YET DOCUMENTED. four for four, we love an undocumented era ✨

🌈 REPLY FIELDS 🌈

  • response_type β€” the type of this reply, which in this case is XCB_DRI2_GET_BUFFERS_WITH_FORMAT. this field also lives in the xcb_generic_reply_t, and it's how you tell your replies apart from each other β€” like name tags at a party but for structs πŸŽ€
  • sequence β€” the sequence number of the last request processed by the X11 server. your lil receipt number fr fr 🧾
  • length β€” the length of the reply, in words. and a word is 4 bytes, in case you were about to guess πŸ’…
  • width β€” TODO: NOT YET DOCUMENTED. πŸ¦‹
  • height β€” TODO: NOT YET DOCUMENTED. πŸ¦‹
  • count β€” TODO: NOT YET DOCUMENTED. πŸ¦‹

πŸ’œ DESCRIPTION πŸ’œ

so the DESCRIPTION section is... empty. nothing. a blank canvas. a vibe. lowkey iconic that the original just left it like that, and highkey we're respecting the silence 🀫✨


πŸ”₯ RETURN VALUE πŸ”₯

It returns an xcb_dri2_get_buffers_with_format_cookie_t β€” yes a cookie, and yes it's as cute as it sounds, but it's actually your ticket to come back later. Errors have to be handled when you call the reply function xcb_dri2_get_buffers_with_format_reply. πŸͺ

If you'd rather handle errors in the event loop instead, use xcb_dri2_get_buffers_with_format_unchecked. See xcb-requests(3) for details β€” bestie, go read that one, it's the lore πŸ’–


πŸ’€ ERRORS πŸ’€

This request does never generate any errors. not one. zero. a clean slate, a flawless queen, periodt. πŸ‘‘


πŸ¦‹ SEE ALSO πŸ¦‹

...nothing listed. the original left this one wide open too. an empty shelf, a blank chapter, we love the minimalism πŸŽ€


🌸 AUTHOR 🌸

Generated from dri2.xml. Contact xcb@lists.freedesktop.org for corrections and improvements β€” that's the official bat-signal, so use it if something's off 🫢


and that's the whole page bestie!! every flag, field, struct and TODO accounted for, nothing skipped, we ate and left no crumbs πŸ“

later, legend β€” this was X Version 11, libxcb 1.17.0, and you've been reading xcb_dri2_get_...s_with_format(3). mwah πŸ’‹βœ¨