STRUCT VMW_SURFACE_METADATA(9)

💖 struct vmw_surface_metadata(9) 💖

okay so bestie, welcome to the Kernel API Manual entry for struct vmw_surface_metadata(9). This is the lowkey iconic struct that describes surface metadata, and we’re gonna go through every single member, no skips, periodt. 💅✨

🌸 NAME 🌸

struct vmw_surface_metadata — Metadata describing a surface. 🎀

✨ SYNOPSIS ✨

struct vmw_surface_metadata {
    u64 flags;
    u32 format;
    u32 mip_levels[DRM_VMW_MAX_SURFACE_FACES];
    u32 multisample_count;
    u32 multisample_pattern;
    u32 quality_level;
    u32 autogen_filter;
    u32 array_size;
    u32 num_sizes;
    u32 buffer_byte_stride;
    struct drm_vmw_size base_size;
    struct drm_vmw_size *sizes;
    bool scanout;
};

👑 Members 👑

• flags — Device flags. 🚩
• format — Surface SVGA3D_x format. 🎨
• mip_levels — Mip level for each face. For GB first index is used only. 🧚
• multisample_count — Sample count. 🔢
• multisample_pattern — Sample patterns. 🌸
• quality_level — Quality level. 👑
• autogen_filter — Filter for automatically generated mipmaps. ✨
• array_size — Number of array elements for a 1D/2D texture. For cubemap texture number of faces * array_size. This should be 0 for pre SM4 device. 🚨
• num_sizes — Size of sizes. For GB surface this should always be 1. ✅
• buffer_byte_stride — Buffer byte stride. 📏
• base_size — Surface dimension. 📐
• sizes — Array representing mip sizes. Legacy only. 🕰️
• scanout — Whether this surface will be used for scanout. 👀

🦋 Description 🦋

This tracks metadata for both legacy and guest backed surface. 💖

🌈 SEE ALSO 🌈

Kernel file ./drivers/gpu/drm/vmwgfx/vmwgfx_drv.h struct vmw_resource(9), struct vmw_surface(9), struct vmw_res_cache_entry(9), enum vmw_dma_map_mode(9), struct vmw_sg_table(9), struct vmw_piter(9), struct vmw_sw_context(9), enum vmw_sm_type(9), has_sm4_context(9), has_sm4_1_context(9), has_sm5_context(9), has_gl43_context(9), vmw_resource_mob_attached(9), vmw_fifo_caps(9), vmw_is_cursor_bypass3_enabled(9), vmw_piter_next(9), vmw_piter_dma_addr(9), vmw_piter_page(9), struct vmw_diff_cpy(9), VMW_DEBUG_USER(9), VMW_DEBUG_KMS(9), vmw_fifo_mem_read(9), vmw_fifo_mem_write(9)

mwah! 💋 that’s the whole page — source/version vibe is ./drivers/gpu/drm/vmwgfx, dated October 2026, and the main character is still struct vmw_surface_metadata(9). 🫶🌷