STRUCT DRM_MODE_GET_PLANE(9)

💅 struct drm_mode_get_plane(9) — Kernel API Manual

💖 NAME

struct drm_mode_get_plane — Get plane metadata. That's the whole name, bestie. ✨

✨ SYNOPSIS

Okay so here's the struct, copied exactly, no edits, periodt:

struct drm_mode_get_plane {
    __u32 plane_id;
    __u32 crtc_id;
    __u32 fb_id;
    __u32 possible_crtcs;
    __u32 gamma_size;
    __u32 count_format_types;
    __u64 format_type_ptr;
 };

🎀 Members

These are the members, aka the squad. Every single one matters:

• plane_id — Object ID of the plane whose information should be retrieved. Set by caller. 🫶
• crtc_id — Object ID of the current CRTC. 💅
• fb_id — Object ID of the current fb. 🍓
• possible_crtcs — Bitmask of CRTC's compatible with the plane. CRTC's are created and they receive an index, which corresponds to their position in the bitmask. Bit N corresponds to :ref:CRTC index<crtc_index> N. 🌈
• gamma_size — Never used. Like, literally never. 🙈
• count_format_types — Number of formats. 🔢
• format_type_ptr — Pointer to __u32 array of formats that are supported by the plane. These formats do not require modifiers. 👑

🌸 Description

Okay so userspace can perform a GETPLANE ioctl to retrieve information about a plane. That's the mission, bestie. 🕵️♀️

To retrieve the number of formats supported, set count_format_types to zero and call the ioctl. count_format_types will be updated with the value. No cap. 💖

To retrieve these formats, allocate an array with the memory needed to store count_format_types formats. Point format_type_ptr to this array and call the ioctl again (with count_format_types still set to the value returned in the first ioctl call). Two-step reveal, very main character energy. 💅

🔥 SEE ALSO

These are the linked besties — all of them, fr fr:

• Kernel file ./include/uapi/drm/drm_mode.h overview(9)
• struct drm_mode_modeinfo(9)
• struct drm_mode_get_connector(9)
• struct drm_mode_property_enum(9)
• struct drm_mode_get_property(9)
• struct drm_mode_fb_cmd2(9)
• enum drm_colorop_type(9)
• enum drm_colorop_lut3d_interpolation_type(9)
• enum drm_colorop_lut1d_interpolation_type(9)
• struct drm_plane_size_hint(9)
• struct hdr_metadata_infoframe(9)
• struct hdr_output_metadata(9)
• DRM_MODE_PAGE_FLIP_EVENT(9)
• DRM_MODE_PAGE_FLIP_ASYNC(9)
• DRM_MODE_PAGE_FLIP_FLAGS(9)
• struct drm_mode_create_dumb(9)
• DRM_MODE_ATOMIC_TEST_ONLY(9)
• DRM_MODE_ATOMIC_NONBLOCK(9)
• DRM_MODE_ATOMIC_ALLOW_MODESET(9)
• DRM_MODE_ATOMIC_FLAGS(9)
• struct drm_mode_create_blob(9)
• struct drm_mode_destroy_blob(9)
• struct drm_mode_create_lease(9)
• struct drm_mode_list_lessees(9)
• struct drm_mode_get_lease(9)
• struct drm_mode_revoke_lease(9)
• struct drm_mode_rect(9)
• struct drm_mode_closefb(9)

k bye bestie 🫶 source/version: ./include/uapi/drm; date: October 2026; page: struct drm_mode_get_plane(9). mwah 💋