VKGETDISPLAYMODEPROP(3)

NAME
vkGetDisplayModePropertiesKHR - Query the set of mode properties supported by the display

C SPECIFICATION

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);

PARAMETERS

    • 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 VkDisplayModePropertiesKHR 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. If pPropertyCount is smaller than the number of display modes available on the specified display for physicalDevice, VK_INCOMPLETE will be returned instead of VK_SUCCESS to indicate that not all the available values were returned.

VALID USAGE

    • physicalDevice must be a valid VkPhysicalDevice handle

    • display must be a valid VkDisplayKHR handle

    • pPropertyCount must be a pointer to a uint32_t value

    • If the value referenced by pPropertyCount is not 0, and pProperties is not NULL, pProperties must be a pointer to an array of pPropertyCount VkDisplayModePropertiesKHR structures

RETURN CODES

On success, this command returns

        • VK_SUCCESS

        • VK_INCOMPLETE

On failure, this command returns

        • VK_ERROR_OUT_OF_HOST_MEMORY

        • VK_ERROR_OUT_OF_DEVICE_MEMORY

SEE ALSO

VkDisplayKHR, VkDisplayModePropertiesKHR, VkPhysicalDevice

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkGetDisplayModePropertiesKHR

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification,not directly.

COPYRIGHT

Copyright (c) 2014-2016 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.

AUTHOR

Khronos Group
    Author.