#include <dxgi.h>
#include <stddef.h>
#include <stdint.h>
#include <windows.h>
#include "flutter_export.h"
#include "flutter_messenger.h"
#include "flutter_plugin_registrar.h"

Classes
struct	FlutterDesktopEngineProperties

Typedefs
typedef void(*	VoidCallback) (void *)

typedef struct FlutterDesktopViewController *	FlutterDesktopViewControllerRef

typedef struct FlutterDesktopView *	FlutterDesktopViewRef

typedef struct FlutterDesktopEngine *	FlutterDesktopEngineRef

typedef bool(*	FlutterDesktopWindowProcCallback) (HWND, UINT, WPARAM, LPARAM, void , LRESULT result)

Functions
FLUTTER_EXPORT FlutterDesktopViewControllerRef	FlutterDesktopViewControllerCreate (int width, int height, FlutterDesktopEngineRef engine)

FLUTTER_EXPORT void	FlutterDesktopViewControllerDestroy (FlutterDesktopViewControllerRef controller)

FLUTTER_EXPORT FlutterDesktopEngineRef	FlutterDesktopViewControllerGetEngine (FlutterDesktopViewControllerRef controller)

FLUTTER_EXPORT FlutterDesktopViewRef	FlutterDesktopViewControllerGetView (FlutterDesktopViewControllerRef controller)

FLUTTER_EXPORT void	FlutterDesktopViewControllerForceRedraw (FlutterDesktopViewControllerRef controller)

FLUTTER_EXPORT bool	FlutterDesktopViewControllerHandleTopLevelWindowProc (FlutterDesktopViewControllerRef controller, HWND hwnd, UINT message, WPARAM wparam, LPARAM lparam, LRESULT *result)

FLUTTER_EXPORT FlutterDesktopEngineRef	FlutterDesktopEngineCreate (const FlutterDesktopEngineProperties *engine_properties)

FLUTTER_EXPORT bool	FlutterDesktopEngineDestroy (FlutterDesktopEngineRef engine)

FLUTTER_EXPORT bool	FlutterDesktopEngineRun (FlutterDesktopEngineRef engine, const char *entry_point)

FLUTTER_EXPORT uint64_t	FlutterDesktopEngineProcessMessages (FlutterDesktopEngineRef engine)

FLUTTER_EXPORT void	FlutterDesktopEngineReloadSystemFonts (FlutterDesktopEngineRef engine)

FLUTTER_EXPORT FlutterDesktopPluginRegistrarRef	FlutterDesktopEngineGetPluginRegistrar (FlutterDesktopEngineRef engine, const char *plugin_name)

FLUTTER_EXPORT FlutterDesktopMessengerRef	FlutterDesktopEngineGetMessenger (FlutterDesktopEngineRef engine)

FLUTTER_EXPORT FlutterDesktopTextureRegistrarRef	FlutterDesktopEngineGetTextureRegistrar (FlutterDesktopEngineRef engine)

FLUTTER_EXPORT void	FlutterDesktopEngineSetNextFrameCallback (FlutterDesktopEngineRef engine, VoidCallback callback, void *user_data)

FLUTTER_EXPORT HWND	FlutterDesktopViewGetHWND (FlutterDesktopViewRef view)

FLUTTER_EXPORT IDXGIAdapter *	FlutterDesktopViewGetGraphicsAdapter (FlutterDesktopViewRef view)

FLUTTER_EXPORT bool	FlutterDesktopEngineProcessExternalWindowMessage (FlutterDesktopEngineRef engine, HWND hwnd, UINT message, WPARAM wparam, LPARAM lparam, LRESULT *result)

FLUTTER_EXPORT FlutterDesktopViewRef	FlutterDesktopPluginRegistrarGetView (FlutterDesktopPluginRegistrarRef registrar)

FLUTTER_EXPORT void	FlutterDesktopPluginRegistrarRegisterTopLevelWindowProcDelegate (FlutterDesktopPluginRegistrarRef registrar, FlutterDesktopWindowProcCallback delegate, void *user_data)

FLUTTER_EXPORT void	FlutterDesktopPluginRegistrarUnregisterTopLevelWindowProcDelegate (FlutterDesktopPluginRegistrarRef registrar, FlutterDesktopWindowProcCallback delegate)

