C Specification
Applications that wish to present directly to a display must select which layer, or “plane” of the display they wish to target, and a mode to use with the display. Each display supports at least one plane. The capabilities of a given mode and plane combination are determined by calling:
// Provided by VK_KHR_display
VkResult vkGetDisplayPlaneCapabilitiesKHR(
VkPhysicalDevice physicalDevice,
VkDisplayModeKHR mode,
uint32_t planeIndex,
VkDisplayPlaneCapabilitiesKHR* pCapabilities);
Parameters
-
physicalDevice
is the physical device associated with the display specified bymode
-
mode
is the display mode the application intends to program when using the specified plane. Note this parameter also implicitly specifies a display. -
planeIndex
is the plane which the application intends to use with the display, and is less than the number of display planes supported by the device. -
pCapabilities
is a pointer to a VkDisplayPlaneCapabilitiesKHR structure in which the capabilities are returned.
Document Notes
For more information, see the Vulkan Specification
This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.