VKGETPHYSICALDEVICES(3)

NAME
vkGetPhysicalDeviceSurfaceSupportKHR - query if presentation is supported.

C SPECIFICATION

    VkResult vkGetPhysicalDeviceSurfaceSupportKHR(
        VkPhysicalDevice                            physicalDevice,
        uint32_t                                    queueFamilyIndex,
        VkSurfaceKHR                                surface,
        VkBool32*                                   pSupported);

PARAMETERS

physicalDevice
    A valid physical device.

queueFamilyIndex
    A queue family.

surface
    The surface to query.

pSupported
    Indicates is presentation is supported.

DESCRIPTION

vkGetPhysicalDeviceSurfaceSupportKHR determines whether a queue family of a physical device supports presentation to a given surface.

VALID USAGE

    • physicalDevice must be a valid VkPhysicalDevice handle

    • surface must be a valid VkSurfaceKHR handle

    • pSupported must be a pointer to a VkBool32 value

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

    • queueFamilyIndex must be less than pQueueFamilyPropertyCount returned by vkGetPhysicalDeviceQueueFamilyProperties for the given physicalDevice

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

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