Skip to content

Commit 03d5f3c

Browse files
authored
Clarify arguments to FlutterEngineOnVsync (flutter#8093)
1 parent 718329c commit 03d5f3c

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

shell/platform/embedder/embedder.h

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -654,12 +654,16 @@ FlutterEngineResult FlutterEngineDispatchSemanticsAction(
654654
// platform via the vsync callback must be returned. This call must be made on
655655
// the thread on which the call to |FlutterEngineRun| was made.
656656
//
657-
// |frame_start_time_nanos| is the point at which the vsync event occurred.
657+
// |frame_start_time_nanos| is the point at which the vsync event occurred or
658+
// will occur. If the time point is in the future, the engine will wait till
659+
// that point to begin its frame workload. The system monotonic clock is used as
660+
// the timebase.
661+
//
658662
// |frame_target_time_nanos| is the point at which the embedder anticipates the
659663
// next vsync to occur. This is a hint the engine uses to schedule Dart VM
660664
// garbage collection in periods in which the various threads are most likely to
661665
// be idle. For example, for a 60Hz display, embedders should add 16.6 * 1e6 to
662-
// the frame time field.
666+
// the frame time field. The system monotonic clock is used as the timebase.
663667
FLUTTER_EXPORT
664668
FlutterEngineResult FlutterEngineOnVsync(FlutterEngine engine,
665669
intptr_t baton,

0 commit comments

Comments
 (0)