VKGETDISPLAYPLANECAP(3)

NAME
vkGetDisplayPlaneCapabilitiesKHR - get the capabilities of a mode and plane combination.

C SPECIFICATION

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

PARAMETERS

physicalDevice
    The physical device associated with the display.

mode
    The display mode the application intends to program when using the specified plane.

planeIndex
    The plane which the application intends to use with the display.

pCapabilities
    A pointer to a VkDisplayPlaneCapabilitiesKHR struct.

DESCRIPTION

vkGetDisplayPlaneCapabilitiesKHR gets the capabilities of a plane and its mode.

pCapabilities is an instance of the VkDisplayPlaneCapabilitiesKHR structure, the definition of which is:

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

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

vkCreateDisplayPlaneSurfaceKHR

COPYRIGHT

Copyright © 2014-2016 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.

AUTHOR

Khronos Group
    Author.