vkGetDisplayModePropertiesKHR
Each display has one or more supported modes associated with it by default. These built-in modes are queried by calling:
VkResult vkGetDisplayModePropertiesKHR(
VkPhysicalDevice physicalDevice,
VkDisplayKHR display,
uint32_t* pPropertyCount,
VkDisplayModePropertiesKHR* pProperties);
physicalDevice
is the physical device associated withdisplay
.display
is the display to query.pPropertyCount
is a pointer to an integer related to the number of display modes available or queried, as described below.pProperties
is eitherNULL
or a pointer to an array ofVkDisplayModePropertiesKHR
structures.
If pProperties
is NULL
, then the number of display modes available
on the specified display
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
modes 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 display modes were
returned.
Valid Usage (Implicit)
VUID-vkGetDisplayModePropertiesKHR-physicalDevice-parameter
physicalDevice
must be a valid VkPhysicalDevice handle
VUID-vkGetDisplayModePropertiesKHR-display-parameter
display
must be a valid VkDisplayKHR handle
VUID-vkGetDisplayModePropertiesKHR-pPropertyCount-parameter
pPropertyCount
must be a valid pointer to a uint32_t
value
VUID-vkGetDisplayModePropertiesKHR-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
VkDisplayModePropertiesKHR structures
VUID-vkGetDisplayModePropertiesKHR-display-parent
display
must have been created, allocated, or retrieved from physicalDevice