Structures
VkDisplayPropertiesKHR
Structure describing an available display device
The VkDisplayPropertiesKHR structure is defined as:
typedef struct VkDisplayPropertiesKHR {
VkDisplayKHR display;
const char* displayName;
VkExtent2D physicalDimensions;
VkExtent2D physicalResolution;
VkSurfaceTransformFlagsKHR supportedTransforms;
VkBool32 planeReorderPossible;
VkBool32 persistentContent;
} VkDisplayPropertiesKHR;
pub struct DisplayPropertiesKHR {
display: vk::DisplayKHR, // Handle of the display object
display_name: *const c_char, // Name of the display
physical_dimensions: vk::Extent2D, // In millimeters?
physical_resolution: vk::Extent2D, // Max resolution for CRT?
supported_transforms: vk::SurfaceTransformFlagsKHR, // one or more bits from VkSurfaceTransformFlagsKHR
plane_reorder_possible: vk::Bool32, // VK_TRUE if the overlay plane's z-order can be changed on this display.
persistent_content: vk::Bool32, // VK_TRUE if this is a "smart" display that supports self-refresh/internal buffering.
}
displayis a handle that is used to refer to the display described here. This handle will be valid for the lifetime of the Vulkan instance.displayNameisNULLor a pointer to a null-terminated UTF-8 string containing the name of the display. Generally, this will be the name provided by the display’s EDID. IfNULL, no suitable name is available. If notNULL, the string pointed to must remain accessible and unmodified as long asdisplayis valid.physicalDimensionsdescribes the physical width and height of the visible portion of the display, in millimeters.physicalResolutiondescribes the physical, native, or preferred resolution of the display.
For devices which have no natural value to return here, implementations
should return the maximum resolution supported.
supportedTransformsis a bitmask of VkSurfaceTransformFlagBitsKHR describing which transforms are supported by this display.planeReorderPossibletells whether the planes on this display can have their z order changed. If this isVK_TRUE, the application can re-arrange the planes on this display in any order relative to each other.persistentContenttells 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.
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.
Parent
VK_KHR_displayType
Structures