xcb_randr_get_output_property(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_randr_get_output_property ✨

okay bestie, so this is a page from the XCB Requests manual, and it's literally the ✨ tea ✨ on how to ask the X server about a property that's hanging off one of your RandR outputs. It's giving "peek behind the curtain but make it a protocol request." πŸ’…


πŸŽ€ SYNOPSIS πŸŽ€

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

#include <xcb/randr.h>

🌸 Request function

xcb_randr_get_output_property_cookie_t
       xcb_randr_get_output_property(xcb_connection_t *conn,
       xcb_randr_output_t output, xcb_atom_t property, xcb_atom_t type,
       uint32_t long_offset, uint32_t long_length, uint8_t _delete,
       uint8_t pending);

πŸ¦‹ Reply datastructure

typedef struct xcb_randr_get_output_property_reply_t {
    uint8_t    response_type;
    uint8_t    format;
    uint16_t   sequence;
    uint32_t   length;
    xcb_atom_t type;
    uint32_t   bytes_after;
    uint32_t   num_items;
    uint8_t    pad0[12];
} xcb_randr_get_output_property_reply_t;

🌈 Reply function

xcb_randr_get_output_property_reply_t
       *xcb_randr_get_output_property_reply(xcb_connection_t *conn,
       xcb_randr_get_output_property_cookie_t cookie,
       xcb_generic_error_t **e);

⭐ Reply accessors

uint8_t *xcb_randr_get_output_property_data(const
       xcb_randr_get_output_property_request_t *reply);

int xcb_randr_get_output_property_data_length(const
       xcb_randr_get_output_property_reply_t *reply);

xcb_generic_iterator_t xcb_randr_get_output_property_data_end(const
       xcb_randr_get_output_property_reply_t *reply);

πŸ’– REQUEST ARGUMENTS πŸ’–

  • conn β€” the XCB connection to X11. your lil hotline to the server, fr.
  • output β€” TODO: NOT YET DOCUMENTED. yeah bestie, the docs just said "we'll finish this later" and never came back 😭
  • property β€” TODO: NOT YET DOCUMENTED. same energy, it's a mystery 🫣
  • type β€” TODO: NOT YET DOCUMENTED. iconic of them to leave us hanging.
  • long_offset β€” TODO: NOT YET DOCUMENTED. no notes, just vibes and question marks.
  • long_length β€” TODO: NOT YET DOCUMENTED. also undocumented, also slaying in the shadows.
  • _delete β€” TODO: NOT YET DOCUMENTED. yes the underscore is literally part of the name, don't come for me.
  • pending β€” TODO: NOT YET DOCUMENTED. last one, also a mystery, we move.

πŸ‘‘ REPLY FIELDS πŸ‘‘

  • response_type β€” the type of this reply, and in this case it's XCB_RANDR_GET_OUTPUT_PROPERTY. This field is also chillin' in the xcb_generic_reply_t, so you can use it to tell your replies apart from each other. very demure, very mindful. πŸ’…
  • sequence β€” the sequence number of the last request the X11 server actually processed. like a lil timestamp of "yeah I did that one."
  • length β€” how long the reply is, in words. and btw a word is 4 bytes, so do with that what you will.
  • format β€” TODO: NOT YET DOCUMENTED. shocking, I know. πŸ™ˆ
  • type β€” TODO: NOT YET DOCUMENTED. yes there's a type in the request and one here, they're different, keep up bestie.
  • bytes_after β€” TODO: NOT YET DOCUMENTED. the name is very suggestive but the docs said nothing, so neither will I.
  • num_items β€” TODO: NOT YET DOCUMENTED. again. it's a whole situation.

πŸ’œ DESCRIPTION πŸ’œ

...and that's it. There's literally nothing here. The description section is just empty, bestie. We have been left on read. 🫢


πŸ”₯ RETURN VALUE πŸ”₯

It hands you back an xcb_randr_get_output_property_cookie_t. Errors have to be dealt with when you call the reply function xcb_randr_get_output_property_reply.

But if you'd rather handle your errors inside the event loop instead (main character behavior, honestly), then use xcb_randr_get_output_property_unchecked. Peep xcb-requests(3) for the details on that whole situation.


πŸ’€ ERRORS πŸ’€

This request does never generate any errors. Not one. Zero. It's that girl and she doesn't start drama. periodt.

🌸 SEE ALSO 🌸

...nothing. The SEE ALSO section is empty, bestie. We're on our own out here. 🧚


πŸ“ AUTHOR πŸ“

Generated from randr.xml. If you wanna send corrections and improvements, hit up xcb@lists.freedesktop.org. They're literally waiting for your email. πŸ’Œ


and that's the whole page, bestie!! this lil slice of the manual is from X Version 11, libxcb 1.17.0, and it's page xcb_randr_get_output_property(3). mwah, go read some properties, you got this πŸ’–βœ¨πŸŽ€