[mutter] clutter/timeline: Minor documentation corrections
- From: Marge Bot <marge-bot src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [mutter] clutter/timeline: Minor documentation corrections
- Date: Wed, 5 Jan 2022 16:34:18 +0000 (UTC)
commit 3de1696c59e810993ba9753d1ad36d02c9be34ab
Author: Daniel van Vugt <daniel van vugt canonical com>
Date: Wed Dec 15 17:25:39 2021 +0800
clutter/timeline: Minor documentation corrections
Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/2161>
clutter/clutter/clutter-timeline.c | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
---
diff --git a/clutter/clutter/clutter-timeline.c b/clutter/clutter/clutter-timeline.c
index afe087620f..0f5ddaede8 100644
--- a/clutter/clutter/clutter-timeline.c
+++ b/clutter/clutter/clutter-timeline.c
@@ -33,7 +33,7 @@
* be used to update the state of the actors.
*
* It is important to note that #ClutterTimeline is not a generic API for
- * calling closures after an interval; each Timeline is tied into the master
+ * calling closures after an interval; each Timeline is tied into a frame
* clock used to drive the frame cycle. If you need to schedule a closure
* after an interval, see clutter_threads_add_timeout() instead.
*
@@ -163,7 +163,7 @@ struct _ClutterTimelinePrivate
guint is_playing : 1;
/* If we've just started playing and haven't yet gotten
- * a tick from the master clock
+ * a tick from the frame clock
*/
guint waiting_first_tick : 1;
guint auto_reverse : 1;
@@ -1884,9 +1884,11 @@ _clutter_timeline_advance (ClutterTimeline *timeline,
* @tick_time: time of advance
*
* Advances @timeline based on the time passed in @tick_time. This
- * function is called by the master clock. The @timeline will use this
- * interval to emit the #ClutterTimeline::new-frame signal and
- * eventually skip frames.
+ * function is called by the frame clock and ideally passes the next
+ * presentation time in which consequences of our timeline will be visible.
+ * Otherwise an estimate using the current monotonic time is also acceptable.
+ * The @timeline will use this interval to emit the #ClutterTimeline::new-frame
+ * signal and eventually skip frames.
*/
void
_clutter_timeline_do_tick (ClutterTimeline *timeline,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]