vkGetPhysicalDeviceSurfaceSupportKHR(3)

# vkGetPhysicalDeviceSurfaceSupportKHR(3) Manual Page

## Name

vkGetPhysicalDeviceSurfaceSupportKHR - Query if presentation is supported

## C Specification

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);

## Parameters

- `physicalDevice` is the physical device.

- `queueFamilyIndex` is the queue family.

- `surface` is the surface.

- `pSupported` is a pointer to a `VkBool32`, which is set to `VK_TRUE` to indicate support, and `VK_FALSE` otherwise.

## Description

Valid Usage

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

Valid Usage (Implicit)

- `physicalDevice` must be a valid `VkPhysicalDevice` handle

- `surface` must be a valid `VkSurfaceKHR` handle

- `pSupported` must be a valid pointer to a `VkBool32` value

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

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

`VkBool32`, VkPhysicalDevice, VkSurfaceKHR

## Document Notes

For more information, see the Vulkan Specification

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

## Copyright

Copyright (c) 2014-2019 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.