VKGETDISPLAYPLANESUP(3)

NAME
vkGetDisplayPlaneSupportedDisplaysKHR - get list of displays a plane supports.

C SPECIFICATION

    VkResult vkGetDisplayPlaneSupportedDisplaysKHR(
        VkPhysicalDevice                            physicalDevice,
        uint32_t                                    planeIndex,
        uint32_t*                                   pDisplayCount,
        VkDisplayKHR*                               pDisplays);

PARAMETERS

physicalDevice
    A valid physical device.

planeIndex
    The plane which the application wishes to use.

pDisplayCount
    The number of entries in the array pointed to by pDisplays.

pDisplays
    A pointer to an array of pDisplayCount VkDisplayKHR handles.

DESCRIPTION

vkGetDisplayPlaneSupportedDisplaysKHR determine which displays a plane is usable with.

pDisplays is an instance of the VkDisplayKHR structure, the definition of which is:

VALID USAGE

    • physicalDevice must be a valid VkPhysicalDevice handle

    • pDisplayCount must be a pointer to a uint32_t value

    • If the value referenced by pDisplayCount is not 0, and pDisplays is not NULL, pDisplays must be a pointer to an array of pDisplayCount VkDisplayKHR handles

    • planeIndex must be less than the number of display planes supported by the device as determined by calling vkGetPhysicalDeviceDisplayPlanePropertiesKHR

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

vkCreateDisplayPlaneSurfaceKHR

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.