Package org.lwjgl.vulkan

Class VkDisplayPlaneCapabilitiesKHR

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkDisplayPlaneCapabilitiesKHR>
org.lwjgl.vulkan.VkDisplayPlaneCapabilitiesKHR
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkDisplayPlaneCapabilitiesKHR extends org.lwjgl.system.Struct<VkDisplayPlaneCapabilitiesKHR> implements org.lwjgl.system.NativeResource
Structure describing capabilities of a mode and plane combination.
Description

The minimum and maximum position and extent fields describe the implementation limits, if any, as they apply to the specified display mode and plane. Vendors may support displaying a subset of a swapchain’s presentable images on the specified display plane. This is expressed by returning minSrcPosition, maxSrcPosition, minSrcExtent, and maxSrcExtent values that indicate a range of possible positions and sizes which may be used to specify the region within the presentable images that source pixels will be read from when creating a swapchain on the specified display mode and plane.

Vendors may also support mapping the presentable images’ content to a subset or superset of the visible region in the specified display mode. This is expressed by returning minDstPosition, maxDstPosition, minDstExtent and maxDstExtent values that indicate a range of possible positions and sizes which may be used to describe the region within the display mode that the source pixels will be mapped to.

Other vendors may support only a 1-1 mapping between pixels in the presentable images and the display mode. This may be indicated by returning (0,0) for minSrcPosition, maxSrcPosition, minDstPosition, and maxDstPosition, and (display mode width, display mode height) for minSrcExtent, maxSrcExtent, minDstExtent, and maxDstExtent.

The value supportedAlpha must contain at least one valid VkDisplayPlaneAlphaFlagBitsKHR bit.

These values indicate the limits of the implementation’s individual fields. Not all combinations of values within the offset and extent ranges returned in VkDisplayPlaneCapabilitiesKHR are guaranteed to be supported. Presentation requests specifying unsupported combinations may fail.

See Also

VkDisplayPlaneCapabilities2KHR, VkExtent2D, VkOffset2D, GetDisplayPlaneCapabilitiesKHR

Layout


 struct VkDisplayPlaneCapabilitiesKHR {
     VkDisplayPlaneAlphaFlagsKHR supportedAlpha();
     VkOffset2D minSrcPosition();
     VkOffset2D maxSrcPosition();
     VkExtent2D minSrcExtent();
     VkExtent2D maxSrcExtent();
     VkOffset2D minDstPosition();
     VkOffset2D maxDstPosition();
     VkExtent2D minDstExtent();
     VkExtent2D maxDstExtent();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • SUPPORTEDALPHA

      public static final int SUPPORTEDALPHA
      The struct member offsets.

    • MINSRCPOSITION

      public static final int MINSRCPOSITION
      The struct member offsets.

    • MAXSRCPOSITION

      public static final int MAXSRCPOSITION
      The struct member offsets.

    • MINSRCEXTENT

      public static final int MINSRCEXTENT
      The struct member offsets.

    • MAXSRCEXTENT

      public static final int MAXSRCEXTENT
      The struct member offsets.

    • MINDSTPOSITION

      public static final int MINDSTPOSITION
      The struct member offsets.

    • MAXDSTPOSITION

      public static final int MAXDSTPOSITION
      The struct member offsets.

    • MINDSTEXTENT

      public static final int MINDSTEXTENT
      The struct member offsets.

    • MAXDSTEXTENT

      public static final int MAXDSTEXTENT
      The struct member offsets.

  • Constructor Details

    • VkDisplayPlaneCapabilitiesKHR

      public VkDisplayPlaneCapabilitiesKHR(ByteBuffer container)
      Creates a VkDisplayPlaneCapabilitiesKHR 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