Class VkDisplaySurfaceCreateInfoKHR

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer

    public class VkDisplaySurfaceCreateInfoKHR
    extends Struct
    implements NativeResource
    Structure specifying parameters of a newly created display plane surface object.

    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 0 or one of the bits present in the supportedAlpha member of VkDisplayPlaneCapabilitiesKHR returned by vkGetDisplayPlaneCapabilitiesKHR for the display plane corresponding to displayMode
    • The width and height members of imageExtent must be less than the maxImageDimensions2D member of VkPhysicalDeviceLimits
    Valid Usage (Implicit)
    • 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

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • flags – reserved for future use, and must be zero.
    • displayMode – a VkDisplayModeKHR handle specifying the mode to use when displaying this surface.
    • planeIndex – the plane on which this surface appears.
    • planeStackIndex – the z-order of the plane.
    • transform – a VkSurfaceTransformFlagBitsKHR value specifying the transformation to apply to images as part of the scanout operation.
    • globalAlpha – the global alpha value. This value is ignored if alphaMode is not DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR.
    • alphaMode – a VkDisplayPlaneAlphaFlagBitsKHR value specifying the type of alpha blending to use.
    • imageExtent – The size of the presentable images to use with the surface.


     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 Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.

        The struct member offsets.
    • Constructor Detail

      • VkDisplaySurfaceCreateInfoKHR

        public VkDisplaySurfaceCreateInfoKHR​(java.nio.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.