C Specification
Images are presented to individual planes on a display. Devices must support at least one plane on each display. Planes can be stacked and blended to composite multiple images on one display. Devices may support only a fixed stacking order and fixed mapping between planes and displays, or they may allow arbitrary application specified stacking orders and mappings between planes and displays. To query the properties of device display planes, call:
VkResult vkGetPhysicalDeviceDisplayPlanePropertiesKHR(
VkPhysicalDevice physicalDevice,
uint32_t* pPropertyCount,
VkDisplayPlanePropertiesKHR* pProperties);
Parameters
-
physicalDeviceis a physical device. -
pPropertyCountis a pointer to an integer related to the number of display planes available or queried, as described below. -
pPropertiesis eitherNULLor a pointer to an array ofVkDisplayPlanePropertiesKHRstructures.
Description
If pProperties is NULL, then the number of display planes available
for physicalDevice is returned in pPropertyCount.
Otherwise, pPropertyCount must point to a variable set by the user to
the number of elements in the pProperties array, and on return the
variable is overwritten with the number of structures actually written to
pProperties.
If the value of pPropertyCount is less than the number of display
planes for physicalDevice, at most pPropertyCount structures
will be written.
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.