mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2025-01-01 04:36:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

xrt: Clarify that wait_image timeout is nanoseconds

Browse source
This commit is contained in:
Ryan Pavlik 2022-05-17 13:17:14 -05:00 committed by Jakob Bornecrantz
parent f29d327a1a
commit 753f37c41f
1 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
src/xrt/include/xrt/xrt_compositor.h
View file

@ -407,9 +407,16 @@ struct xrt_swapchain
xrt_result_t (*acquire_image)(struct xrt_swapchain *xsc, uint32_t *out_index);
/*!
* See xrWaitSwapchainImage, state tracker needs to track index.
* Wait until image @p index is available for exclusive use, or until @p timeout_ns expires.
*
* See xrWaitSwapchainImage, which is the basis for this API.
* The state tracker needs to track image index, which should have come from @ref xrt_swapchain_acquire_image
* @param xsc Self pointer
* @param timeout_ns Timeout in nanoseconds,
* @param index Image index to wait for.
*/
xrt_result_t (*wait_image)(struct xrt_swapchain *xsc, uint64_t timeout, uint32_t index);
xrt_result_t (*wait_image)(struct xrt_swapchain *xsc, uint64_t timeout_ns, uint32_t index);
/*!
* See xrReleaseSwapchainImage, state tracker needs to track index.