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
Valid Usage (Implicit)
  • sType must be STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR
  • pNext must be NULL
  • 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();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • STYPE

      public static final int STYPE
      The struct member offsets.

    • PNEXT

      public static final int PNEXT
      The struct member offsets.

    • FLAGS

      public static final int FLAGS
      The struct member offsets.

    • DISPLAYMODE

      public static final int DISPLAYMODE
      The struct member offsets.

    • PLANEINDEX

      public static final int PLANEINDEX
      The struct member offsets.

    • PLANESTACKINDEX

      public static final int PLANESTACKINDEX
      The struct member offsets.

    • TRANSFORM

      public static final int TRANSFORM
      The struct member offsets.

    • GLOBALALPHA

      public static final int GLOBALALPHA
      The struct member offsets.

    • ALPHAMODE

      public static final int ALPHAMODE
      The struct member offsets.

    • IMAGEEXTENT

      public static final int IMAGEEXTENT
      The struct member offsets.

  • Constructor Details

    • VkDisplaySurfaceCreateInfoKHR

      public VkDisplaySurfaceCreateInfoKHR(ByteBuffer container)
      Creates a VkDisplaySurfaceCreateInfoKHR instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

      The created instance holds a strong reference to the container object.

  • Method Details