Package org.lwjgl.vulkan

Class VkDisplaySurfaceCreateInfoKHR

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkDisplaySurfaceCreateInfoKHR>
org.lwjgl.vulkan.VkDisplaySurfaceCreateInfoKHR
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkDisplaySurfaceCreateInfoKHR extends org.lwjgl.system.Struct<VkDisplaySurfaceCreateInfoKHR> implements org.lwjgl.system.NativeResource
Structure specifying parameters of a newly created display plane surface object.
Description
Note

Creating a display surface must not modify the state of the displays, planes, or other resources it names. For example, it must not apply the specified mode to be set on the associated display. Application of display configuration occurs as a side effect of presenting to a display surface.

Valid Usage
  • planeIndex must be less than the number of display planes supported by the device as determined by calling vkGetPhysicalDeviceDisplayPlanePropertiesKHR
  • If the planeReorderPossible member of the VkDisplayPropertiesKHR structure returned by vkGetPhysicalDeviceDisplayPropertiesKHR for the display corresponding to displayMode is TRUE then planeStackIndex must be less than the number of display planes supported by the device as determined by calling vkGetPhysicalDeviceDisplayPlanePropertiesKHR; otherwise planeStackIndex must equal the currentStackIndex member of VkDisplayPlanePropertiesKHR returned by vkGetPhysicalDeviceDisplayPlanePropertiesKHR for the display plane corresponding to displayMode
  • If alphaMode is DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR then globalAlpha must be between 0 and 1, inclusive
  • alphaMode must be one of the bits present in the supportedAlpha member of VkDisplayPlaneCapabilitiesKHR for the display plane corresponding to displayMode
  • transform must be one of the bits present in the supportedTransforms member of VkDisplayPropertiesKHR for the display corresponding to displayMode
  • The width and height members of imageExtent must be less than or equal to VkPhysicalDeviceLimits::maxImageDimension2D
  • If the pNext chain includes a VkDisplaySurfaceStereoCreateInfoNV structure whose stereoType member is DISPLAY_SURFACE_STEREO_TYPE_HDMI_3D_NV, then the hdmi3DSupported member of the VkDisplayModeStereoPropertiesNV structure in the pNext chain of the VkDisplayModeProperties2KHR structure returned by GetDisplayModeProperties2KHR for the display mode corresponding to displayMode must be TRUE
Valid Usage (Implicit)
  • sType must be STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR
  • pNext must be NULL or a pointer to a valid instance of VkDisplaySurfaceStereoCreateInfoNV
  • The sType value of each struct in the pNext chain must be unique
  • flags must be 0
  • displayMode must be a valid VkDisplayModeKHR handle
  • transform must be a valid VkSurfaceTransformFlagBitsKHR value
  • alphaMode must be a valid VkDisplayPlaneAlphaFlagBitsKHR value
See Also

VkExtent2D, CreateDisplayPlaneSurfaceKHR

Layout


 struct VkDisplaySurfaceCreateInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkDisplaySurfaceCreateFlagsKHR flags();
     VkDisplayModeKHR displayMode();
     uint32_t planeIndex();
     uint32_t planeStackIndex();
     VkSurfaceTransformFlagBitsKHR transform();
     float globalAlpha();
     VkDisplayPlaneAlphaFlagBitsKHR alphaMode();
     VkExtent2D imageExtent();
 }