VKGETPHYSICALDEVICES(3)

NAME
vkGetPhysicalDeviceSurfacePresentModesKHR - Query supported presentation modes

C SPECIFICATION

To query the supported presentation modes for a surface, call:

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.

    • pPresentModeCount is a pointer to an integer related to the number of presentation modes available or queried, as described below.

    • pPresentModes is either NULL or a pointer to an array of VkPresentModeKHR structures.

DESCRIPTION

If pPresentModes is NULL, then the number of presentation modes supported for the given surface is returned in pPresentModeCount. Otherwise, pPresentModeCount must point to a variable set by the user to the number of elements in the pPresentModes array, and on return the variable is overwritten with the number of values actually written to pPresentModes. If the value of pPresentModeCount is less than the number of presentation modes supported, at most pPresentModeCount values will be written. If pPresentModeCount is smaller than the number of presentation modes supported for the given surface, VK_INCOMPLETE will be returned instead of VK_SUCCESS to indicate that not all the available values were returned.

SEE ALSO

VkPhysicalDevice, VkPresentModeKHR, VkSurfaceKHR

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.