xcb_xvmc_create_subpicture(3)

🦋 xcb_xvmc_create_subpicture 🦋

okay bestie, welcome to the libxcb corner of the X universe 💜 this one's a request page for xcb_xvmc_create_subpicture — yes, the X-Video Motion Compensation subpicture saga, and yes, it's giving "the docs said TODO and I said ok bestie same". let's go ✨

---

✨ NAME ✨

xcb_xvmc_create_subpicture — and that's genuinely it, the description line is empty in the original, no cap 💀

---

🌸 SYNOPSIS 🌸

first things first, you gotta pull in the header:

#include <xcb/xvmc.h>

🎀 Request function 🎀

xcb_xvmc_create_subpicture_cookie_t
       xcb_xvmc_create_subpicture(xcb_connection_t *conn,
       xcb_xvmc_subpicture_t subpicture_id, xcb_xvmc_context_t context,
       uint32_t xvimage_id, uint16_t width, uint16_t height);

🎀 Reply datastructure 🎀

typedef struct xcb_xvmc_create_subpicture_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    uint16_t width_actual;
    uint16_t height_actual;
    uint16_t num_palette_entries;
    uint16_t entry_bytes;
    uint8_t  component_order[4];
    uint8_t  pad1[12];
} xcb_xvmc_create_subpicture_reply_t;

🎀 Reply function 🎀

xcb_xvmc_create_subpicture_reply_t
       *xcb_xvmc_create_subpicture_reply(xcb_connection_t *conn,
       xcb_xvmc_create_subpicture_cookie_t cookie,
       xcb_generic_error_t **e);

🎀 Reply accessors 🎀

uint32_t *xcb_xvmc_create_subpicture_priv_data(const
       xcb_xvmc_create_subpicture_request_t *reply);

int xcb_xvmc_create_subpicture_priv_data_length(const
       xcb_xvmc_create_subpicture_reply_t *reply);

xcb_generic_iterator_t xcb_xvmc_create_subpicture_priv_data_end(const
       xcb_xvmc_create_subpicture_reply_t *reply);

---

💖 REQUEST ARGUMENTS 💖

• conn — the XCB connection to X11. your whole link to the server, your main character wire 🔌
• subpicture_id — TODO: NOT YET DOCUMENTED. yeah. the original literally says that. we don't know, bestie 🙈
• context — TODO: NOT YET DOCUMENTED. again 😭
• xvimage_id — TODO: NOT YET DOCUMENTED. the streak continues 💀
• width — TODO: NOT YET DOCUMENTED. they really left us on read 🫶
• height — TODO: NOT YET DOCUMENTED. and that's the last one ✨

---

🌈 REPLY FIELDS 🌈

• response_type — the type of this reply, and in this case it's XCB_XVMC_CREATE_SUBPICTURE. this field is also present in the xcb_generic_reply_t and you can use it to tell replies apart from each other. it's the little name tag at the party 🎀
• sequence — the sequence number of the last request processed by the X11 server. lowkey the receipts of what got done last 📋
• length — the length of the reply, in words (a word is 4 bytes). so like, do the math, 4 bytes per word, periodt 🧮
• width_actual — TODO: NOT YET DOCUMENTED. the actual width, allegedly, but nobody wrote it down 💀
• height_actual — TODO: NOT YET DOCUMENTED. same energy 😭
• num_palette_entries — TODO: NOT YET DOCUMENTED. 🎨 mystery
• entry_bytes — TODO: NOT YET DOCUMENTED. bytes of what bestie, bytes of WHAT 😩
• component_order — TODO: NOT YET DOCUMENTED. it's an array of 4, that's all we get ✨

---

🌟 DESCRIPTION 🌟

so... the DESCRIPTION section in the original is completely empty. like, nothing. zero words. a whole heading and then the void stared back 🕳️ that's the vibe, and I'm not gonna make stuff up to fill it, because that would be lying to you and I would never 💜

---

🫶 RETURN VALUE 🫶

returns an xcb_xvmc_create_subpicture_cookie_t 🍪 yes, a cookie. errors have to be handled when calling the reply function xcb_xvmc_create_subpicture_reply.

if you'd rather handle errors in the event loop instead, use xcb_xvmc_create_subpicture_unchecked. see xcb-requests(3) for details — go read it, iykyk 👑

---

💀 ERRORS 💀

this request does never generate any errors. not one. zero. she's unproblematic, she's the moment, she could never 💅

---

⭐ SEE ALSO ⭐

okay so this section is empty in the original too — no references listed, nothing to see, no links to follow. that's it, that's the section 🦋

---

👑 AUTHOR 👑

generated from xvmc.xml. contact xcb@lists.freedesktop.org for corrections and improvements.

---

friendly reminder bestie: everything above is exactly what the original says — including every TODO: NOT YET DOCUMENTED. — I did not invent behaviour, I just gave it a glow-up ✨

okay that's the whole page, and as a lil sign-off: this beauty comes from X Version 11, libxcb 1.17.0, and it's the xcb_xvmc_create_subpicture(3) manual page 💖 slay, go create some subpictures, and don't forget to call the reply function or your cookie just sits there 🍪✨