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.
    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
    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

    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.

    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;
     }