FLUTTER_EXPORT UINT	FlutterDesktopGetDpiForHWND (HWND hwnd)

FLUTTER_EXPORT UINT	FlutterDesktopGetDpiForMonitor (HMONITOR monitor)

FLUTTER_EXPORT void	FlutterDesktopResyncOutputStreams ()

Typedef Documentation

◆ FlutterDesktopEngineRef

typedef struct FlutterDesktopEngine* FlutterDesktopEngineRef

Definition at line 33 of file flutter_windows.h.

◆ FlutterDesktopViewControllerRef

typedef struct FlutterDesktopViewController* FlutterDesktopViewControllerRef

Definition at line 25 of file flutter_windows.h.

◆ FlutterDesktopViewRef

typedef struct FlutterDesktopView* FlutterDesktopViewRef

Definition at line 29 of file flutter_windows.h.

◆ FlutterDesktopWindowProcCallback

typedef bool(* FlutterDesktopWindowProcCallback) (HWND, UINT, WPARAM, LPARAM, void *, LRESULT *result)

Definition at line 238 of file flutter_windows.h.

◆ VoidCallback

typedef void(* VoidCallback) (void *)

Definition at line 21 of file flutter_windows.h.

Function Documentation

◆ FlutterDesktopEngineCreate()

FLUTTER_EXPORT FlutterDesktopEngineRef FlutterDesktopEngineCreate ( const FlutterDesktopEngineProperties * engine_properties )

Definition at line 150 of file flutter_windows.cc.

                                                              {
   flutter::FlutterProjectBundle project(*engine_properties);
   auto engine = std::make_unique<flutter::FlutterWindowsEngine>(project);
   return HandleForEngine(engine.release());
 }

References HandleForEngine().

Referenced by flutter::FlutterEngine::FlutterEngine(), and flutter::testing::TEST().

◆ FlutterDesktopEngineDestroy()

FLUTTER_EXPORT bool FlutterDesktopEngineDestroy ( FlutterDesktopEngineRef engine )

Definition at line 157 of file flutter_windows.cc.

                                                                      {
   flutter::FlutterWindowsEngine* engine = EngineFromHandle(engine_ref);
   bool result = true;
   if (engine->running()) {
     result = engine->Stop();
   }
   delete engine;
   return result;
 }

References EngineFromHandle(), flutter::FlutterWindowsEngine::running(), and flutter::FlutterWindowsEngine::Stop().

Referenced by flutter::FlutterEngine::ShutDown(), and flutter::testing::TEST().

◆ FlutterDesktopEngineGetMessenger()

FLUTTER_EXPORT FlutterDesktopMessengerRef FlutterDesktopEngineGetMessenger ( FlutterDesktopEngineRef engine )

Definition at line 195 of file flutter_windows.cc.

                                     {
   return EngineFromHandle(engine)->messenger();
 }

References EngineFromHandle(), and flutter::FlutterWindowsEngine::messenger().

Referenced by flutter::FlutterEngine::FlutterEngine().

◆ FlutterDesktopEngineGetPluginRegistrar()

FLUTTER_EXPORT FlutterDesktopPluginRegistrarRef FlutterDesktopEngineGetPluginRegistrar	(	FlutterDesktopEngineRef	engine,
		const char *	plugin_name
	)

Definition at line 185 of file flutter_windows.cc.

                              {
   // Currently, one registrar acts as the registrar for all plugins, so the
   // name is ignored. It is part of the API to reduce churn in the future when
   // aligning more closely with the Flutter registrar system.
  
   return EngineFromHandle(engine)->GetRegistrar();
 }

References EngineFromHandle(), and flutter::FlutterWindowsEngine::GetRegistrar().

Referenced by flutter::FlutterEngine::GetRegistrarForPlugin().

◆ FlutterDesktopEngineGetTextureRegistrar()

FLUTTER_EXPORT FlutterDesktopTextureRegistrarRef FlutterDesktopEngineGetTextureRegistrar ( FlutterDesktopEngineRef engine )

Definition at line 200 of file flutter_windows.cc.

                                     {
   return HandleForTextureRegistrar(
       EngineFromHandle(engine)->texture_registrar());
 }

References EngineFromHandle(), and HandleForTextureRegistrar().

Referenced by flutter::testing::TEST().

◆ FlutterDesktopEngineProcessExternalWindowMessage()

