xcb_xv_shm_put_image(3)

💖 xcb_xv_shm_put_image — the XCB Requests era 💖

okay bestie, so this is xcb_xv_shm_put_image, a little request function living in the XCB Requests corner of the X world 🦋. That's the manual name, that's the vibe, let's go.

---

✨ SYNOPSIS ✨

first things first, you gotta pull in the header, no cap:

#include <xcb/xv.h>

🎀 Request function 🎀

here's the whole squad, one function, a LOT of arguments, she's serving:

xcb_void_cookie_t xcb_xv_shm_put_image(xcb_connection_t *conn,
       xcb_xv_port_t port, xcb_drawable_t drawable, xcb_gcontext_t gc,
       xcb_shm_seg_t shmseg, uint32_t id, uint32_t offset,
       int16_t src_x, int16_t src_y, uint16_t src_w, uint16_t src_h,
       int16_t drw_x, int16_t drw_y, uint16_t drw_w, uint16_t drw_h,
       uint16_t width, uint16_t height, uint8_t send_event);

---

🌸 REQUEST ARGUMENTS 🌸

here's everybody in the group chat, one by one 💅:

• conn — the XCB connection to X11. she's the whole reason we're here, the main character fr.
• port — TODO: NOT YET DOCUMENTED.
• drawable — TODO: NOT YET DOCUMENTED.
• gc — TODO: NOT YET DOCUMENTED.
• shmseg — TODO: NOT YET DOCUMENTED.
• id — TODO: NOT YET DOCUMENTED.
• offset — TODO: NOT YET DOCUMENTED.
• src_x — TODO: NOT YET DOCUMENTED.
• src_y — TODO: NOT YET DOCUMENTED.
• src_w — TODO: NOT YET DOCUMENTED.
• src_h — TODO: NOT YET DOCUMENTED.
• drw_x — TODO: NOT YET DOCUMENTED.
• drw_y — TODO: NOT YET DOCUMENTED.
• drw_w — TODO: NOT YET DOCUMENTED.
• drw_h — TODO: NOT YET DOCUMENTED.
• width — TODO: NOT YET DOCUMENTED.
• height — TODO: NOT YET DOCUMENTED.
• send_event — TODO: NOT YET DOCUMENTED.

lowkey iconic that literally all of these are "NOT YET DOCUMENTED" 😭 the mystery is the moment, i guess. anyway, that's exactly what the page says, so i'm passing it straight to you, no edits, periodt.

---

🦋 DESCRIPTION 🦋

so… there's nothing here. the DESCRIPTION section is just vibes and silence. 💀 the original page gives us nothing, so i'm giving you nothing but honesty.

---

💜 RETURN VALUE 💜

you get back an xcb_void_cookie_t. that's the whole gift 🎁. any errors? those have to be handled in the event loop, bestie, so don't come crying to the return value.

if you'd rather handle errors directly with xcb_request_check instead, then use xcb_xv_shm_put_image_checked. see xcb-requests(3) for the details 👑

---

🌈 ERRORS 🌈

good news, queen: this request does never generate any errors. not one. zero. the cleanest request in the building ✨

---

⭐ SEE ALSO ⭐

…nothing. the section is empty. it's giving minimalism 🎀

---

👑 AUTHOR 👑

Generated from xv.xml. Contact xcb@lists.freedesktop.org for corrections and improvements. 🫶

---

and that's the whole page, bestie!! 💖 this one came from the X Version 11 / libxcb 1.17.0 era, in the xcb_xv_shm_put_image(3) manual, and it's dated right there with the rest of the XCB Requests crew. slay, bye 🦋✨