C Specification
To determine which displays a plane is usable with, call
// Provided by VK_KHR_display
VkResult vkGetDisplayPlaneSupportedDisplaysKHR(
VkPhysicalDevice physicalDevice,
uint32_t planeIndex,
uint32_t* pDisplayCount,
VkDisplayKHR* pDisplays);
Parameters
-
physicalDevice
is a physical device. -
planeIndex
is the plane which the application wishes to use, and must be in the range [0, physical device plane count - 1]. -
pDisplayCount
is a pointer to an integer related to the number of displays available or queried, as described below. -
pDisplays
is eitherNULL
or a pointer to an array ofVkDisplayKHR
handles.
Description
If pDisplays
is NULL
, then the number of displays usable with the
specified planeIndex
for physicalDevice
is returned in
pDisplayCount
.
Otherwise, pDisplayCount
must point to a variable set by the user to
the number of elements in the pDisplays
array, and on return the
variable is overwritten with the number of handles actually written to
pDisplays
.
If the value of pDisplayCount
is less than the number of usable
display-plane pairs for physicalDevice
, at most pDisplayCount
handles will be written, and VK_INCOMPLETE
will be returned instead of
VK_SUCCESS
, to indicate that not all the available pairs were
returned.
If
VkPhysicalDeviceVulkanSC10Properties::deviceNoDynamicHostAllocations
is VK_TRUE
, vkGetDisplayPlaneSupportedDisplaysKHR
must not return
VK_ERROR_OUT_OF_HOST_MEMORY
.
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.