vkGetPhysicalDeviceDisplayPlanePropertiesKHR
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);
physicalDevice
is a physical device.pPropertyCount
is a pointer to an integer related to the number of display planes available or queried, as described below.pProperties
is eitherNULL
or a pointer to an array ofVkDisplayPlanePropertiesKHR
structures.
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
application 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.
Valid Usage (Implicit)
VUID-vkGetPhysicalDeviceDisplayPlanePropertiesKHR-physicalDevice-parameter
physicalDevice
must be a valid VkPhysicalDevice handle
VUID-vkGetPhysicalDeviceDisplayPlanePropertiesKHR-pPropertyCount-parameter
pPropertyCount
must be a valid pointer to a uint32_t
value
VUID-vkGetPhysicalDeviceDisplayPlanePropertiesKHR-pProperties-parameter
If the value referenced by pPropertyCount
is not 0
, and pProperties
is not NULL
, pProperties
must be a valid pointer to an array of pPropertyCount
VkDisplayPlanePropertiesKHR structures