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
-
physicalDeviceis a physical device. -
planeIndexis the plane which the application wishes to use, and must be in the range [0, physical device plane count - 1]. -
pDisplayCountis a pointer to an integer related to the number of displays available or queried, as described below. -
pDisplaysis eitherNULLor a pointer to an array ofVkDisplayKHRhandles.
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 handles actually written to
pDisplays.
If the value of pDisplayCount is less than the number of display
planes for physicalDevice, at most pDisplayCount handles 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.
See Also
Document Notes
For more information, see the Vulkan Specification
This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.
Copyright
Copyright (c) 2014-2020 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.