flutter::FlutterEngine Class Reference

#include <flutter_engine.h>

Inheritance diagram for flutter::FlutterEngine:

Public Member Functions
	FlutterEngine ()
virtual	~FlutterEngine ()
	FlutterEngine (FlutterEngine const &)=delete
FlutterEngine &	operator= (FlutterEngine const &)=delete
bool	Start (const std::string &icu_data_path, const std::string &assets_path, const std::vector< std::string > &arguments, const std::string &aot_library_path="")
void	ShutDown ()
void	RunEventLoopWithTimeout (std::chrono::milliseconds timeout=std::chrono::milliseconds::max())
FlutterDesktopPluginRegistrarRef	GetRegistrarForPlugin (const std::string &plugin_name) override
	FlutterEngine (const DartProject &project)
virtual	~FlutterEngine ()
	FlutterEngine (FlutterEngine const &)=delete
FlutterEngine &	operator= (FlutterEngine const &)=delete
bool	Run ()
bool	Run (const char *entry_point)
void	ShutDown ()
std::chrono::nanoseconds	ProcessMessages ()
void	ReloadSystemFonts ()
void	ReloadPlatformBrightness ()
FlutterDesktopPluginRegistrarRef	GetRegistrarForPlugin (const std::string &plugin_name) override
BinaryMessenger *	messenger ()
void	SetNextFrameCallback (std::function< void()> callback)
bool	IsPlatformThread () const
void	PostPlatformThreadTask (std::function< void()> callback)
std::optional< LRESULT >	ProcessExternalWindowMessage (HWND hwnd, UINT message, WPARAM wparam, LPARAM lparam)
bool	GetGraphicsAdapter (IDXGIAdapter **adapter_out)
Public Member Functions inherited from flutter::PluginRegistry
	PluginRegistry ()=default
virtual	~PluginRegistry ()=default
	PluginRegistry (PluginRegistry const &)=delete
PluginRegistry &	operator= (PluginRegistry const &)=delete

Friends
class	FlutterViewController

Detailed Description

Definition at line 21 of file flutter_engine.h.

Constructor & Destructor Documentation

FlutterEngine() [1/4]

FlutterEngine::FlutterEngine ( )

explicit

Definition at line 12 of file flutter_engine.cc.

{}

~FlutterEngine() [1/2]

FlutterEngine::~FlutterEngine ( )

virtual

Definition at line 14 of file flutter_engine.cc.

{}

FlutterEngine() [2/4]

flutter::FlutterEngine::FlutterEngine ( FlutterEngine const &  )

delete

FlutterEngine() [3/4]

FlutterEngine::FlutterEngine ( const DartProject &  project )

explicit

Definition at line 15 of file flutter_engine.cc.

                                                       {
  FlutterDesktopEngineProperties c_engine_properties = {};
  c_engine_properties.assets_path = project.assets_path().c_str();
  c_engine_properties.icu_data_path = project.icu_data_path().c_str();
  c_engine_properties.aot_library_path = project.aot_library_path().c_str();
  c_engine_properties.dart_entrypoint = project.dart_entrypoint().c_str();
  c_engine_properties.gpu_preference =
      static_cast<FlutterDesktopGpuPreference>(project.gpu_preference());
  c_engine_properties.ui_thread_policy =
      static_cast<FlutterDesktopUIThreadPolicy>(project.ui_thread_policy());
  c_engine_properties.accessibility_mode =
      static_cast<FlutterDesktopAccessibilityMode>(
          project.accessibility_mode());
  c_engine_properties.impeller_switch =
      static_cast<FlutterDesktopImpellerSwitch>(project.impeller_switch());
 
  const std::vector<std::string>& entrypoint_args =
      project.dart_entrypoint_arguments();
  std::vector<const char*> entrypoint_argv;
  std::transform(
      entrypoint_args.begin(), entrypoint_args.end(),
      std::back_inserter(entrypoint_argv),
      [](const std::string& arg) -> const char* { return arg.c_str(); });
 
  c_engine_properties.dart_entrypoint_argc =
      static_cast<int>(entrypoint_argv.size());
  c_engine_properties.dart_entrypoint_argv =
      entrypoint_argv.empty() ? nullptr : entrypoint_argv.data();
 
  engine_ = FlutterDesktopEngineCreate(&c_engine_properties);
 
  auto core_messenger = FlutterDesktopEngineGetMessenger(engine_);
  messenger_ = std::make_unique<BinaryMessengerImpl>(core_messenger);
}

References flutter::DartProject::accessibility_mode(), FlutterDesktopEngineProperties::accessibility_mode, FlutterDesktopEngineProperties::aot_library_path, FlutterDesktopEngineProperties::assets_path, flutter::DartProject::dart_entrypoint(), FlutterDesktopEngineProperties::dart_entrypoint, FlutterDesktopEngineProperties::dart_entrypoint_argc, flutter::DartProject::dart_entrypoint_arguments(), FlutterDesktopEngineProperties::dart_entrypoint_argv, FlutterDesktopEngineCreate(), FlutterDesktopEngineGetMessenger(), flutter::DartProject::gpu_preference(), FlutterDesktopEngineProperties::gpu_preference, FlutterDesktopEngineProperties::icu_data_path, flutter::DartProject::impeller_switch(), FlutterDesktopEngineProperties::impeller_switch, flutter::DartProject::ui_thread_policy(), and FlutterDesktopEngineProperties::ui_thread_policy.

