Function Prototype

vkGetDisplayModeProperties2KHR

Query information about the available display modes.

To query the properties of a device’s built-in display modes, call:

VkResult vkGetDisplayModeProperties2KHR(
    VkPhysicalDevice physicalDevice,
    VkDisplayKHR display,
    uint32_t* pPropertyCount,
    VkDisplayModeProperties2KHR* pProperties);
  • physicalDevice is the physical device associated with display.
  • 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 either NULL or a pointer to an array of VkDisplayModeProperties2KHR structures.

vkGetDisplayModeProperties2KHR behaves similarly to vkGetDisplayModePropertiesKHR, with the ability to return extended information via chained output structures.

Valid Usage (Implicit)

VUID-vkGetDisplayModeProperties2KHR-pPropertyCount-parameter

pPropertyCount must be a valid pointer to a uint32_t value

VUID-vkGetDisplayModeProperties2KHR-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 VkDisplayModeProperties2KHR structures

VUID-vkGetDisplayModeProperties2KHR-display-parent

display must have been created, allocated, or retrieved from physicalDevice