vkGetDisplayPlaneSupportedDisplaysKHR
To determine which displays a plane is usable with, call
VkResult vkGetDisplayPlaneSupportedDisplaysKHR(
VkPhysicalDevice physicalDevice,
uint32_t planeIndex,
uint32_t* pDisplayCount,
VkDisplayKHR* pDisplays);
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.
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
application 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.
Valid Usage
VUID-vkGetDisplayPlaneSupportedDisplaysKHR-planeIndex-01249
planeIndex
must be less than the number of display planes
supported by the device as determined by calling
vkGetPhysicalDeviceDisplayPlanePropertiesKHR
Valid Usage (Implicit)
VUID-vkGetDisplayPlaneSupportedDisplaysKHR-physicalDevice-parameter
physicalDevice
must be a valid VkPhysicalDevice handle
VUID-vkGetDisplayPlaneSupportedDisplaysKHR-pDisplayCount-parameter
pDisplayCount
must be a valid pointer to a uint32_t
value
VUID-vkGetDisplayPlaneSupportedDisplaysKHR-pDisplays-parameter
If the value referenced by pDisplayCount
is not 0
, and pDisplays
is not NULL
, pDisplays
must be a valid pointer to an array of pDisplayCount
VkDisplayKHR handles