Vulkan-Docs/doc/specs/vulkan/man/vkAcquireNextImageKHR.txt

47 lines
1.1 KiB
Plaintext

vkAcquireNextImageKHR(3)
=======================
Name
----
vkAcquireNextImageKHR - retrieve the index of the next available presentable image.
C Specification
---------------
include::../protos/vkAcquireNextImageKHR.txt[]
Parameters
----------
pname:device::
The VkDevice associated with the swapchain.
pname:swapchain::
The swapchain from which an image is being acquired.
pname:timeout::
Indicates how long the function waits, in nanoseconds.
pname:semaphore::
A VkSemaphore that will become signaled when the presentation engine has released ownership of the image.
pname:fence::
A VkFence that will become signaled when the presentation engine has released ownership of the image.
pname:pImageIndex::
A pointer to an integer that is set to the index of the next image to use.
Description
-----------
fname:vkAcquireNextImageKHR acquires the next image from the swapchain.
include::../validity/protos/vkAcquireNextImageKHR.txt[]
See Also
--------
flink:vkGetSwapchainImagesKHR
include::footer.txt[]