From d969bc334f96d2d032ca653e4554cf864d9c987b Mon Sep 17 00:00:00 2001 From: Ryan Pavlik Date: Tue, 18 Jan 2022 14:18:32 -0600 Subject: [PATCH] a/util: More pacing documentation --- src/xrt/auxiliary/util/u_pacing.h | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/src/xrt/auxiliary/util/u_pacing.h b/src/xrt/auxiliary/util/u_pacing.h index 66152c7e7..26c2b9a59 100644 --- a/src/xrt/auxiliary/util/u_pacing.h +++ b/src/xrt/auxiliary/util/u_pacing.h @@ -258,20 +258,29 @@ struct u_pacing_app /*! * Mark a point on the frame's lifetime. * - * @param upa Render timing helper. + * @param upa Render timing helper. * @param[in] frame_id The frame ID to record for. + * @param[in] point The point/event to record + * @param[in] when_ns The timestamp + * * @see @ref frame-pacing. */ void (*mark_point)(struct u_pacing_app *upa, int64_t frame_id, enum u_timing_point point, uint64_t when_ns); /*! * When a frame has been discarded. + * + * @param upa Render timing helper. + * @param[in] frame_id The frame ID to mark as discarded. */ void (*mark_discarded)(struct u_pacing_app *upa, int64_t frame_id); /*! * A frame has been delivered from the client, see `xrEndFrame`. The GPU might * still be rendering the work. + * + * @param upa Render timing helper. + * @param[in] frame_id The frame ID to mark as delivered. */ void (*mark_delivered)(struct u_pacing_app *upa, int64_t frame_id);