flutter::VsyncWaiterEmbedder Class Reference

#include <vsync_waiter_embedder.h>

Inheritance diagram for flutter::VsyncWaiterEmbedder:

Public Types
using	VsyncCallback = std::function< void(intptr_t)>
Public Types inherited from flutter::VsyncWaiter
using	Callback = std::function< void(std::unique_ptr< FrameTimingsRecorder >)>

Public Member Functions
	VsyncWaiterEmbedder (const VsyncCallback &callback, const flutter::TaskRunners &task_runners)
	~VsyncWaiterEmbedder () override
Public Member Functions inherited from flutter::VsyncWaiter
virtual	~VsyncWaiter ()
void	AsyncWaitForVsync (const Callback &callback)
void	ScheduleSecondaryCallback (uintptr_t id, const fml::closure &callback)

Static Public Member Functions
static bool	OnEmbedderVsync (const flutter::TaskRunners &task_runners, intptr_t baton, fml::TimePoint frame_start_time, fml::TimePoint frame_target_time)

Private Member Functions
void	AwaitVSync () override

Additional Inherited Members
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 13 of file vsync_waiter_embedder.h.

Member Typedef Documentation

VsyncCallback

using flutter::VsyncWaiterEmbedder::VsyncCallback = std::function<void(intptr_t)>

Definition at line 15 of file vsync_waiter_embedder.h.

Constructor & Destructor Documentation

VsyncWaiterEmbedder()

flutter::VsyncWaiterEmbedder::VsyncWaiterEmbedder	(	const VsyncCallback &	callback,
		const flutter::TaskRunners &	task_runners
	)

Definition at line 9 of file vsync_waiter_embedder.cc.

    : VsyncWaiter(task_runners), vsync_callback_(vsync_callback) {
  FML_DCHECK(vsync_callback_);
}

~VsyncWaiterEmbedder()

flutter::VsyncWaiterEmbedder::~VsyncWaiterEmbedder ( )

overridedefault

Member Function Documentation

AwaitVSync()

void flutter::VsyncWaiterEmbedder::AwaitVSync ( )

overrideprivatevirtual

Implements flutter::VsyncWaiter.

Definition at line 19 of file vsync_waiter_embedder.cc.

                                     {
  auto* weak_waiter = new std::weak_ptr<VsyncWaiter>(shared_from_this());
  intptr_t baton = reinterpret_cast<intptr_t>(weak_waiter);
  vsync_callback_(baton);
}

OnEmbedderVsync()

bool flutter::VsyncWaiterEmbedder::OnEmbedderVsync ( const flutter::TaskRunners &  task_runners, intptr_t  baton, fml::TimePoint  frame_start_time, fml::TimePoint  frame_target_time  )

static

Definition at line 26 of file vsync_waiter_embedder.cc.

                                    {
  if (baton == 0) {
    return false;
  }
 
  // If the time here is in the future, the contract for `FlutterEngineOnVsync`
  // says that the engine will only process the frame when the time becomes
  // current.
  task_runners.GetUITaskRunner()->PostTaskForTime(
      [frame_start_time, frame_target_time, baton]() {
        std::weak_ptr<VsyncWaiter>* weak_waiter =
            reinterpret_cast<std::weak_ptr<VsyncWaiter>*>(baton);
        auto vsync_waiter = weak_waiter->lock();
        delete weak_waiter;
        if (vsync_waiter) {
          vsync_waiter->FireCallback(frame_start_time, frame_target_time);
        }
      },
      frame_start_time);
 
  return true;
}

---

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

• shell/platform/embedder/vsync_waiter_embedder.h
• shell/platform/embedder/vsync_waiter_embedder.cc