VulkanHub
Structures

VkDisplayPlaneInfo2KHR

Structure defining the intended configuration of a display plane

The VkDisplayPlaneInfo2KHR structure is defined as:

typedef struct VkDisplayPlaneInfo2KHR {
    VkStructureType sType;
    const void* pNext;
    VkDisplayModeKHR mode;
    uint32_t planeIndex;
} VkDisplayPlaneInfo2KHR;
  • sType is a VkStructureType value identifying this structure.
  • pNext is NULL or a pointer to a structure extending this structure.
  • mode is the display mode the application intends to program when using the specified plane.

This parameter also implicitly specifies a display.

  • planeIndex is the plane which the application intends to use with the display.

The members of VkDisplayPlaneInfo2KHR correspond to the arguments to vkGetDisplayPlaneCapabilitiesKHR, with sType and pNext added for extensibility.

Valid Usage (Implicit)

VUID-VkDisplayPlaneInfo2KHR-sType-sType

sType must be VK_STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR

VUID-VkDisplayPlaneInfo2KHR-pNext-pNext

pNext must be NULL

VUID-VkDisplayPlaneInfo2KHR-mode-parameter

mode must be a valid VkDisplayModeKHR handle

Host Synchronization

  • Host access to mode must be externally synchronized ::