VKGETPHYSICALDEVICES(3)

NAME
vkGetPhysicalDeviceSurfaceCapabilitiesKHR - Query surface capabilities

C SPECIFICATION

To query the basic capabilities of a surface, needed in order to create a swapchain, call:

    VkResult vkGetPhysicalDeviceSurfaceCapabilitiesKHR(
        VkPhysicalDevice                            physicalDevice,
        VkSurfaceKHR                                surface,
        VkSurfaceCapabilitiesKHR*                   pSurfaceCapabilities);

PARAMETERS

    • physicalDevice is the physical device that will be associated with the swapchain to be created, as described for vkCreateSwapchainKHR.

    • surface is the surface that will be associated with the swapchain.

    • pSurfaceCapabilities is a pointer to an instance of the VkSurfaceCapabilitiesKHR structure in which the capabilities are returned.

DESCRIPTION

VALID USAGE

    • physicalDevice must be a valid VkPhysicalDevice handle

    • surface must be a valid VkSurfaceKHR handle

    • pSurfaceCapabilities must be a pointer to a VkSurfaceCapabilitiesKHR structure

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

VkPhysicalDevice, VkSurfaceCapabilitiesKHR, VkSurfaceKHR

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.