xcb_glx_get_clip_plane(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_glx_get_clip_plane — and bestie, that dash is followed by absolutely nothing in the original. An enigmatic queen with no description, iconic behavior honestly 💅. This page lives in the XCB Requests manual, and yes, you're in the right place if you were hunting for xcb_glx_get_clip_plane(3).

✨ SYNOPSIS ✨

First things first, you gotta bring in the goods:

#include <xcb/glx.h>

🎀 Request function

xcb_glx_get_clip_plane_cookie_t
       xcb_glx_get_clip_plane(xcb_connection_t *conn,
       xcb_glx_context_tag_t context_tag, int32_t plane);

🎀 Reply datastructure

typedef struct xcb_glx_get_clip_plane_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    uint8_t  pad1[24];
} xcb_glx_get_clip_plane_reply_t;

🎀 Reply function

xcb_glx_get_clip_plane_reply_t
       *xcb_glx_get_clip_plane_reply(xcb_connection_t *conn,
       xcb_glx_get_clip_plane_cookie_t cookie, xcb_generic_error_t **e);

🎀 Reply accessors

xcb_glx_float64_t *xcb_glx_get_clip_plane_data(const
       xcb_glx_get_clip_plane_request_t *reply);

int xcb_glx_get_clip_plane_data_length(const
       xcb_glx_get_clip_plane_reply_t *reply);

xcb_generic_iterator_t xcb_glx_get_clip_plane_data_end(const
       xcb_glx_get_clip_plane_reply_t *reply);

🌸 REQUEST ARGUMENTS 🌸

  • conn — your XCB connection to X11, the whole reason you're here, the group chat server if you will.
  • context_tag — TODO: NOT YET DOCUMENTED. Yeah bestie, the original literally says that. Not me reading it and going 😭.
  • plane — also TODO: NOT YET DOCUMENTED. Same energy, fr fr.

💖 REPLY FIELDS 💖

  • response_type — the type of this reply, which in this case is XCB_GLX_GET_CLIP_PLANE. This field is also chillin' inside the xcb_generic_reply_t, so you can use it to tell your replies apart from each other. Very "how do I know which one is you in a crowd" of it.
  • sequence — the sequence number of the last request that the X11 server actually processed. The receipts, basically.
  • length — how long the reply is, measured in words, and heads up: a word here is 4 bytes. Not a dictionary word. A word. 4 bytes. Periodt.

🧚 DESCRIPTION 🧚

Okay so, plot twist — the DESCRIPTION section in the original is empty. Blank. A whole mood. Nothing to tell you here that isn't already up above, and I'm not about to make stuff up, no cap 🙈.

👑 RETURN VALUE 👑

It hands you back an xcb_glx_get_clip_plane_cookie_t. Cute little cookie, very demure.

Errors? Those get handled when you call the reply function xcb_glx_get_clip_plane_reply.

And if you'd rather deal with errors in the event loop instead, use xcb_glx_get_clip_plane_unchecked. Peep xcb-requests(3) for the details on that whole situation.

💀 ERRORS 💀

This request does never generate any errors. Zero. None. Not a single one. She's drama-free, we love that for her 🫶.

🌈 SEE ALSO 🌈

Nothing listed, bestie. Empty. The original gave us silence and honestly? Respect ✨.

💜 AUTHOR 💜

Generated from glx.xml. Got corrections or improvements? Hit up xcb@lists.freedesktop.org — they're literally asking, so slide in.

And that's the whole page, babes 💅. This beauty came to you from X Version 11, running libxcb 1.17.0 — so if you cite her, cite her right. Stay slaying those X11 requests, bestie, and remember: it's not a bug, it's a TODO: NOT YET DOCUMENTED 🎀🦋💖

📦 where this page comes from