xcb_xv_query_image_attributes(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

✨ NAME ✨

xcb_xv_query_image_attributes β€” bestie it's an XCB request, and the description slot is literally empty, so like… that's the whole name, no cap πŸ’…

It lives in section 3 of the manual (xcb_xv_query_image_attributes(3)), under the XCB Requests umbrella. πŸ¦‹


🌸 SYNOPSIS 🌸

okay so first things first, you gotta pull in the header:

#include <xcb/xv.h>

πŸ’– Request function

xcb_xv_query_image_attributes_cookie_t
       xcb_xv_query_image_attributes(xcb_connection_t *conn,
       xcb_xv_port_t port, uint32_t id, uint16_t width,
       uint16_t height);

πŸŽ€ Reply datastructure

typedef struct xcb_xv_query_image_attributes_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    uint32_t num_planes;
    uint32_t data_size;
    uint16_t width;
    uint16_t height;
    uint8_t  pad1[12];
} xcb_xv_query_image_attributes_reply_t;

🧚 Reply function

xcb_xv_query_image_attributes_reply_t
       *xcb_xv_query_image_attributes_reply(xcb_connection_t *conn,
       xcb_xv_query_image_attributes_cookie_t cookie,
       xcb_generic_error_t **e);

🫢 Reply accessors

uint32_t *xcb_xv_query_image_attributes_pitches(const
       xcb_xv_query_image_attributes_request_t *reply);

int xcb_xv_query_image_attributes_pitches_length(const
       xcb_xv_query_image_attributes_reply_t *reply);

xcb_generic_iterator_t xcb_xv_query_image_attributes_pitches_end(const
       xcb_xv_query_image_attributes_reply_t *reply);

uint32_t *xcb_xv_query_image_attributes_offsets(const
       xcb_xv_query_image_attributes_request_t *reply);

int xcb_xv_query_image_attributes_offsets_length(const
       xcb_xv_query_image_attributes_reply_t *reply);

xcb_generic_iterator_t xcb_xv_query_image_attributes_offsets_end(const
       xcb_xv_query_image_attributes_reply_t *reply);
not me noticing the pitches and offsets accessors take an xcb_xv_query_image_attributes_request_t *reply while their _length and _end besties take the xcb_xv_query_image_attributes_reply_t *reply πŸ‘€ that's just how it is, don't touch it, copy it character for character fr fr

πŸ”₯ REQUEST ARGUMENTS πŸ”₯

  • conn β€” the XCB connection to X11, your lil hotline to the server πŸ’–
  • port β€” TODO: NOT YET DOCUMENTED. yeah bestie the docs simply did not show up to the function πŸ™ˆ
  • id β€” TODO: NOT YET DOCUMENTED. same vibe, empty slot 😭
  • width β€” TODO: NOT YET DOCUMENTED. nothing here either πŸ’€
  • height β€” TODO: NOT YET DOCUMENTED. and that's the whole list, all mysterious ✨

πŸ‘‘ REPLY FIELDS πŸ‘‘

  • response_type β€” the type of this reply, and in this case it's XCB_XV_QUERY_IMAGE_ATTRIBUTES. this field also lives in the xcb_generic_reply_t, so you can use it to tell your replies apart from each other πŸ¦‹
  • sequence β€” the sequence number of the last request processed by the X11 server, lowkey the server's lil timestamp for your request πŸ’…
  • length β€” the length of the reply, in words. and yes a word is 4 bytes, write that down πŸ“
  • num_planes β€” TODO: NOT YET DOCUMENTED. undocumented, iconic behaviour πŸ™ˆ
  • data_size β€” TODO: NOT YET DOCUMENTED. also a mystery πŸŽ€
  • width β€” TODO: NOT YET DOCUMENTED. yeah. again. 😭
  • height β€” TODO: NOT YET DOCUMENTED. we love a fully blank field set 🫢

🌈 DESCRIPTION 🌈

this section is empty in the original. literally nothing. the description has no description. that's the vibe. πŸ’€

⭐ RETURN VALUE ⭐

You get back an xcb_xv_query_image_attributes_cookie_t πŸͺ β€” adorable, I know.

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

And if you'd rather handle errors in the event loop instead? Then use xcb_xv_query_image_attributes_unchecked. see xcb-requests(3) for the deets, bestie πŸ“š


πŸ’œ ERRORS πŸ’œ

This request does never generate any errors. zero. none. clean run, slay ✨


🌸 SEE ALSO 🌸

nothing listed here in the original β€” the section's just vibing with an empty guest list πŸ™ˆ

πŸ¦‹ 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 X Version 11, libxcb 1.17.0, and it's xcb_xv_query_image_attributes(3) β€” go query those image attributes, you absolute main character πŸ‘‘πŸ’–βœ¨