C Specification
To query the properties of a device’s built-in display modes, call:
// Provided by VK_KHR_get_display_properties2
VkResult vkGetDisplayModeProperties2KHR(
VkPhysicalDevice physicalDevice,
VkDisplayKHR display,
uint32_t* pPropertyCount,
VkDisplayModeProperties2KHR* pProperties);
Parameters
-
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 ofVkDisplayModeProperties2KHR
structures.
Description
vkGetDisplayModeProperties2KHR
behaves similarly to
vkGetDisplayModePropertiesKHR, with the ability to return extended
information via chained output structures.
If
VkPhysicalDeviceVulkanSC10Properties::deviceNoDynamicHostAllocations
is VK_TRUE
, vkGetDisplayModeProperties2KHR
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.