Skip to content

Commit

Permalink
Clarify arguments to FlutterEngineOnVsync (flutter#8093)
Browse files Browse the repository at this point in the history
  • Loading branch information
chinmaygarde authored Mar 9, 2019
1 parent 718329c commit 03d5f3c
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions shell/platform/embedder/embedder.h
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 03d5f3c

Please sign in to comment.