VulkanHub
Function Prototype

vkGetPhysicalDeviceSurfaceSupportKHR

Query if presentation is supported

To determine whether a queue family of a physical device supports presentation to a given surface, call:

VkResult vkGetPhysicalDeviceSurfaceSupportKHR(
    VkPhysicalDevice physicalDevice,
    uint32_t queueFamilyIndex,
    VkSurfaceKHR surface,
    VkBool32* pSupported);
  • physicalDevice is the physical device.
  • queueFamilyIndex is the queue family.
  • surface is the surface.
  • pSupported is a pointer to a VkBool32. VK_TRUE indicates support, and VK_FALSE indicates no support.

Valid Usage

VUID-vkGetPhysicalDeviceSurfaceSupportKHR-queueFamilyIndex-01269

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

Valid Usage (Implicit)

VUID-vkGetPhysicalDeviceSurfaceSupportKHR-physicalDevice-parameter

physicalDevice must be a valid VkPhysicalDevice handle

VUID-vkGetPhysicalDeviceSurfaceSupportKHR-surface-parameter

surface must be a valid VkSurfaceKHR handle

VUID-vkGetPhysicalDeviceSurfaceSupportKHR-pSupported-parameter

pSupported must be a valid pointer to a VkBool32 value

VUID-vkGetPhysicalDeviceSurfaceSupportKHR-commonparent

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