Class VkDisplayPropertiesKHR

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

    public class VkDisplayPropertiesKHR
    extends Struct
    implements NativeResource
    Structure describing an available display device.

    Member documentation

    • display – a handle that is used to refer to the display described here. This handle will be valid for the lifetime of the Vulkan instance.
    • displayName – a pointer to a NULL-terminated string containing the name of the display. Generally, this will be the name provided by the display’s EDID. It can be NULL if no suitable name is available. If not NULL, the memory it points to must remain accessible as long as display is valid.
    • physicalDimensions – describes the physical width and height of the visible portion of the display, in millimeters.
    • physicalResolution – describes the physical, native, or preferred resolution of the display.
      Note

      For devices which have no natural value to return here, implementations should return the maximum resolution supported.

    • supportedTransforms – tells which transforms are supported by this display. This will contain one or more of the bits from VkSurfaceTransformFlagsKHR.
    • planeReorderPossible – tells whether the planes on this display can have their z order changed. If this is TRUE, the application can re-arrange the planes on this display in any order relative to each other.
    • persistentContent – tells whether the display supports self-refresh/internal buffering. If this is true, the application can submit persistent present operations on swapchains created against this display.
      Note

      Persistent presents may have higher latency, and may use less power when the screen content is updated infrequently, or when only a portion of the screen needs to be updated in most frames.

    Layout

    
     struct VkDisplayPropertiesKHR {
         VkDisplayKHR display;
         char const * displayName;
         VkExtent2D physicalDimensions;
         VkExtent2D physicalResolution;
         VkSurfaceTransformFlagsKHR supportedTransforms;
         VkBool32 planeReorderPossible;
         VkBool32 persistentContent;
     }