VSyncClient Class Reference

#import <vsync_waiter_ios.h>

Inheritance diagram for VSyncClient:

Instance Methods
(instancetype)	- initWithTaskRunner:callback:
(void)	- await
(void)	- pause
(void)	- invalidate
(double)	- getRefreshRate
(void)	- setMaxRefreshRate:

Properties
BOOL	allowPauseAfterVsync
	Default value is YES. Vsync client will pause vsync callback after receiving a vsync signal. Setting this property to NO can avoid this and vsync client will trigger vsync callback continuously. More...

Detailed Description

Definition at line 38 of file vsync_waiter_ios.h.

Method Documentation

await

- (void) await

Definition at line 107 of file vsync_waiter_ios.mm.

              {
  display_link_.get().paused = NO;
}

References display_link_.

getRefreshRate

- (double) getRefreshRate

Definition at line 148 of file vsync_waiter_ios.mm.

                         {
  return current_refresh_rate_;
}

References current_refresh_rate_.

initWithTaskRunner:callback:

- (instancetype) initWithTaskRunner:		(fml::RefPtr<fml::TaskRunner>)	task_runner
callback:		(flutter::VsyncWaiter::Callback)	callback

Definition at line 68 of file vsync_waiter_ios.mm.

                                  :(fml::RefPtr<fml::TaskRunner>)task_runner
                          callback:(flutter::VsyncWaiter::Callback)callback {
  self = [super init];
 
  if (self) {
    current_refresh_rate_ = [DisplayLinkManager displayRefreshRate];
    _allowPauseAfterVsync = YES;
    callback_ = std::move(callback);
    display_link_ = fml::scoped_nsobject<CADisplayLink> {
      [[CADisplayLink displayLinkWithTarget:self selector:@selector(onDisplayLink:)] retain]
    };
    display_link_.get().paused = YES;
 
    [self setMaxRefreshRate:[DisplayLinkManager displayRefreshRate]];
 
    task_runner->PostTask([client = [self retain]]() {
      [client->display_link_.get() addToRunLoop:[NSRunLoop currentRunLoop]
                                        forMode:NSRunLoopCommonModes];
      [client release];
    });
  }
 
  return self;
}

References current_refresh_rate_, display_link_, DisplayLinkManager::displayRefreshRate, and setMaxRefreshRate:.

invalidate

- (void) invalidate

Definition at line 138 of file vsync_waiter_ios.mm.

                   {
  [display_link_.get() invalidate];
}

pause

- (void) pause

Definition at line 111 of file vsync_waiter_ios.mm.

              {
  display_link_.get().paused = YES;
}

References display_link_.

setMaxRefreshRate:

- (void) setMaxRefreshRate:

(double)

refreshRate

Definition at line 93 of file vsync_waiter_ios.mm.

                         :(double)refreshRate {
  if (!DisplayLinkManager.maxRefreshRateEnabledOnIPhone) {
    return;
  }
  double maxFrameRate = fmax(refreshRate, 60);
  double minFrameRate = fmax(maxFrameRate / 2, 60);
  if (@available(iOS 15.0, *)) {
    display_link_.get().preferredFrameRateRange =
        CAFrameRateRangeMake(minFrameRate, maxFrameRate, maxFrameRate);
  } else {
    display_link_.get().preferredFramesPerSecond = maxFrameRate;
  }
}

References display_link_, and DisplayLinkManager::maxRefreshRateEnabledOnIPhone.

Referenced by initWithTaskRunner:callback:.

Property Documentation

allowPauseAfterVsync

- (BOOL) allowPauseAfterVsync

readwritenonatomicassign

Default value is YES. Vsync client will pause vsync callback after receiving a vsync signal. Setting this property to NO can avoid this and vsync client will trigger vsync callback continuously.

Parameters

allowPauseAfterVsync

Allow vsync client to pause after receiving a vsync signal.

Definition at line 48 of file vsync_waiter_ios.h.

---

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

• shell/platform/darwin/ios/framework/Source/vsync_waiter_ios.h
• shell/platform/darwin/ios/framework/Source/vsync_waiter_ios.mm