VKGETDISPLAYPLANECAP(3)

NAME
vkGetDisplayPlaneCapabilitiesKHR - Query capabilities of a mode and plane combination

C SPECIFICATION

Applications that wish to present directly to a display must select which layer, or "plane" of the display they wish to target, and a mode to use with the display. Each display supports at least one plane. The capabilities of a given mode and plane combination are determined by calling:

    VkResult vkGetDisplayPlaneCapabilitiesKHR(
        VkPhysicalDevice                            physicalDevice,
        VkDisplayModeKHR                            mode,
        uint32_t                                    planeIndex,
        VkDisplayPlaneCapabilitiesKHR*              pCapabilities);

PARAMETERS

    • physicalDevice is the physical device associated with display

    • mode is the display mode the application intends to program when using the specified plane. Note this parameter also implicitly specifies a display.

    • planeIndex is the plane which the application intends to use with the display, and is less than the number of display planes supported by the device.

    • pCapabilities is a pointer to a VkDisplayPlaneCapabilitiesKHR structure in which the capabilities are returned.

DESCRIPTION

VALID USAGE

    • physicalDevice must be a valid VkPhysicalDevice handle

    • mode must be a valid VkDisplayModeKHR handle

    • pCapabilities must be a pointer to a VkDisplayPlaneCapabilitiesKHR structure

HOST SYNCHRONIZATION

    • Host access to mode must be externally synchronized

RETURN CODES

On success, this command returns

        • VK_SUCCESS

On failure, this command returns

        • VK_ERROR_OUT_OF_HOST_MEMORY

        • VK_ERROR_OUT_OF_DEVICE_MEMORY

SEE ALSO

VkDisplayModeKHR, VkDisplayPlaneCapabilitiesKHR, VkPhysicalDevice

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.