C Specification
Each display has one or more supported modes associated with it by default. These built-in modes are queried by calling:
// Provided by VK_KHR_display
VkResult vkGetDisplayModePropertiesKHR(
VkPhysicalDevice physicalDevice,
VkDisplayKHR display,
uint32_t* pPropertyCount,
VkDisplayModePropertiesKHR* pProperties);
Parameters
-
physicalDeviceis the physical device associated withdisplay. -
displayis the display to query. -
pPropertyCountis a pointer to an integer related to the number of display modes available or queried, as described below. -
pPropertiesis eitherNULLor a pointer to an array ofVkDisplayModePropertiesKHRstructures.
Description
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.
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.