~FlutterEngine() [2/2]

virtual flutter::FlutterEngine::~FlutterEngine ( )

virtual

FlutterEngine() [4/4]

flutter::FlutterEngine::FlutterEngine ( FlutterEngine const &  )

delete

Member Function Documentation

GetGraphicsAdapter()

bool flutter::FlutterEngine::GetGraphicsAdapter ( IDXGIAdapter **  adapter_out )

inline

Definition at line 110 of file flutter_engine.h.

                                                      {
    return FlutterDesktopEngineGetGraphicsAdapter(engine_, adapter_out);
  }

References FlutterDesktopEngineGetGraphicsAdapter().

GetRegistrarForPlugin() [1/2]

FlutterDesktopPluginRegistrarRef FlutterEngine::GetRegistrarForPlugin ( const std::string &  plugin_name )

overridevirtual

Implements flutter::PluginRegistry.

Definition at line 53 of file flutter_engine.cc.

                                  {
  if (!engine_) {
    std::cerr << "Cannot get plugin registrar on an engine that isn't running; "
                 "call Run first."
              << std::endl;
    return nullptr;
  }
  return FlutterDesktopGetPluginRegistrar(engine_.get(), plugin_name.c_str());
}

References FlutterDesktopGetPluginRegistrar().

GetRegistrarForPlugin() [2/2]

FlutterDesktopPluginRegistrarRef flutter::FlutterEngine::GetRegistrarForPlugin ( const std::string &  plugin_name )

overridevirtual

Implements flutter::PluginRegistry.

IsPlatformThread()

bool FlutterEngine::IsPlatformThread

(

)

const

Definition at line 113 of file flutter_engine.cc.

                                           {
  if (!engine_) {
    std::cerr
        << "Cannot check platform thread on an engine that failed creation."
        << std::endl;
    return false;
  }
  return FlutterDesktopEngineIsPlatformThread(engine_);
}

References FlutterDesktopEngineIsPlatformThread().

messenger()

BinaryMessenger * flutter::FlutterEngine::messenger ( )

inline

Definition at line 80 of file flutter_engine.h.

{ return messenger_.get(); }

Referenced by flutter::TEST().

operator=() [1/2]

FlutterEngine & flutter::FlutterEngine::operator= ( FlutterEngine const &  )

delete

References Start().

operator=() [2/2]

FlutterEngine & flutter::FlutterEngine::operator= ( FlutterEngine const &  )

delete

PostPlatformThreadTask()

void FlutterEngine::PostPlatformThreadTask

(

std::function< void()>

callback

)

Definition at line 123 of file flutter_engine.cc.

                                                                       {
  if (!callback) {
    return;
  }
  FlutterDesktopEnginePostPlatformThreadTask(
      engine_,
      /*callback=*/
      [](void* user_data) {
        std::unique_ptr<std::function<void()>> cb{
            static_cast<std::function<void()>*>(user_data)};
        (*cb)();
      },
      /*on_cancel=*/
      [](void* user_data) {
        delete static_cast<std::function<void()>*>(user_data);
      },
      /*user_data=*/new std::function<void()>(std::move(callback)));
}

References callback, FlutterDesktopEnginePostPlatformThreadTask(), and user_data.

ProcessExternalWindowMessage()

std::optional< LRESULT > FlutterEngine::ProcessExternalWindowMessage	(	HWND	hwnd,
		UINT	message,
		WPARAM	wparam,
		LPARAM	lparam
	)

Definition at line 142 of file flutter_engine.cc.

                   {
  LRESULT result;
  if (FlutterDesktopEngineProcessExternalWindowMessage(
          engine_, hwnd, message, wparam, lparam, &result)) {
    return result;
  }
  return std::nullopt;
}

References FlutterDesktopEngineProcessExternalWindowMessage(), and message.

Referenced by flutter::TEST().

ProcessMessages()

std::chrono::nanoseconds FlutterEngine::ProcessMessages

(

)

Definition at line 82 of file flutter_engine.cc.

                                                    {
  return std::chrono::nanoseconds(FlutterDesktopEngineProcessMessages(engine_));
}

References FlutterDesktopEngineProcessMessages().

Referenced by flutter::TEST().

ReloadPlatformBrightness()

void flutter::FlutterEngine::ReloadPlatformBrightness

(

)

ReloadSystemFonts()

void FlutterEngine::ReloadSystemFonts

(

)

Definition at line 86 of file flutter_engine.cc.

                                      {
  FlutterDesktopEngineReloadSystemFonts(engine_);
}

References FlutterDesktopEngineReloadSystemFonts().

Referenced by flutter::TEST().

Run() [1/2]

bool FlutterEngine::Run

(

)

Definition at line 54 of file flutter_engine.cc.

                        {
  return Run(nullptr);
}