FLUTTER_EXPORT bool FlutterDesktopEngineProcessExternalWindowMessage	(	FlutterDesktopEngineRef	engine,
		HWND	hwnd,
		UINT	message,
		WPARAM	wparam,
		LPARAM	lparam,
		LRESULT *	result
	)

Definition at line 233 of file flutter_windows.cc.

                      {
   std::optional<LRESULT> lresult =
       EngineFromHandle(engine)->ProcessExternalWindowMessage(hwnd, message,
                                                              wparam, lparam);
   if (result && lresult.has_value()) {
     *result = lresult.value();
   }
   return lresult.has_value();
 }

References EngineFromHandle(), message, and flutter::FlutterWindowsEngine::ProcessExternalWindowMessage().

Referenced by flutter::FlutterEngine::ProcessExternalWindowMessage().

◆ FlutterDesktopEngineProcessMessages()

FLUTTER_EXPORT uint64_t FlutterDesktopEngineProcessMessages ( FlutterDesktopEngineRef engine )

Definition at line 177 of file flutter_windows.cc.

                                                                              {
   return std::chrono::nanoseconds::max().count();
 }

Referenced by flutter::FlutterEngine::ProcessMessages().

◆ FlutterDesktopEngineReloadSystemFonts()

FLUTTER_EXPORT void FlutterDesktopEngineReloadSystemFonts ( FlutterDesktopEngineRef engine )

Definition at line 181 of file flutter_windows.cc.

                                                                            {
   EngineFromHandle(engine)->ReloadSystemFonts();
 }

References EngineFromHandle(), and flutter::FlutterWindowsEngine::ReloadSystemFonts().

Referenced by flutter::FlutterEngine::ReloadSystemFonts().

◆ FlutterDesktopEngineRun()

FLUTTER_EXPORT bool FlutterDesktopEngineRun	(	FlutterDesktopEngineRef	engine,
		const char *	entry_point
	)

Definition at line 167 of file flutter_windows.cc.

                                                       {
   std::string_view entry_point_view{""};
   if (entry_point != nullptr) {
     entry_point_view = entry_point;
   }
  
   return EngineFromHandle(engine)->Run(entry_point_view);
 }

References EngineFromHandle(), and flutter::FlutterWindowsEngine::Run().

Referenced by flutter::FlutterEngine::Run(), and flutter::testing::TEST_F().

◆ FlutterDesktopEngineSetNextFrameCallback()

FLUTTER_EXPORT void FlutterDesktopEngineSetNextFrameCallback	(	FlutterDesktopEngineRef	engine,
		VoidCallback	callback,
		void *	user_data
	)

Definition at line 206 of file flutter_windows.cc.

                                                                {
   EngineFromHandle(engine)->SetNextFrameCallback(
       [callback, user_data]() { callback(user_data); });
 }

References callback, EngineFromHandle(), flutter::FlutterWindowsEngine::SetNextFrameCallback(), and user_data.

Referenced by flutter::FlutterEngine::SetNextFrameCallback(), and flutter::testing::TEST_F().

◆ FlutterDesktopGetDpiForHWND()

FLUTTER_EXPORT UINT FlutterDesktopGetDpiForHWND ( HWND hwnd )

Definition at line 269 of file flutter_windows.cc.

                                             {
   return flutter::GetDpiForHWND(hwnd);
 }

References flutter::GetDpiForHWND().

◆ FlutterDesktopGetDpiForMonitor()

FLUTTER_EXPORT UINT FlutterDesktopGetDpiForMonitor ( HMONITOR monitor )

Definition at line 273 of file flutter_windows.cc.

                                                       {
   return flutter::GetDpiForMonitor(monitor);
 }

References flutter::GetDpiForMonitor().

◆ FlutterDesktopPluginRegistrarGetView()

FLUTTER_EXPORT FlutterDesktopViewRef FlutterDesktopPluginRegistrarGetView ( FlutterDesktopPluginRegistrarRef registrar )

Definition at line 249 of file flutter_windows.cc.

                                                 {
   return HandleForView(registrar->engine->view());
 }

References FlutterDesktopPluginRegistrar::engine, HandleForView(), and flutter::FlutterWindowsEngine::view().

Referenced by flutter::PluginRegistrarWindows::PluginRegistrarWindows().

