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

xrt: Clarify call order on some compositor functions

Browse source
This commit is contained in:
Jakob Bornecrantz 2022-01-15 00:05:01 +00:00
parent c272549802
commit f0e27a88a3
1 changed files with 32 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -701,9 +701,15 @@ struct xrt_compositor
* @ref wait_frame. * @ref wait_frame.
* *
* The only requirement on the compositor for the @p frame_id * The only requirement on the compositor for the @p frame_id
* is that it is a positive number. * is that it is a positive number and larger then the last returned
* frame_id.
* *
* @param[out] xc The compositor * After a call to predict_frame, the state tracker is not allowed to
* call this function until after a call to @ref mark_frame (with point
* @ref XRT_COMPOSITOR_FRAME_POINT_WOKE), followed by either
* @ref begin_frame or @ref discard_frame.
*
* @param[in] xc The compositor
* @param[out] out_frame_id Frame id * @param[out] out_frame_id Frame id
* @param[out] out_wake_time_ns When we want the client to be awoken to begin rendering. * @param[out] out_wake_time_ns When we want the client to be awoken to begin rendering.
* @param[out] out_predicted_gpu_time_ns When we expect the client to finish the GPU work. * @param[out] out_predicted_gpu_time_ns When we expect the client to finish the GPU work.
@ -721,8 +727,13 @@ struct xrt_compositor
* This function and @ref predict_frame function calls are a alternative to * This function and @ref predict_frame function calls are a alternative to
* @ref wait_frame. * @ref wait_frame.
* *
* The client calls this function to mark that it woke up from waiting * If point is XRT_COMPOSITOR_FRAME_POINT_WOKE it is to mark that the
* on a frame. * client woke up from waiting on a frame.
*
* @param[in] xc The compositor
* @param[in] frame_id Frame id
* @param[in] point What type of frame point to mark.
* @param[in] when_ns When this point happened.
*/ */
xrt_result_t (*mark_frame)(struct xrt_compositor *xc, xrt_result_t (*mark_frame)(struct xrt_compositor *xc,
int64_t frame_id, int64_t frame_id,
@ -732,8 +743,17 @@ struct xrt_compositor
/*! /*!
* See xrWaitFrame. * See xrWaitFrame.
* *
* This function has the same semantics as calling @ref predict_frame
* sleeping and then calling @ref mark_frame with a point of
* XRT_COMPOSITOR_FRAME_POINT_WOKE.
*
* The only requirement on the compositor for the @p frame_id * The only requirement on the compositor for the @p frame_id
* is that it is a positive number. * is that it is a positive number and larger then the last returned
* @p frame_id.
*
* After a call to wait_frame, the state tracker is not allowed to call
* this function until after a call to either @ref begin_frame or
* @ref discard_frame.
* *
* If the caller can do its own blocking, use the pair of functions * If the caller can do its own blocking, use the pair of functions
* xrt_compositor::predict_frame and xrt_compositor::mark_frame instead * xrt_compositor::predict_frame and xrt_compositor::mark_frame instead
@ -746,6 +766,13 @@ struct xrt_compositor
/*! /*!
* See xrBeginFrame. * See xrBeginFrame.
*
* Must have made a call to either @ref predict_frame or @ref wait_frame
* before calling this function. After this function is called you must
* call layer_commit.
*
* @param[in] xc The compositor
* @param[in] frame_id Frame id
*/ */
xrt_result_t (*begin_frame)(struct xrt_compositor *xc, int64_t frame_id); xrt_result_t (*begin_frame)(struct xrt_compositor *xc, int64_t frame_id);