VKGETPHYSICALDEVICED(3)

NAME
vkGetPhysicalDeviceDisplayPropertiesKHR - query information about the available displays.

C SPECIFICATION

    VkResult vkGetPhysicalDeviceDisplayPropertiesKHR(
        VkPhysicalDevice                            physicalDevice,
        uint32_t*                                   pPropertyCount,
        VkDisplayPropertiesKHR*                     pProperties);

PARAMETERS

physicalDevice
    A valid physical device.

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

pProperties
    A pointer to an array of pPropertyCount VkDisplayPropertiesKHR structures.

DESCRIPTION

vkGetPhysicalDeviceDisplayPropertiesKHR gets the display properties.

pProperties is an instance of the VkDisplayPropertiesKHR structure, the definition of which is:

    typedef struct VkDisplayPropertiesKHR {
        VkDisplayKHR                  display;
        const char*                   displayName;
        VkExtent2D                    physicalDimensions;
        VkExtent2D                    physicalResolution;
        VkSurfaceTransformFlagsKHR    supportedTransforms;
        VkBool32                      planeReorderPossible;
        VkBool32                      persistentContent;
    } VkDisplayPropertiesKHR;

VALID USAGE

    • physicalDevice must be a valid VkPhysicalDevice 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 VkDisplayPropertiesKHR 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

vkGetDisplayModePropertiesKHR

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.