Flutter macOS Embedder
FlutterVSyncWaiter Class Reference

#import <FlutterVSyncWaiter.h>

Inheritance diagram for FlutterVSyncWaiter:

Instance Methods

(instancetype) - initWithDisplayLink:block:
 
(void) - waitForVSync:
 
(void) - invalidate
 

Detailed Description

Definition at line 12 of file FlutterVSyncWaiter.h.

Method Documentation

◆ initWithDisplayLink:block:

- (instancetype) initWithDisplayLink: (FlutterDisplayLink*)  displayLink
block: (void(^)(CFTimeInterval timestamp, CFTimeInterval targetTimestamp, uintptr_t baton))  block 

Creates new waiter instance tied to provided NSView. This function must be called on the main thread.

Provided |block| will be invoked on main thread.

Definition at line 48 of file FlutterVSyncWaiter.mm.

51  :(FlutterDisplayLink*)displayLink
52  block:(void (^)(CFTimeInterval timestamp,
53  CFTimeInterval targetTimestamp,
54  uintptr_t baton))block {
55  FML_DCHECK([NSThread isMainThread]);
56  if (self = [super init]) {
57  _block = block;
58 
59  _displayLink = displayLink;
60  _displayLink.delegate = self;
61  // Get at least one callback to initialize _lastTargetTimestamp.
62  _displayLink.paused = NO;
63  _warmUpFrame = YES;
64  }
FlutterDisplayLink * _displayLink
void(^ _block)(CFTimeInterval, CFTimeInterval, uintptr_t)
BOOL _warmUpFrame

◆ invalidate

- (void) invalidate

Invalidates the waiter. This must be called on the main thread before the instance is deallocated.

Definition at line 48 of file FlutterVSyncWaiter.mm.

159  {
160  // It is possible that there is pending vsync request while the view for which
161  // this waiter belongs is being destroyed. In that case trigger the vsync
162  // immediately to avoid deadlock.
163  if (_pendingBaton.has_value()) {
164  CFTimeInterval now = CACurrentMediaTime();
165  _block(now, now, _pendingBaton.value());
166  _pendingBaton = std::nullopt;
167  }
168 
169  [_displayLink invalidate];

Referenced by TEST_F().

◆ waitForVSync:

- (void) waitForVSync: (uintptr_t)  baton

Schedules |baton| to be signaled on next display refresh. This function must be called on the main thread.

Definition at line 48 of file FlutterVSyncWaiter.mm.

102  :(uintptr_t)baton {
103  FML_DCHECK([NSThread isMainThread]);
104  // CVDisplayLink start -> callback latency is two frames, there is
105  // no need to delay the warm-up frame.
106  if (_warmUpFrame) {
107  _warmUpFrame = NO;
108  TRACE_VSYNC("WarmUpFrame", baton);
109  CFTimeInterval now = CACurrentMediaTime();
110  _block(now, now, baton);
111  return;
112  }
113 
114  if (_pendingBaton.has_value()) {
115  [FlutterLogger logWarning:@"Engine requested vsync while another was pending"];
116  _block(0, 0, *_pendingBaton);
117  _pendingBaton = std::nullopt;
118  }
119 
120  TRACE_VSYNC("VSyncRequest", _pendingBaton.value_or(0));
121 
122  CFTimeInterval tick_interval = _displayLink.nominalOutputRefreshPeriod;
123  if (_displayLink.paused || tick_interval == 0 || _lastTargetTimestamp == 0) {
124  // When starting display link the first notification will come in the middle
125  // of next frame, which would incur a whole frame period of latency.
126  // To avoid that, first vsync notification will be fired using a timer
127  // scheduled to fire where the next frame is expected to start.
128  // Also use a timer if display link does not belong to any display
129  // (nominalOutputRefreshPeriod being 0)
130 
131  // Start of the vsync interval.
132  CFTimeInterval start = CACurrentMediaTime();
133 
134  // Timer delay is calculated as the time to the next frame start.
135  CFTimeInterval delay = 0;
136 
137  if (tick_interval != 0 && _lastTargetTimestamp != 0) {
138  CFTimeInterval phase = fmod(_lastTargetTimestamp, tick_interval);
139  CFTimeInterval now = start;
140  start = now - (fmod(now, tick_interval)) + phase;
141  if (start < now) {
142  start += tick_interval;
143  }
144  delay = std::max(start - now - kTimerLatencyCompensation, 0.0);
145  }
146 
147  [FlutterRunLoop.mainRunLoop performAfterDelay:delay
148  block:^{
149  CFTimeInterval targetTime = start + tick_interval;
150  TRACE_VSYNC("SynthesizedInitialVSync", baton);
151  _block(start, targetTime, baton);
152  }];
153  _displayLink.paused = NO;
154  } else {
155  _pendingBaton = baton;
static const CFTimeInterval kTimerLatencyCompensation
#define TRACE_VSYNC(event_type, baton)
CFTimeInterval _lastTargetTimestamp

Referenced by TEST_F().


The documentation for this class was generated from the following files: