#include <vsync_waiter_ios.h>

Inheritance diagram for flutter::VsyncWaiterIOS:

Public Member Functions
	VsyncWaiterIOS (const flutter::TaskRunners &task_runners, FlutterDisplayLinkManager *display_link_manager)

	~VsyncWaiterIOS () override

double	GetRefreshRate () const override

void	AwaitVSync () override

double	GetMaxRefreshRateForTesting () const

Public Member Functions inherited from flutter::VsyncWaiter
virtual	~VsyncWaiter ()

void	AsyncWaitForVsync (const Callback &callback)

void	ScheduleSecondaryCallback (uintptr_t id, const fml::closure &callback)

Public Member Functions inherited from flutter::VariableRefreshRateReporter
	VariableRefreshRateReporter ()=default

	FML_DISALLOW_COPY_AND_ASSIGN (VariableRefreshRateReporter)

Static Public Member Functions
static CFTimeInterval	SnapDuration (CFTimeInterval duration, double max_refresh_rate)

Additional Inherited Members
Public Types inherited from flutter::VsyncWaiter
using	Callback = std::function< void(std::unique_ptr< FrameTimingsRecorder >)>

Protected Member Functions inherited from flutter::VsyncWaiter
	VsyncWaiter (const TaskRunners &task_runners)

virtual void	AwaitVSyncForSecondaryCallback ()

void	FireCallback (fml::TimePoint frame_start_time, fml::TimePoint frame_target_time, bool pause_secondary_tasks=true)

Protected Attributes inherited from flutter::VsyncWaiter
const TaskRunners	task_runners_

Detailed Description

Definition at line 19 of file vsync_waiter_ios.h.

Constructor & Destructor Documentation

◆ VsyncWaiterIOS()

flutter::VsyncWaiterIOS::VsyncWaiterIOS	(	const flutter::TaskRunners &	task_runners,
		FlutterDisplayLinkManager *	display_link_manager
	)

Definition at line 18 of file vsync_waiter_ios.mm.

    : VsyncWaiter(task_runners), display_link_manager_(display_link_manager) {
  FML_DCHECK(display_link_manager);
  auto vsyncCallback = ^(CFTimeInterval startTime, CFTimeInterval targetTime) {
    // Compute delay using the same CACurrentMediaTime() clock.
    CFTimeInterval delay = CACurrentMediaTime() - startTime;
    if (delay < 0.0) {
      delay = 0.0;
    }
 
    // Align the start time to the C++ steady_clock used by fml::TimePoint.
    fml::TimePoint start_time = fml::TimePoint::Now() - fml::TimeDelta::FromSecondsF(delay);
 
    // Snap to the nearest whole Hz value to avoid floating point errors.
    CFTimeInterval duration =
        VsyncWaiterIOS::SnapDuration(targetTime - startTime, max_refresh_rate_);
 
    // Align target time to the C++ steady_clock used by fml::TimePoint.
    fml::TimePoint target_time = start_time + fml::TimeDelta::FromSecondsF(duration);
    FireCallback(start_time, target_time, true);
  };
  FlutterFMLTaskRunner* uiTaskRunner =
      [[FlutterFMLTaskRunner alloc] initWithTaskRunner:task_runners_.GetUITaskRunner()];
  client_ = [[FlutterVSyncClient alloc]
                initWithTaskRunner:uiTaskRunner
      isVariableRefreshRateEnabled:display_link_manager_.maxRefreshRateEnabledOnIPhone
                    maxRefreshRate:display_link_manager_.displayRefreshRate
                          callback:vsyncCallback];
  max_refresh_rate_ = display_link_manager_.displayRefreshRate;
}

References callback, flutter::VsyncWaiter::FireCallback(), FML_DCHECK, fml::TimeDelta::FromSecondsF(), flutter::TaskRunners::GetUITaskRunner(), fml::TimePoint::Now(), SnapDuration(), and flutter::VsyncWaiter::task_runners_.

◆ ~VsyncWaiterIOS()

flutter::VsyncWaiterIOS::~VsyncWaiterIOS ( )

override

Definition at line 50 of file vsync_waiter_ios.mm.

                                {
  // This way, we will get no more callbacks from the display link that holds a weak (non-nilling)
  // reference to this C++ object.
  [client_ invalidate];
}

Member Function Documentation

◆ AwaitVSync()

void flutter::VsyncWaiterIOS::AwaitVSync ( )

overridevirtual

Implements flutter::VsyncWaiter.

Definition at line 56 of file vsync_waiter_ios.mm.

                                {
  double new_max_refresh_rate = display_link_manager_.displayRefreshRate;
  if (fabs(new_max_refresh_rate - max_refresh_rate_) > kRefreshRateDiffToIgnore) {
    max_refresh_rate_ = new_max_refresh_rate;
    [client_ setMaxRefreshRate:max_refresh_rate_];
  }
  [client_ await];
}

References kRefreshRateDiffToIgnore.

◆ GetMaxRefreshRateForTesting()

double flutter::VsyncWaiterIOS::GetMaxRefreshRateForTesting ( ) const

inline

Definition at line 45 of file vsync_waiter_ios.h.

45{ return max_refresh_rate_; }

◆ GetRefreshRate()

double flutter::VsyncWaiterIOS::GetRefreshRate ( ) const

overridevirtual

Implements flutter::VariableRefreshRateReporter.

Definition at line 66 of file vsync_waiter_ios.mm.

                                            {
  return client_.refreshRate;
}

◆ SnapDuration()

CFTimeInterval flutter::VsyncWaiterIOS::SnapDuration	(	CFTimeInterval	duration,
		double	max_refresh_rate
	)

static

Definition at line 70 of file vsync_waiter_ios.mm.

                                                                                            {
  if (duration > 0.0) {
    double roundedRefreshRate = round(1.0 / duration);
    return 1.0 / roundedRefreshRate;
  }
  double fallbackRefreshRate = max_refresh_rate > 0.0 ? max_refresh_rate : 60.0;
  return 1.0 / fallbackRefreshRate;
}

Referenced by VsyncWaiterIOS().

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members