VKGETPHYSICALDEVICES(3)

NAME
vkGetPhysicalDeviceSurfacePresentModesKHR - get supported presentation modes.

C SPECIFICATION

    VkResult vkGetPhysicalDeviceSurfacePresentModesKHR(
        VkPhysicalDevice                            physicalDevice,
        VkSurfaceKHR                                surface,
        uint32_t*                                   pPresentModeCount,
        VkPresentModeKHR*                           pPresentModes);

PARAMETERS

physicalDevice
    A valid physical device.

surface
    The VkSurface to query.

pPresentModeCount
    The number of elements in the array pointed by pPresentModes.

pPresentModes
    Pointer to an array of VkPresentModeKHR.

DESCRIPTION

vkCreateWaylandSurfaceKHR queries the supported presentation modes for a surface.

pPresentModes is an instance of the VkPresentModeKHR structure, the definition of which is:

VALID USAGE

    • physicalDevice must be a valid VkPhysicalDevice handle

    • surface must be a valid VkSurfaceKHR handle

    • pPresentModeCount must be a pointer to a uint32_t value

    • If the value referenced by pPresentModeCount is not 0, and pPresentModes is not NULL, pPresentModes must be a pointer to an array of pPresentModeCount VkPresentModeKHR values

    • Each of physicalDevice and surface must have been created, allocated or retrieved from the same VkInstance

RETURN CODES

On success, this command returns

        • VK_SUCCESS

        • VK_INCOMPLETE

On failure, this command returns

        • VK_ERROR_OUT_OF_HOST_MEMORY

        • VK_ERROR_OUT_OF_DEVICE_MEMORY

        • VK_ERROR_SURFACE_LOST_KHR

SEE ALSO

vkQueuePresentKHR

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.