_FlutterDisplayLink Class Reference

Inheritance diagram for _FlutterDisplayLink:

Instance Methods
(void)	- didFireWithTimestamp:targetTimestamp:
(instancetype)	- initWithView: [implementation]
(void)	- invalidate [implementation]
	Invalidates the display link. Must be called on the main thread. More...
(void)	- updateScreen [implementation]
(void)	- viewDidChangeWindow: [implementation]
(void)	- windowDidChangeScreen: [implementation]
(BOOL)	- paused [implementation]
(void)	- setPaused: [implementation]
(CFTimeInterval)	- nominalOutputRefreshPeriod [implementation]
(void)	- invalidate
	Invalidates the display link. Must be called on the main thread. More...

Protected Attributes
_FlutterDisplayLinkView *	_view
std::optional< CGDirectDisplayID >	_display_id
BOOL	_paused

Additional Inherited Members
Class Methods inherited from FlutterDisplayLink
(instancetype)	+ displayLinkWithView:
Properties inherited from FlutterDisplayLink
id< FlutterDisplayLinkDelegate >	delegate
BOOL	paused
	Pauses and resumes the display link. May be called from any thread. More...
CFTimeInterval	nominalOutputRefreshPeriod

Detailed Description

Definition at line 29 of file FlutterDisplayLink.mm.

Method Documentation

didFireWithTimestamp:targetTimestamp:

- (void) didFireWithTimestamp:		(CFTimeInterval)	timestamp
targetTimestamp:		(CFTimeInterval)	targetTimestamp

Definition at line 69 of file FlutterDisplayLink.mm.

                            :(CFTimeInterval)timestamp
             targetTimestamp:(CFTimeInterval)targetTimestamp {
  @synchronized(self) {
    if (!_paused) {
      id<FlutterDisplayLinkDelegate> delegate = _delegate;
      [delegate onDisplayLink:timestamp targetTimestamp:targetTimestamp];
    }
  }
}

initWithView:

- (instancetype) initWithView: (NSView*)  view

implementation

Definition at line 69 of file FlutterDisplayLink.mm.

                            :(NSView*)view {
  FML_DCHECK([NSThread isMainThread]);
  if (self = [super init]) {
    self->_view = [[_FlutterDisplayLinkView alloc] initWithFrame:CGRectZero];
    [view addSubview:self->_view];
    _paused = YES;
    [[NSNotificationCenter defaultCenter] addObserver:self
                                             selector:@selector(viewDidChangeWindow:)
                                                 name:kFlutterDisplayLinkViewDidMoveToWindow
                                               object:self->_view];
    [[NSNotificationCenter defaultCenter] addObserver:self
                                             selector:@selector(windowDidChangeScreen:)
                                                 name:NSWindowDidChangeScreenNotification
                                               object:nil];
    [self updateScreen];
  }
  return self;
}

invalidate

- (void) invalidate

implementation

Invalidates the display link. Must be called on the main thread.

Reimplemented from FlutterDisplayLink.

Definition at line 69 of file FlutterDisplayLink.mm.

                   {
  @synchronized(self) {
    FML_DCHECK([NSThread isMainThread]);
    // Unregister observer before removing the view to ensure
    // that the viewDidChangeWindow notification is not received
    // while in @synchronized block.
    [[NSNotificationCenter defaultCenter] removeObserver:self];
    [_view removeFromSuperview];
    _view = nil;
    _delegate = nil;
  }
  DisplayLinkManager::Instance().UnregisterDisplayLink(self);
}

nominalOutputRefreshPeriod

- (CFTimeInterval) nominalOutputRefreshPeriod

implementation

Definition at line 69 of file FlutterDisplayLink.mm.

                                             {
  CGDirectDisplayID display_id;
  @synchronized(self) {
    if (_display_id.has_value()) {
      display_id = *_display_id;
    } else {
      return 0;
    }
  }
  return DisplayLinkManager::Instance().GetNominalOutputPeriod(display_id);
}

paused

- (BOOL) paused

implementation

Definition at line 69 of file FlutterDisplayLink.mm.

               {
  @synchronized(self) {
    return _paused;
  }
}

setPaused:

- (void) setPaused: (BOOL)  paused

implementation

Definition at line 69 of file FlutterDisplayLink.mm.

                 :(BOOL)paused {
  @synchronized(self) {
    if (_paused == paused) {
      return;
    }
    _paused = paused;
  }
  DisplayLinkManager::Instance().PausedDidChange(self);
}

updateScreen

- (void) updateScreen

implementation

Definition at line 69 of file FlutterDisplayLink.mm.

                     {
  DisplayLinkManager::Instance().UnregisterDisplayLink(self);
  std::optional<CGDirectDisplayID> displayId;
  @synchronized(self) {
    NSScreen* screen = _view.window.screen;
    if (screen != nil) {
      // https://developer.apple.com/documentation/appkit/nsscreen/1388360-devicedescription?language=objc
      _display_id = (CGDirectDisplayID)[
          [[screen deviceDescription] objectForKey:@"NSScreenNumber"] unsignedIntValue];
    } else {
      _display_id = std::nullopt;
    }
    displayId = _display_id;
  }
  if (displayId.has_value()) {
    DisplayLinkManager::Instance().RegisterDisplayLink(self, *displayId);
  }
}

viewDidChangeWindow:

- (void) viewDidChangeWindow: (NSNotification*)  notification

implementation

Definition at line 69 of file FlutterDisplayLink.mm.

                           :(NSNotification*)notification {
  NSView* view = notification.object;
  if (_view == view) {
    [self updateScreen];
  }
}

windowDidChangeScreen:

- (void) windowDidChangeScreen: (NSNotification*)  notification

implementation

Definition at line 69 of file FlutterDisplayLink.mm.

                             :(NSNotification*)notification {
  NSWindow* window = notification.object;
  if (_view.window == window) {
    [self updateScreen];
  }
}

Member Data Documentation

_display_id

- (optional<CGDirectDisplayID>) _FlutterDisplayLink:

protected

Definition at line 31 of file FlutterDisplayLink.mm.

_paused

- (BOOL) _paused

protected

Definition at line 32 of file FlutterDisplayLink.mm.

_view

- (_FlutterDisplayLinkView*) _view

protected

Definition at line 30 of file FlutterDisplayLink.mm.

---

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

• shell/platform/darwin/macos/framework/Source/FlutterDisplayLink.mm