VKDISPLAYPROPERTIESK(3)

NAME
VkDisplayPropertiesKHR - Structure describing an available display device

C SPECIFICATION

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;

MEMBERS

    • display is 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 is 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.

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

DESCRIPTION

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

VALID USAGE

    • display must be a valid VkDisplayKHR handle

    • displayName must be a null-terminated string

    • supportedTransforms must be a valid combination of VkSurfaceTransformFlagBitsKHR values

SEE ALSO

VkBool32, VkDisplayKHR, VkExtent2D, VkSurfaceTransformFlagsKHR, vkGetPhysicalDeviceDisplayPropertiesKHR

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkDisplayPropertiesKHR

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification,not directly.

COPYRIGHT

Copyright (c) 2014-2016 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.

AUTHOR

Khronos Group
    Author.