◆ FlutterDesktopPluginRegistrarRegisterTopLevelWindowProcDelegate()

FLUTTER_EXPORT void FlutterDesktopPluginRegistrarRegisterTopLevelWindowProcDelegate	(	FlutterDesktopPluginRegistrarRef	registrar,
		FlutterDesktopWindowProcCallback	delegate,
		void *	user_data
	)

Definition at line 254 of file flutter_windows.cc.

                      {
   registrar->engine->window_proc_delegate_manager()
       ->RegisterTopLevelWindowProcDelegate(delegate, user_data);
 }

References FlutterDesktopPluginRegistrar::engine, flutter::WindowProcDelegateManager::RegisterTopLevelWindowProcDelegate(), user_data, and flutter::FlutterWindowsEngine::window_proc_delegate_manager().

Referenced by flutter::PluginRegistrarWindows::RegisterTopLevelWindowProcDelegate().

◆ FlutterDesktopPluginRegistrarUnregisterTopLevelWindowProcDelegate()

FLUTTER_EXPORT void FlutterDesktopPluginRegistrarUnregisterTopLevelWindowProcDelegate	(	FlutterDesktopPluginRegistrarRef	registrar,
		FlutterDesktopWindowProcCallback	delegate
	)

Definition at line 262 of file flutter_windows.cc.

                                                {
   registrar->engine->window_proc_delegate_manager()
       ->UnregisterTopLevelWindowProcDelegate(delegate);
 }

References FlutterDesktopPluginRegistrar::engine, flutter::WindowProcDelegateManager::UnregisterTopLevelWindowProcDelegate(), and flutter::FlutterWindowsEngine::window_proc_delegate_manager().

Referenced by flutter::PluginRegistrarWindows::UnregisterTopLevelWindowProcDelegate().

◆ FlutterDesktopResyncOutputStreams()

FLUTTER_EXPORT void FlutterDesktopResyncOutputStreams ( )

Definition at line 277 of file flutter_windows.cc.

                                          {
   FILE* unused;
   if (freopen_s(&unused, "CONOUT$", "w", stdout)) {
     _dup2(_fileno(stdout), 1);
   }
   if (freopen_s(&unused, "CONOUT$", "w", stderr)) {
     _dup2(_fileno(stdout), 2);
   }
   std::ios::sync_with_stdio();
 }

◆ FlutterDesktopViewControllerCreate()

FLUTTER_EXPORT FlutterDesktopViewControllerRef FlutterDesktopViewControllerCreate	(	int	width,
		int	height,
		FlutterDesktopEngineRef	engine
	)

Definition at line 75 of file flutter_windows.cc.

                                         {
   flutter::FlutterWindowsEngine* engine_ptr = EngineFromHandle(engine_ref);
   std::unique_ptr<flutter::WindowBindingHandler> window_wrapper =
       std::make_unique<flutter::FlutterWindow>(
           width, height, engine_ptr->windows_proc_table());
  
   auto engine = std::unique_ptr<flutter::FlutterWindowsEngine>(engine_ptr);
   auto view = std::make_unique<flutter::FlutterWindowsView>(
       std::move(window_wrapper), engine_ptr->windows_proc_table());
   auto controller = std::make_unique<flutter::FlutterWindowsViewController>(
       std::move(engine), std::move(view));
  
   controller->view()->SetEngine(controller->engine());
   controller->view()->CreateRenderSurface();
   if (!controller->engine()->running()) {
     if (!controller->engine()->Run()) {
       return nullptr;
     }
   }
  
   // Must happen after engine is running.
   controller->view()->SendInitialBounds();
  
   // The Windows embedder listens to accessibility updates using the
   // view's HWND. The embedder's accessibility features may be stale if
   // the app was in headless mode.
   controller->engine()->UpdateAccessibilityFeatures();
  
   return HandleForViewController(controller.release());
 }

References EngineFromHandle(), HandleForViewController(), and flutter::FlutterWindowsEngine::windows_proc_table().

Referenced by flutter::FlutterViewController::FlutterViewController(), and flutter::testing::TEST_F().

◆ FlutterDesktopViewControllerDestroy()

FLUTTER_EXPORT void FlutterDesktopViewControllerDestroy ( FlutterDesktopViewControllerRef controller )

