vkms_config...cursor_plane(9)

📦 version 7.3.1, in nixpkgs unstable

💖 vkms_config_crtc_cursor_plane(9) — the Kernel API Manual glow-up 💖

okay so bestie, we're deep in the Kernel API Manual (section 9, very demure, very kernel of it), and today's main character is vkms_config_crtc_cursor_plane. she's a tiny little getter and honestly she ate 💅

✨ NAME ✨

vkms_config_crtc_cursor_plane — Return the cursor plane for a CRTC 🖱️✨

🦋 SYNOPSIS 🦋

struct vkms_config_plane * vkms_config_crtc_cursor_plane (const struct
vkms_config *config , struct vkms_config_crtc *crtc_cfg );

like, yes, the layout is a little chaotic, but she's literally perfect, no notes 🫶

🎀 ARGUMENTS 🎀

  • config — the Configuration containing the CRTC. that's her home base, her safe space 💜
  • crtc_cfg — okay ngl, the original literally just says -- undescribed -- here 😭 like the docs said "we don't know her" and moved on. so there's no description to pass along, fr fr — that's just what's on the page, periodt.

🌸 DESCRIPTION 🌸

so the way that this works: if multiple cursor planes are found, the first one is returned. iconic behavior, but heads up bestie — in that case, the configuration will be invalid. 👀 like, not in a cute way.

see vkms_config_is_valid if you wanna go check yourself. iykyk 🔥

⭐ RETURN ⭐

the cursor plane, or NULL if none is assigned yet. that's it, that's the whole vibe — no plane, no problem, you just get NULL back 🫶

🌈 SEE ALSO 🌈

Kernel file ./drivers/gpu/drm/vkms/vkms_config.h — and like, the entire extended friend group: 💖

bestie reminder: returning the first of multiple cursor planes = the configuration is invalid. check vkms_config_is_valid. not me warning you twice 😭💀

okay that's the whole page, mwah 💋 this little cutie lives in ./drivers/gpu/drm/vkms, and the version tag says October 2026 — so she's basically from the future, main character energy fr fr 👑✨ bye bestie, go read some struct docs 🦋💜

📦 where this page comes from