From c86e0a4daa7445267448adcccb24de9898b66ede Mon Sep 17 00:00:00 2001 From: Chinmay Garde Date: Fri, 8 Mar 2019 17:14:31 -0800 Subject: [PATCH] Clarify arguments to FlutterEngineOnVsync --- shell/platform/embedder/embedder.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/shell/platform/embedder/embedder.h b/shell/platform/embedder/embedder.h index bf2343ec6e728..2299650a68ebe 100644 --- a/shell/platform/embedder/embedder.h +++ b/shell/platform/embedder/embedder.h @@ -654,12 +654,16 @@ FlutterEngineResult FlutterEngineDispatchSemanticsAction( // platform via the vsync callback must be returned. This call must be made on // the thread on which the call to |FlutterEngineRun| was made. // -// |frame_start_time_nanos| is the point at which the vsync event occurred. +// |frame_start_time_nanos| is the point at which the vsync event occurred or +// will occur. If the time point is in the future, the engine will wait till +// that point to begin its frame workload. The system monotonic clock is used as +// the timebase. +// // |frame_target_time_nanos| is the point at which the embedder anticipates the // next vsync to occur. This is a hint the engine uses to schedule Dart VM // garbage collection in periods in which the various threads are most likely to // be idle. For example, for a 60Hz display, embedders should add 16.6 * 1e6 to -// the frame time field. +// the frame time field. The system monotonic clock is used as the timebase. FLUTTER_EXPORT FlutterEngineResult FlutterEngineOnVsync(FlutterEngine engine, intptr_t baton,