wl_cursor_image(3)

✨ wl_cursor_image ✨

okay bestie, welcome to wl_cursor_image(3) — yes that (3) means it's a library function page, we're in the Wayland section of the manual, living our best life 💅

---

🌸 NAME 🌸

wl_cursor_image — the little struct that holds one still frame of your cursor, and honestly? she's doing a lot for a girl with five fields 🎀

---

🦋 SYNOPSIS 🦋

#include <wayland-cursor.h>

💖 Data Fields 💖

uint32_t width
uint32_t height
uint32_t hotspot_x
uint32_t hotspot_y
uint32_t delay

---

🌈 Detailed Description 🌈

A still image part of a cursor ✨

That's it. That's the vibe. One frame. One picture. If your cursor is animated, she's a whole collection of these, and each one is a single snapshot in the lineup 🫶

and listen — this struct is NOT the thing you slap onto your surface. nope. use wl_cursor_image_get_buffer() to get the corresponding struct wl_buffer to attach to your struct wl_surface. do not skip this step, i'm literally begging 😭

---

👑 Field Documentation 👑

💜 uint32_t wl_cursor_image::delay

Animation delay to next frame (ms) ⏱️

i.e. how long this frame hangs around before the next one slides in. measured in ms, so keep your math honest.

🎀 uint32_t wl_cursor_image::height

Actual height 📏

the real one. the actual one. not a vibe, a number.

🌸 uint32_t wl_cursor_image::hotspot_x

Hot spot x (must be inside image) 🎯

this is the x of the clicky point — the pixel that is your cursor, basically. and note the parenthetical, bestie: it must be inside image. no cap. don't be putting your hotspot outside the picture 💀

🦋 uint32_t wl_cursor_image::hotspot_y

Hot spot y (must be inside image) 🎯

same energy, but the y. also must be inside image. the parentheses are there for a reason, she's not decorating ✨

⭐ uint32_t wl_cursor_image::width

Actual width 📐

the actual width. iconic. immaculate. correct.

---

💖 Author 💖

Generated automatically by Doxygen for Wayland from the source code 🤖✨

---

and that's the whole page, bestie!! this was brought to you by Wayland, Version 1.26.0 — mwah, drink some water, and go attach that wl_buffer correctly 💅🫶