wl_global(3)

πŸ’– wl_global πŸ’–

okay bestie, welcome to the wl_global page from the Wayland library functions manual 🌸 this is a struct + a lil family of getter functions, and it's lowkey the whole vibe of how globals get exposed to clients. let's get into it ✨


πŸŽ€ NAME πŸŽ€

wl_global β€” no cap, that's the name, that's the whole thing πŸ’…


✨ SYNOPSIS ✨

🫢 Public Member Functions

uint32_t wl_global_get_name (const struct wl_global *global, const
    struct wl_client *client)
uint32_t wl_global_get_version (const struct wl_global *global)
struct wl_display * wl_global_get_display (const struct wl_global
    *global)

πŸ¦‹ Data Fields

struct wl_display * display
const struct wl_interface * interface
struct wl_list offer_list
uint32_t name
uint32_t version
void * data
wl_global_bind_func_t bind
wl_global_withdrawn_func_t withdrawn
struct wl_list link
bool unpublished

πŸ‘‘ Member Function Documentation πŸ‘‘

🌟 struct wl_display * wl_global_get_display (const struct wl_global * global)

Get the display object for the given global πŸ’« like, "which display does this global belong to?" β€” that one.

Parameters

  • global β€” the global object

Returns

The display object the global is associated with.

Since

1.20


🌈 uint32_t wl_global_get_name (const struct wl_global * global, const struct wl_client * client)

Get the name of the global ✨ the lil peek at what it's called.

Parameters

  • global β€” the global object.
  • client β€” client for which to look up the global.

Returns

The name of the global, or 0 if the global is not visible to the client. (yes bestie, 0 is the "not for you" answer πŸ™ˆ)

Since

1.22


πŸ’œ uint32_t wl_global_get_version (const struct wl_global * global)

Get the version of the given global πŸŽ€

Parameters

  • global β€” the global object.

Returns

The version advertised by the global.

Since

1.21


πŸ“ Field Documentation πŸ“

so here's the thing β€” the original page lists these fields but doesn't give a description for any of them, so i'm not gonna invent lore that isn't there 🫢 i'm just gonna present them, exactly as they are, in this exact order:

🧚 wl_global_bind_func_t wl_global::bind

🧚 void* wl_global::data

🧚 struct wl_display* wl_global::display

🧚 const struct wl_interface* wl_global::interface

🧚 uint32_t wl_global::name

🧚 struct wl_list wl_global::offer_list

🧚 bool wl_global::unpublished

🧚 uint32_t wl_global::version

🧚 wl_global_withdrawn_func_t wl_global::withdrawn

πŸ’€ and that's genuinely it for the field docs β€” no descriptions given, so i'm not about to make stuff up. main character energy is knowing when to stay quiet, fr fr.

🌸 Author 🌸

Generated automatically by Doxygen for Wayland from the source code. (not me writing it by hand, it's the robot πŸ’…)


and that's a wrap, bestie πŸŽ€ this page is straight outta Wayland, Version 1.26.0 β€” go forth and slay those globals βœ¨πŸ’–πŸ¦‹