vkGetPhysicalDeviceDisplayPropertiesKHR
Various functions are provided for enumerating the available display devices present on a Vulkan physical device. To query information about the available displays, call:
VkResult vkGetPhysicalDeviceDisplayPropertiesKHR(
VkPhysicalDevice physicalDevice,
uint32_t* pPropertyCount,
VkDisplayPropertiesKHR* pProperties);
physicalDevice
is a physical device.pPropertyCount
is a pointer to an integer related to the number of display devices available or queried, as described below.pProperties
is eitherNULL
or a pointer to an array of VkDisplayPropertiesKHR structures.
If pProperties
is NULL
, then the number of display devices available
for physicalDevice
is returned in pPropertyCount
.
Otherwise, pPropertyCount
must point to a variable set by the
application to the number of elements in the pProperties
array, and on
return the variable is overwritten with the number of structures actually
written to pProperties
.
If the value of pPropertyCount
is less than the number of display
devices for physicalDevice
, at most pPropertyCount
structures
will be written, and VK_INCOMPLETE
will be returned instead of
VK_SUCCESS
, to indicate that not all the available properties were
returned.
Valid Usage (Implicit)
VUID-vkGetPhysicalDeviceDisplayPropertiesKHR-physicalDevice-parameter
physicalDevice
must be a valid VkPhysicalDevice handle
VUID-vkGetPhysicalDeviceDisplayPropertiesKHR-pPropertyCount-parameter
pPropertyCount
must be a valid pointer to a uint32_t
value
VUID-vkGetPhysicalDeviceDisplayPropertiesKHR-pProperties-parameter
If the value referenced by pPropertyCount
is not 0
, and pProperties
is not NULL
, pProperties
must be a valid pointer to an array of pPropertyCount
VkDisplayPropertiesKHR structures