flutter_runner::VsyncWaiter Class Reference

#include <vsync_waiter.h>

Inheritance diagram for flutter_runner::VsyncWaiter:

Public Member Functions
	VsyncWaiter (AwaitVsyncCallback await_vsync_callback, AwaitVsyncForSecondaryCallbackCallback await_vsync_for_secondary_callback_callback, flutter::TaskRunners task_runners)
	~VsyncWaiter () override
Public Member Functions inherited from flutter::VsyncWaiter
void	AsyncWaitForVsync (const Callback &callback)
void	ScheduleSecondaryCallback (uintptr_t id, const fml::closure &callback)

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)
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 27 of file vsync_waiter.h.

Constructor & Destructor Documentation

VsyncWaiter()

flutter_runner::VsyncWaiter::VsyncWaiter	(	AwaitVsyncCallback	await_vsync_callback,
		AwaitVsyncForSecondaryCallbackCallback	await_vsync_for_secondary_callback_callback,
		flutter::TaskRunners	task_runners
	)

Definition at line 21 of file vsync_waiter.cc.

    : flutter::VsyncWaiter(task_runners),
      await_vsync_callback_(await_vsync_callback),
      await_vsync_for_secondary_callback_callback_(
          await_vsync_for_secondary_callback_callback),
      weak_factory_ui_(nullptr),
      weak_factory_(this) {
  fire_callback_callback_ = [this](fml::TimePoint frame_start,
                                   fml::TimePoint frame_end) {
    task_runners_.GetUITaskRunner()->PostTaskForTime(
        [frame_start, frame_end, weak_this = weak_ui_]() {
          if (weak_this) {
            // Note: It is VERY important to set |pause_secondary_tasks| to
            // false, else Animator will almost immediately crash on Fuchsia.
            // FML_LOG(INFO) << "CRASH:: VsyncWaiter about to FireCallback";
            weak_this->FireCallback(frame_start, frame_end,
                                    /*pause_secondary_tasks*/ false);
          }
        },
        frame_start);
  };
 
  // Generate a WeakPtrFactory for use with the UI thread. This does not need
  // to wait on a latch because we only ever use the WeakPtrFactory on the UI
  // thread so we have ordering guarantees (see ::AwaitVSync())
  fml::TaskRunner::RunNowOrPostTask(
      task_runners_.GetUITaskRunner(), fml::MakeCopyable([this]() mutable {
        weak_factory_ui_ =
            std::make_unique<fml::WeakPtrFactory<VsyncWaiter>>(this);
        weak_ui_ = weak_factory_ui_->GetWeakPtr();
      }));
}

References flutter::TaskRunners::GetUITaskRunner(), fml::MakeCopyable(), fml::TaskRunner::PostTaskForTime(), fml::TaskRunner::RunNowOrPostTask(), and flutter::VsyncWaiter::task_runners_.

~VsyncWaiter()

flutter_runner::VsyncWaiter::~VsyncWaiter ( )

overridevirtual

Reimplemented from flutter::VsyncWaiter.

Definition at line 57 of file vsync_waiter.cc.

                          {
  fml::AutoResetWaitableEvent ui_latch;
  fml::TaskRunner::RunNowOrPostTask(
      task_runners_.GetUITaskRunner(),
      fml::MakeCopyable(
          [weak_factory_ui = std::move(weak_factory_ui_), &ui_latch]() mutable {
            weak_factory_ui.reset();
            ui_latch.Signal();
          }));
  ui_latch.Wait();
}

References flutter::TaskRunners::GetUITaskRunner(), fml::MakeCopyable(), fml::TaskRunner::RunNowOrPostTask(), flutter::VsyncWaiter::task_runners_, and fml::AutoResetWaitableEvent::Wait().

---

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

• shell/platform/fuchsia/flutter/vsync_waiter.h
• shell/platform/fuchsia/flutter/vsync_waiter.cc