VKGETDISPLAYMODEPROP(3)

NAME
vkGetDisplayModePropertiesKHR - get the set of mode properties supported by the display.

C SPECIFICATION

    VkResult vkGetDisplayModePropertiesKHR(
        VkPhysicalDevice                            physicalDevice,
        VkDisplayKHR                                display,
        uint32_t*                                   pPropertyCount,
        VkDisplayModePropertiesKHR*                 pProperties);

PARAMETERS

physicalDevice
    The physical device associated with the display.

display
    A display present on the physical device.

pPropertyCount
    The number of entries in the array pointed to by pProperties.

pProperties
    A pointer to an array of pPropertyCount VkDisplayModePropertiesKHR structures.

DESCRIPTION

vkGetDisplayModePropertiesKHR gets the array of modes supported by the display.

pPrpoerties is an array of the VkDisplayModePropertiesKHR structure, the definition of which is:

    typedef struct VkDisplayModePropertiesKHR {
        VkDisplayModeKHR              displayMode;
        VkDisplayModeParametersKHR    parameters;
    } VkDisplayModePropertiesKHR;

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

vkCreateDisplayModeKHR, vkGetDisplayPlaneCapabilitiesKHR

COPYRIGHT

Copyright © 2014-2016 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.

AUTHOR

Khronos Group
    Author.