xcb_shape_query_extents(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_shape_query_extents β€” bestie edition πŸ’–

okay so this is a page from the XCB Requests corner of the libxcb world, and it's all about xcb_shape_query_extents. She's a lil request function, she comes with a reply struct AND a reply function, and honestly? she's giving "lowkey mysterious" because half her docs are literally TODO: NOT YET DOCUMENTED πŸ™ˆ. We're gonna walk through every single field anyway, no cap. Let's go ✨


🌸 SYNOPSIS 🌸

#include <xcb/shape.h>

✨ Request function

xcb_shape_query_extents_cookie_t
       xcb_shape_query_extents(xcb_connection_t *conn,
       xcb_window_t destination_window);

πŸŽ€ Reply datastructure

typedef struct xcb_shape_query_extents_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    uint8_t  bounding_shaped;
    uint8_t  clip_shaped;
    uint8_t  pad1[2];
    int16_t  bounding_shape_extents_x;
    int16_t  bounding_shape_extents_y;
    uint16_t bounding_shape_extents_width;
    uint16_t bounding_shape_extents_height;
    int16_t  clip_shape_extents_x;
    int16_t  clip_shape_extents_y;
    uint16_t clip_shape_extents_width;
    uint16_t clip_shape_extents_height;
} xcb_shape_query_extents_reply_t;

πŸ’… Reply function

xcb_shape_query_extents_reply_t
       *xcb_shape_query_extents_reply(xcb_connection_t *conn,
       xcb_shape_query_extents_cookie_t cookie,
       xcb_generic_error_t **e);

🫢 REQUEST ARGUMENTS 🫢

  • conn β€” the XCB connection to X11, aka your hotline to the server πŸ’Œ
  • destination_window β€” TODO: NOT YET DOCUMENTED. like... the docs really said "figure it out bestie" 😭

πŸ‘‘ REPLY FIELDS πŸ‘‘

  • response_type β€” the type of this reply, in this case XCB_SHAPE_QUERY_EXTENTS. This field is also present in the xcb_generic_reply_t and can be used to tell replies apart from each other. it's literally the vibe check that says "yep, this one's mine" ⭐
  • sequence β€” the sequence number of the last request processed by the X11 server. the receipts, fr fr 🧾
  • length β€” the length of the reply, in words (a word is 4 bytes). math girlies stay winning ✨
  • bounding_shaped β€” TODO: NOT YET DOCUMENTED. πŸ’€
  • clip_shaped β€” TODO: NOT YET DOCUMENTED. πŸ’€
  • bounding_shape_extents_x β€” TODO: NOT YET DOCUMENTED. πŸ’€
  • bounding_shape_extents_y β€” TODO: NOT YET DOCUMENTED. πŸ’€
  • bounding_shape_extents_width β€” TODO: NOT YET DOCUMENTED. πŸ’€
  • bounding_shape_extents_height β€” TODO: NOT YET DOCUMENTED. πŸ’€
  • clip_shape_extents_x β€” TODO: NOT YET DOCUMENTED. πŸ’€
  • clip_shape_extents_y β€” TODO: NOT YET DOCUMENTED. πŸ’€
  • clip_shape_extents_width β€” TODO: NOT YET DOCUMENTED. πŸ’€
  • clip_shape_extents_height β€” TODO: NOT YET DOCUMENTED. πŸ’€

🌈 DESCRIPTION 🌈

...and that's it. that's the section. she's empty. she said "no thoughts, head empty" πŸ¦‹βœ¨ (iconic behaviour, honestly)


πŸ’œ RETURN VALUE πŸ’œ

Returns an xcb_shape_query_extents_cookie_t. Errors have to be handled when calling the reply function xcb_shape_query_extents_reply.

If you want to handle errors in the event loop instead, use xcb_shape_query_extents_unchecked. See xcb-requests(3) for details. pick your fighter πŸ₯Š


πŸ“ ERRORS πŸ“

This request does never generate any errors. zero drama, zero problems, we love a clean queen πŸ‘‘βœ¨


🧚 SEE ALSO 🧚

(empty, bestie β€” nothing to see here, moving on 🫢)


🌸 AUTHOR 🌸

Generated from shape.xml. Contact xcb@lists.freedesktop.org for corrections and improvements. send them an email if something's off, they're literally asking πŸ™ˆπŸ’Œ


okay that's the whole page, bestie!! πŸ’– this was X Version 11, libxcb 1.17.0, and the page itself is xcb_shape_query_extents(3). go forth and query those extents, you absolute main character πŸŽ€βœ¨πŸ¦‹