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
-
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.
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 user 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.
If
VkPhysicalDeviceVulkanSC10Properties::deviceNoDynamicHostAllocations
is VK_TRUE
, vkGetDisplayModePropertiesKHR
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.