Definition at line 109 of file flutter_windows.cc.

                                                                               {
   auto controller = ViewControllerFromHandle(ref);
   delete controller;
 }

References ViewControllerFromHandle().

Referenced by flutter::FlutterViewController::~FlutterViewController().

◆ FlutterDesktopViewControllerForceRedraw()

FLUTTER_EXPORT void FlutterDesktopViewControllerForceRedraw ( FlutterDesktopViewControllerRef controller )

Definition at line 126 of file flutter_windows.cc.

                                          {
   auto controller = ViewControllerFromHandle(ref);
   controller->view()->ForceRedraw();
 }

References ViewControllerFromHandle().

Referenced by flutter::FlutterViewController::ForceRedraw().

◆ FlutterDesktopViewControllerGetEngine()

FLUTTER_EXPORT FlutterDesktopEngineRef FlutterDesktopViewControllerGetEngine ( FlutterDesktopViewControllerRef controller )

Definition at line 114 of file flutter_windows.cc.

                                          {
   auto controller = ViewControllerFromHandle(ref);
   return HandleForEngine(controller->engine());
 }

References HandleForEngine(), and ViewControllerFromHandle().

Referenced by flutter::testing::TEST_F().

◆ FlutterDesktopViewControllerGetView()

FLUTTER_EXPORT FlutterDesktopViewRef FlutterDesktopViewControllerGetView ( FlutterDesktopViewControllerRef controller )

Definition at line 120 of file flutter_windows.cc.

                                          {
   auto controller = ViewControllerFromHandle(ref);
   return HandleForView(controller->view());
 }

References HandleForView(), and ViewControllerFromHandle().

Referenced by flutter::FlutterViewController::FlutterViewController(), and flutter::testing::TEST_F().

◆ FlutterDesktopViewControllerHandleTopLevelWindowProc()

FLUTTER_EXPORT bool FlutterDesktopViewControllerHandleTopLevelWindowProc	(	FlutterDesktopViewControllerRef	controller,
		HWND	hwnd,
		UINT	message,
		WPARAM	wparam,
		LPARAM	lparam,
		LRESULT *	result
	)

Definition at line 132 of file flutter_windows.cc.

                      {
   auto controller = ViewControllerFromHandle(ref);
   std::optional<LRESULT> delegate_result =
       controller->engine()
           ->window_proc_delegate_manager()
           ->OnTopLevelWindowProc(hwnd, message, wparam, lparam);
   if (delegate_result) {
     *result = *delegate_result;
   }
   return delegate_result.has_value();
 }

References message, and ViewControllerFromHandle().

Referenced by flutter::FlutterViewController::HandleTopLevelWindowProc().

◆ FlutterDesktopViewGetGraphicsAdapter()

FLUTTER_EXPORT IDXGIAdapter* FlutterDesktopViewGetGraphicsAdapter ( FlutterDesktopViewRef view )

Definition at line 217 of file flutter_windows.cc.

                                                                                {
   auto surface_manager = ViewFromHandle(view)->GetEngine()->surface_manager();
   if (surface_manager) {
     Microsoft::WRL::ComPtr<ID3D11Device> d3d_device;
     Microsoft::WRL::ComPtr<IDXGIDevice> dxgi_device;
     if (surface_manager->GetDevice(d3d_device.GetAddressOf()) &&
         SUCCEEDED(d3d_device.As(&dxgi_device))) {
       IDXGIAdapter* adapter;
       if (SUCCEEDED(dxgi_device->GetAdapter(&adapter))) {
         return adapter;
       }
     }
   }
   return nullptr;
 }

References flutter::FlutterWindowsView::GetEngine(), flutter::FlutterWindowsEngine::surface_manager(), and ViewFromHandle().

Referenced by flutter::FlutterView::GetGraphicsAdapter(), and flutter::testing::TEST_F().

◆ FlutterDesktopViewGetHWND()

FLUTTER_EXPORT HWND FlutterDesktopViewGetHWND ( FlutterDesktopViewRef view )

Definition at line 213 of file flutter_windows.cc.

                                                            {
   return ViewFromHandle(view)->GetWindowHandle();
 }

References flutter::FlutterWindowsView::GetWindowHandle(), and ViewFromHandle().

Referenced by flutter::FlutterView::GetNativeWindow().

Classes

Typedefs

Functions