xcb_dri3_pixmap_from_buffers(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_dri3_pixmap_from_buffers πŸ’…

okay bestie, welcome to the XCB Requests section of the manual, and today's main character is xcb_dri3_pixmap_from_buffers(3). it's giving very much "make a pixmap out of a bunch of buffers" energy, and we're gonna walk through it together. no cap. πŸ¦‹


πŸŽ€ NAME πŸŽ€

xcb_dri3_pixmap_from_buffers β€” the request that does the thing. (the original manpage literally leaves the description blank after the dash, so we're keeping that mysterious silence. it's called ✨minimalism✨.)


🌸 SYNOPSIS 🌸

first things first, you gotta pull in the header, periodt:

#include <xcb/dri3.h>

πŸ’– Request function πŸ’–

here's the whole signature, exactly as it lives, don't @ me:

xcb_void_cookie_t xcb_dri3_pixmap_from_buffers(xcb_connection_t *conn,
       xcb_pixmap_t pixmap, xcb_window_t window, uint8_t num_buffers,
       uint16_t width, uint16_t height, uint32_t stride0,
       uint32_t offset0, uint32_t stride1, uint32_t offset1,
       uint32_t stride2, uint32_t offset2, uint32_t stride3,
       uint32_t offset3, uint8_t depth, uint8_t bpp, uint64_t modifier,
       const int32_t *buffers);

🌈 REQUEST ARGUMENTS 🌈

so. the tea. β˜• most of these arguments are, and I quote the original manpage here, TODO: NOT YET DOCUMENTED. bestie the documentation team really said "we'll do it later" and then never did. iconic honestly. but here's every single one of them, in order, exactly as listed:

  • conn β€” the XCB connection to X11. this is your lil hotline to the X server, your main character link-up. πŸ’…

and now, the rest of the squad, all of whom are TODO: NOT YET DOCUMENTED.:

  • pixmap β€” TODO: NOT YET DOCUMENTED. πŸ™ˆ
  • window β€” TODO: NOT YET DOCUMENTED. πŸͺŸ
  • num_buffers β€” TODO: NOT YET DOCUMENTED. πŸ”’
  • width β€” TODO: NOT YET DOCUMENTED. πŸ“
  • height β€” TODO: NOT YET DOCUMENTED. πŸ“
  • stride0 β€” TODO: NOT YET DOCUMENTED. πŸšΆβ€β™€οΈ
  • offset0 β€” TODO: NOT YET DOCUMENTED. πŸ“
  • stride1 β€” TODO: NOT YET DOCUMENTED. πŸšΆβ€β™€οΈ
  • offset1 β€” TODO: NOT YET DOCUMENTED. πŸ“
  • stride2 β€” TODO: NOT YET DOCUMENTED. πŸšΆβ€β™€οΈ
  • offset2 β€” TODO: NOT YET DOCUMENTED. πŸ“
  • stride3 β€” TODO: NOT YET DOCUMENTED. πŸšΆβ€β™€οΈ
  • offset3 β€” TODO: NOT YET DOCUMENTED. πŸ“
  • depth β€” TODO: NOT YET DOCUMENTED. πŸ•³οΈ
  • bpp β€” TODO: NOT YET DOCUMENTED. 🎨
  • modifier β€” TODO: NOT YET DOCUMENTED. πŸ”§
  • buffers β€” TODO: NOT YET DOCUMENTED. πŸ“¦
ngl bestie, if you need the real deets on any of these, the manpage is not the one. it's giving "trust the source code" energy. no hate, just facts. πŸ’€

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so... the DESCRIPTION section of the original is completely empty. like, nothing. a whole heading with zero words under it. it's giving "entered the group chat and said nothing" and honestly? we respect the silence. so there's nothing to summarize here, and I'm not about to invent lore that isn't in the source. periodt. ✨


πŸ‘‘ RETURN VALUE πŸ‘‘

so what do you get back? an xcb_void_cookie_t, that's what. πŸͺ

and because it's a void cookie, any errors have to be handled in the event loop, bestie. you don't get them handed to you on a platter.

but wait β€” if you'd rather handle errors directly with xcb_request_check instead, then you want xcb_dri3_pixmap_from_buffers_checked. she's the same request but she tells you what went wrong. slay.

for the full scoop on how this whole request/cookie/checked situation works, go read xcb-requests(3). it's required reading, fr fr. πŸ“š


πŸ’€ ERRORS πŸ’€

good news, babe:

This request does never generate any errors.

literally zero errors. she's unproblematic. she's never gonna text you back with bad news. we love a low-maintenance queen. πŸ’–


πŸ”₯ SEE ALSO πŸ”₯

...okay so the SEE ALSO section is empty too. no cross-references, nothing. the original just put the heading there and walked away. it's giving "left on read". 😭


🌟 AUTHOR 🌟

this page was generated from dri3.xml. if you've got corrections or improvements, hit up xcb@lists.freedesktop.org β€” they're literally waiting for your hot takes. πŸ“§


and that's the whole page, bestie!! 🫢 this lil gem comes to you from X Version 11 and libxcb 1.17.0 β€” so yeah, that's the version and the source, noted and cherished. go forth and make some pixmaps out of buffers. you got this. mwah. πŸ’…πŸ’–πŸŒΈπŸ¦‹βœ¨