VKGETPHYSICALDEVICED(3)

NAME
vkGetPhysicalDeviceDisplayPlanePropertiesKHR - query the plane properties.

C SPECIFICATION

    VkResult vkGetPhysicalDeviceDisplayPlanePropertiesKHR(
        VkPhysicalDevice                            physicalDevice,
        uint32_t*                                   pPropertyCount,
        VkDisplayPlanePropertiesKHR*                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 VkDisplayPlanePropertiesKHR structures.

DESCRIPTION

vkGetPhysicalDeviceDisplayPlanePropertiesKHR provides a list of plane index and its current display.

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

    typedef struct VkDisplayPlanePropertiesKHR {
        VkDisplayKHR    currentDisplay;
        uint32_t        currentStackIndex;
    } VkDisplayPlanePropertiesKHR;

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 VkDisplayPlanePropertiesKHR 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

vkGetDisplayPlaneSupportedDisplaysKHR, 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.