vkms_config_default_create(9)

πŸ“¦ version 7.3.1, in nixpkgs unstable

πŸ’… vkms_config_default_create(9)

okay so first things first, quick vibe check on what we're even looking at: this is a page from the Kernel API Manual, and it's about vkms_config_default_create. Yes it's kernel DRM stuff. No it's not scary. Sit with me. 🫢


✨ NAME ✨

vkms_config_default_create β€” Create the configuration for the default device


🌸 SYNOPSIS 🌸

struct vkms_config * vkms_config_default_create (bool enable_cursor ,
       bool enable_writeback , bool enable_overlay , bool enable_plane_pipeline
       );

like… look at that signature. four little bools and a whole struct vkms_config * comes out. main character energy fr fr. πŸ‘‘


πŸŽ€ ARGUMENTS πŸŽ€

  • enable_cursor β€” Create or not a cursor plane. that's it, that's the whole thing: cursor plane, yes or no. πŸ–±οΈ
  • enable_writeback β€” Create or not a writeback connector. you either get one or you don't. ✨
  • enable_overlay β€” Create or not overlay planes. overlay planes: on or off, babes. 🌈
  • enable_plane_pipeline β€” -- undescribed --
bestie I need you to know I am NOT gatekeeping here β€” the original page literally says -- undescribed -- for this one. so the argument exists, it's in the signature, and the manual just… didn't describe it. not me being lazy, that's just what the page says. πŸ’€

πŸ¦‹ RETURN πŸ¦‹

Returns the default vkms_config β€” or, you know, an error, because life happens. 😭

When you're done with it, call vkms_config_destroy to free the returned configuration. like please actually free it. don't just leave it there. πŸ’–


🧚 SEE ALSO 🧚

All the siblings and cousins of this function, gathered for you, because the family is large and honestly iconic for it:

Kernel file ./drivers/gpu/drm/vkms/vkms_config.h struct vkms_config(9), struct vkms_config_plane(9), struct vkms_config_crtc(9), struct vkms_config_encoder(9), struct vkms_config_connector(9), vkms_config_for_each_plane(9), vkms_config_for_each_crtc(9), vkms_config_for_each_encoder(9), vkms_config_for_each_connector(9), vkms_config_plane_for_each_possible_crtc(9), vkms_config_encoder_for_each_possible_crtc(9), vkms_config_connector_for_each_possible_encoder(9), vkms_config_create(9), vkms_config_destroy(9), vkms_config_get_device_name(9), vkms_config_get_num_crtcs(9), vkms_config_is_valid(9), vkms_config_register_debugfs(9), vkms_config_create_plane(9), vkms_config_destroy_plane(9), vkms_config_plane_set_type(9), vkms_config_plane_get_default_pipeline(9), vkms_config_plane_set_default_pipeline(9), vkms_config_plane_attach_crtc(9), vkms_config_plane_detach_crtc(9), vkms_config_create_crtc(9), vkms_config_destroy_crtc(9), vkms_config_crtc_get_writeback(9), vkms_config_crtc_set_writeback(9), vkms_config_crtc_primary_plane(9), vkms_config_crtc_cursor_plane(9), vkms_config_create_encoder(9), vkms_config_destroy_encoder(9), vkms_config_encoder_attach_crtc(9), vkms_config_encoder_detach_crtc(9), vkms_config_create_connector(9), vkms_config_destroy_connector(9), vkms_config_connector_attach_encoder(9), vkms_config_connector_detach_encoder(9), vkms_config_connector_get_status(9), vkms_config_connector_set_status(9)


okay that's the whole page, you ate that up. πŸ’… this lil beauty lives in ./drivers/gpu/drm/vkms and the docs are stamped October 2026 β€” so go forth, make your default vkms config, and remember to vkms_config_destroy it. mwah. πŸ“βœ¨

πŸ“¦ where this page comes from