VKGETDISPLAYPLANESUP(3)

NAME
vkGetDisplayPlaneSupportedDisplaysKHR - Query the list of displays a plane supports

C SPECIFICATION

To determine which displays a plane is usable with, call

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

PARAMETERS

    • physicalDevice is a physical device.

    • planeIndex is the plane which the application wishes to use, and must be in the range [ $[0, thit{physical device plane count}-1]$ ].

    • pDisplayCount is a pointer to an integer related to the number of display planes available or queried, as described below.

    • pDisplays is either NULL or a pointer to an array of VkDisplayKHR structures.

DESCRIPTION

If pDisplays is NULL, then the number of displays usable with the specified planeIndex for physicalDevice is returned in pDisplayCount. Otherwise, pDisplayCount must point to a variable set by the user to the number of elements in the pDisplays array, and on return the variable is overwritten with the number of structures actually written to pDisplays. If the value of pDisplayCount is less than the number of display planes for physicalDevice, at most pDisplayCount structures will be written. If pDisplayCount is smaller than the number of displays usable with the specified planeIndex 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

    • 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

VkDisplayKHR, VkPhysicalDevice

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.