References Run().

Referenced by Run(), flutter::TEST(), flutter::TEST(), and flutter::TEST().

Run() [2/2]

bool FlutterEngine::Run

(

const char *

entry_point

)

Definition at line 58 of file flutter_engine.cc.

                                               {
  if (!engine_) {
    std::cerr << "Cannot run an engine that failed creation." << std::endl;
    return false;
  }
  if (run_succeeded_) {
    std::cerr << "Cannot run an engine more than once." << std::endl;
    return false;
  }
  bool run_succeeded = FlutterDesktopEngineRun(engine_, entry_point);
  if (!run_succeeded) {
    std::cerr << "Failed to start engine." << std::endl;
  }
  run_succeeded_ = true;
  return run_succeeded;
}

References FlutterDesktopEngineRun().

RunEventLoopWithTimeout()

void FlutterEngine::RunEventLoopWithTimeout

(

std::chrono::milliseconds

timeout = std::chrono::milliseconds::max()

)

Definition at line 64 of file flutter_engine.cc.

                                                                         {
  if (!engine_) {
    std::cerr << "Cannot run event loop without a running engine; call "
                 "Run first."
              << std::endl;
    return;
  }
  uint32_t timeout_milliseconds;
  if (timeout == std::chrono::milliseconds::max()) {
    // The C API uses 0 to represent no timeout, so convert |max| to 0.
    timeout_milliseconds = 0;
  } else if (timeout.count() > UINT32_MAX) {
    timeout_milliseconds = UINT32_MAX;
  } else {
    timeout_milliseconds = static_cast<uint32_t>(timeout.count());
  }
  FlutterDesktopRunEngineEventLoopWithTimeout(engine_.get(),
                                              timeout_milliseconds);
}

References FlutterDesktopRunEngineEventLoopWithTimeout(), and UINT32_MAX.

Referenced by flutter::TEST().

SetNextFrameCallback()

void FlutterEngine::SetNextFrameCallback

(

std::function< void()>

callback

)

Definition at line 101 of file flutter_engine.cc.

                                                                     {
  next_frame_callback_ = std::move(callback);
  FlutterDesktopEngineSetNextFrameCallback(
      engine_,
      [](void* user_data) {
        FlutterEngine* self = static_cast<FlutterEngine*>(user_data);
        self->next_frame_callback_();
        self->next_frame_callback_ = nullptr;
      },
      this);
}

References callback, FlutterDesktopEngineSetNextFrameCallback(), self, and user_data.

Referenced by flutter::TEST().

ShutDown() [1/2]

void FlutterEngine::ShutDown

(

)

Definition at line 49 of file flutter_engine.cc.

                             {
  engine_ = nullptr;
}

Referenced by flutter::TEST().

ShutDown() [2/2]

void flutter::FlutterEngine::ShutDown

(

)

Start()

bool FlutterEngine::Start	(	const std::string &	icu_data_path,
		const std::string &	assets_path,
		const std::vector< std::string > &	arguments,
		const std::string &	aot_library_path = ""
	)

Definition at line 16 of file flutter_engine.cc.

                                                             {
  if (engine_) {
    std::cerr << "Cannot run an already running engine. Create a new instance "
                 "or call ShutDown first."
              << std::endl;
    return false;
  }
 
  FlutterDesktopEngineProperties c_engine_properties = {};
  c_engine_properties.assets_path = assets_path.c_str();
  c_engine_properties.icu_data_path = icu_data_path.c_str();
  c_engine_properties.aot_library_path = aot_library_path.c_str();
  std::vector<const char*> engine_switches;
  std::transform(
      arguments.begin(), arguments.end(), std::back_inserter(engine_switches),
      [](const std::string& arg) -> const char* { return arg.c_str(); });
  if (!engine_switches.empty()) {
    c_engine_properties.switches = &engine_switches[0];
    c_engine_properties.switches_count = engine_switches.size();
  }
 
  engine_ = UniqueEnginePtr(FlutterDesktopRunEngine(c_engine_properties),
                            FlutterDesktopShutDownEngine);
  if (!engine_) {
    std::cerr << "Failed to start engine." << std::endl;
    return false;
  }
  return true;
}

References FlutterDesktopEngineProperties::aot_library_path, FlutterDesktopEngineProperties::assets_path, FlutterDesktopRunEngine(), FlutterDesktopShutDownEngine(), FlutterDesktopEngineProperties::icu_data_path, FlutterDesktopEngineProperties::switches, and FlutterDesktopEngineProperties::switches_count.

Referenced by operator=(), flutter::TEST(), flutter::TEST(), and flutter::TEST().

Friends And Related Symbol Documentation

FlutterViewController

friend class FlutterViewController

friend

Definition at line 116 of file flutter_engine.h.

---

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

• shell/platform/glfw/client_wrapper/include/flutter/flutter_engine.h
• shell/platform/windows/client_wrapper/include/flutter/flutter_engine.h
• shell/platform/glfw/client_wrapper/flutter_engine.cc
• shell/platform/windows/client_wrapper/flutter_engine.cc