#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 int64_t	FlutterDesktopViewId

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

Enumerations
enum	FlutterDesktopGpuPreference { NoPreference , LowPowerPreference }

enum	FlutterDesktopUIThreadPolicy { Default , RunOnPlatformThread , RunOnSeparateThread }

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

FLUTTER_EXPORT void	FlutterDesktopViewControllerDestroy (FlutterDesktopViewControllerRef controller)

FLUTTER_EXPORT FlutterDesktopViewId	FlutterDesktopViewControllerGetViewId (FlutterDesktopViewControllerRef view_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 FlutterDesktopViewRef	FlutterDesktopPluginRegistrarGetViewById (FlutterDesktopPluginRegistrarRef registrar, FlutterDesktopViewId view_id)

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.

◆ FlutterDesktopViewId

typedef int64_t FlutterDesktopViewId

Definition at line 36 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 271 of file flutter_windows.h.

◆ VoidCallback

typedef void(* VoidCallback) (void *)

Definition at line 21 of file flutter_windows.h.

Enumeration Type Documentation

◆ FlutterDesktopGpuPreference

enum FlutterDesktopGpuPreference

Enumerator
NoPreference
LowPowerPreference

Definition at line 39 of file flutter_windows.h.

             {
  // No preference.
  NoPreference,
  // Prefer energy efficiency over performance, such as an integrated GPU.
  // This falls back to a high performance GPU if no low power GPU is
  // available.
  LowPowerPreference,
} FlutterDesktopGpuPreference;

◆ FlutterDesktopUIThreadPolicy

enum FlutterDesktopUIThreadPolicy

Enumerator
Default
RunOnPlatformThread
RunOnSeparateThread

Definition at line 49 of file flutter_windows.h.

             {
  // Default value. Currently will run the UI isolate on separate thread,
  // later will be changed to running the UI isolate on platform thread.
  Default,
  // Run the UI isolate on platform thread.
  RunOnPlatformThread,
  // Run the UI isolate on a separate thread.
  RunOnSeparateThread,
} FlutterDesktopUIThreadPolicy;

Function Documentation

◆ FlutterDesktopEngineCreate()

FLUTTER_EXPORT FlutterDesktopEngineRef FlutterDesktopEngineCreate ( const FlutterDesktopEngineProperties * engine_properties )

Definition at line 94 of file stub_flutter_windows_api.cc.

                                                             {
  if (s_stub_implementation) {
    return s_stub_implementation->EngineCreate(*engine_properties);
  }
  return nullptr;
}

References engine, flutter::testing::StubFlutterWindowsApi::EngineCreate(), HandleForEngine(), and s_stub_implementation.

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

◆ FlutterDesktopEngineDestroy()

FLUTTER_EXPORT bool FlutterDesktopEngineDestroy ( FlutterDesktopEngineRef engine )

Definition at line 102 of file stub_flutter_windows_api.cc.

                                                                     {
  if (s_stub_implementation) {
    return s_stub_implementation->EngineDestroy();
  }
  return true;
}

References engine, flutter::testing::StubFlutterWindowsApi::EngineDestroy(), EngineFromHandle(), and s_stub_implementation.

Referenced by flutter::testing::EngineDeleter::operator()(), and flutter::testing::TEST().

◆ FlutterDesktopEngineGetMessenger()

FLUTTER_EXPORT FlutterDesktopMessengerRef FlutterDesktopEngineGetMessenger ( FlutterDesktopEngineRef engine )

Definition at line 145 of file stub_flutter_windows_api.cc.

                                    {
  // The stub ignores this, so just return an arbitrary non-zero value.
  return reinterpret_cast<FlutterDesktopMessengerRef>(2);
}

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

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

◆ FlutterDesktopEngineGetPluginRegistrar()

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

Definition at line 138 of file stub_flutter_windows_api.cc.

                             {
  // The stub ignores this, so just return an arbitrary non-zero value.
  return reinterpret_cast<FlutterDesktopPluginRegistrarRef>(1);
}

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

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

◆ FlutterDesktopEngineGetTextureRegistrar()

FLUTTER_EXPORT FlutterDesktopTextureRegistrarRef FlutterDesktopEngineGetTextureRegistrar ( FlutterDesktopEngineRef engine )

Definition at line 151 of file stub_flutter_windows_api.cc.

                                    {
  // The stub ignores this, so just return an arbitrary non-zero value.
  return reinterpret_cast<FlutterDesktopTextureRegistrarRef>(3);
}

References engine, EngineFromHandle(), HandleForTextureRegistrar(), and texture_registrar.

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 171 of file stub_flutter_windows_api.cc.

                     {
  if (s_stub_implementation) {
    return s_stub_implementation->EngineProcessExternalWindowMessage(
        engine, hwnd, message, wparam, lparam, result);
  }
  return false;
}

References engine, EngineFromHandle(), flutter::testing::StubFlutterWindowsApi::EngineProcessExternalWindowMessage(), message, flutter::FlutterWindowsEngine::ProcessExternalWindowMessage(), and s_stub_implementation.

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

◆ FlutterDesktopEngineProcessMessages()

FLUTTER_EXPORT uint64_t FlutterDesktopEngineProcessMessages ( FlutterDesktopEngineRef engine )

Definition at line 117 of file stub_flutter_windows_api.cc.

                                                                             {
  if (s_stub_implementation) {
    return s_stub_implementation->EngineProcessMessages();
  }
  return 0;
}

References flutter::testing::StubFlutterWindowsApi::EngineProcessMessages(), and s_stub_implementation.

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

◆ FlutterDesktopEngineReloadSystemFonts()

FLUTTER_EXPORT void FlutterDesktopEngineReloadSystemFonts ( FlutterDesktopEngineRef engine )

Definition at line 132 of file stub_flutter_windows_api.cc.

                                                                           {
  if (s_stub_implementation) {
    s_stub_implementation->EngineReloadSystemFonts();
  }
}

References engine, EngineFromHandle(), flutter::testing::StubFlutterWindowsApi::EngineReloadSystemFonts(), flutter::FlutterWindowsEngine::ReloadSystemFonts(), and s_stub_implementation.

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

◆ FlutterDesktopEngineRun()

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

Definition at line 109 of file stub_flutter_windows_api.cc.

                                                      {
  if (s_stub_implementation) {
    return s_stub_implementation->EngineRun(entry_point);
  }
  return true;
}

References engine, EngineFromHandle(), flutter::testing::StubFlutterWindowsApi::EngineRun(), flutter::FlutterWindowsEngine::Run(), and s_stub_implementation.

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

◆ FlutterDesktopEngineSetNextFrameCallback()

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

Definition at line 124 of file stub_flutter_windows_api.cc.

                                                               {
  if (s_stub_implementation) {
    s_stub_implementation->EngineSetNextFrameCallback(callback, user_data);
  }
}

References callback, engine, EngineFromHandle(), flutter::testing::StubFlutterWindowsApi::EngineSetNextFrameCallback(), s_stub_implementation, flutter::FlutterWindowsEngine::SetNextFrameCallback(), and user_data.

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

◆ FlutterDesktopGetDpiForHWND()

FLUTTER_EXPORT UINT FlutterDesktopGetDpiForHWND ( HWND hwnd )

Definition at line 323 of file flutter_windows.cc.

                                            {
  return flutter::GetDpiForHWND(hwnd);
}

References flutter::GetDpiForHWND().

Referenced by flutter::HostWindow::GetWindowContentSize().

◆ FlutterDesktopGetDpiForMonitor()

FLUTTER_EXPORT UINT FlutterDesktopGetDpiForMonitor ( HMONITOR monitor )

Definition at line 327 of file flutter_windows.cc.

                                                      {
  return flutter::GetDpiForMonitor(monitor);
}

References flutter::GetDpiForMonitor().

◆ FlutterDesktopPluginRegistrarGetView()

FLUTTER_EXPORT FlutterDesktopViewRef FlutterDesktopPluginRegistrarGetView ( FlutterDesktopPluginRegistrarRef registrar )

Definition at line 195 of file stub_flutter_windows_api.cc.

                                                 {
  if (s_stub_implementation) {
    return s_stub_implementation->PluginRegistrarGetView();
  }
  return nullptr;
}

References FlutterDesktopPluginRegistrar::engine, HandleForView(), flutter::kImplicitViewId, flutter::testing::StubFlutterWindowsApi::PluginRegistrarGetView(), and s_stub_implementation.

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

◆ FlutterDesktopPluginRegistrarGetViewById()

FLUTTER_EXPORT FlutterDesktopViewRef FlutterDesktopPluginRegistrarGetViewById	(	FlutterDesktopPluginRegistrarRef	registrar,
		FlutterDesktopViewId	view_id
	)

Definition at line 203 of file stub_flutter_windows_api.cc.

                                  {
  if (s_stub_implementation) {
    return s_stub_implementation->PluginRegistrarGetViewById(view_id);
  }
  return nullptr;
}

References FlutterDesktopPluginRegistrar::engine, HandleForView(), flutter::testing::StubFlutterWindowsApi::PluginRegistrarGetViewById(), s_stub_implementation, and view_id.

Referenced by flutter::PluginRegistrarWindows::GetViewById(), flutter::testing::TEST_F(), and flutter::testing::TEST_F().

◆ FlutterDesktopPluginRegistrarRegisterTopLevelWindowProcDelegate()

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

Definition at line 212 of file stub_flutter_windows_api.cc.

                     {
  if (s_stub_implementation) {
    return s_stub_implementation
        ->PluginRegistrarRegisterTopLevelWindowProcDelegate(delegate,
                                                            user_data);
  }
}

References FlutterDesktopPluginRegistrar::engine, flutter::testing::StubFlutterWindowsApi::PluginRegistrarRegisterTopLevelWindowProcDelegate(), s_stub_implementation, and user_data.

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

◆ FlutterDesktopPluginRegistrarUnregisterTopLevelWindowProcDelegate()

FLUTTER_EXPORT void FlutterDesktopPluginRegistrarUnregisterTopLevelWindowProcDelegate	(	FlutterDesktopPluginRegistrarRef	registrar,
		FlutterDesktopWindowProcCallback	delegate
	)

Definition at line 223 of file stub_flutter_windows_api.cc.

                                               {
  if (s_stub_implementation) {
    return s_stub_implementation
        ->PluginRegistrarUnregisterTopLevelWindowProcDelegate(delegate);
  }
}

References FlutterDesktopPluginRegistrar::engine, flutter::testing::StubFlutterWindowsApi::PluginRegistrarUnregisterTopLevelWindowProcDelegate(), and s_stub_implementation.

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

◆ FlutterDesktopResyncOutputStreams()

FLUTTER_EXPORT void FlutterDesktopResyncOutputStreams ( )

Definition at line 331 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 38 of file stub_flutter_windows_api.cc.

                                    {
  if (s_stub_implementation) {
    return s_stub_implementation->ViewControllerCreate(width, height, engine);
  }
  return nullptr;
}

References CreateViewController(), engine, height, s_stub_implementation, flutter::testing::StubFlutterWindowsApi::ViewControllerCreate(), and width.

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

◆ FlutterDesktopViewControllerDestroy()

FLUTTER_EXPORT void FlutterDesktopViewControllerDestroy ( FlutterDesktopViewControllerRef controller )

Definition at line 48 of file stub_flutter_windows_api.cc.

                                                {
  if (s_stub_implementation) {
    s_stub_implementation->ViewControllerDestroy();
  }
}

References s_stub_implementation, flutter::testing::StubFlutterWindowsApi::ViewControllerDestroy(), and ViewControllerFromHandle().

Referenced by flutter::testing::ViewControllerDeleter::operator()(), and flutter::FlutterViewController::~FlutterViewController().

◆ FlutterDesktopViewControllerForceRedraw()

FLUTTER_EXPORT void FlutterDesktopViewControllerForceRedraw ( FlutterDesktopViewControllerRef controller )

Definition at line 73 of file stub_flutter_windows_api.cc.

                                                {
  if (s_stub_implementation) {
    s_stub_implementation->ViewControllerForceRedraw();
  }
}

References s_stub_implementation, flutter::testing::StubFlutterWindowsApi::ViewControllerForceRedraw(), and ViewControllerFromHandle().

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

◆ FlutterDesktopViewControllerGetEngine()

FLUTTER_EXPORT FlutterDesktopEngineRef FlutterDesktopViewControllerGetEngine ( FlutterDesktopViewControllerRef controller )

Definition at line 61 of file stub_flutter_windows_api.cc.

                                                {
  // The stub ignores this, so just return an arbitrary non-zero value.
  return reinterpret_cast<FlutterDesktopEngineRef>(1);
}

References HandleForEngine(), and ViewControllerFromHandle().

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

◆ FlutterDesktopViewControllerGetView()

FLUTTER_EXPORT FlutterDesktopViewRef FlutterDesktopViewControllerGetView ( FlutterDesktopViewControllerRef controller )

Definition at line 67 of file stub_flutter_windows_api.cc.

                                                {
  // The stub ignores this, so just return an arbitrary non-zero value.
  return reinterpret_cast<FlutterDesktopViewRef>(1);
}

References HandleForView(), and ViewControllerFromHandle().

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

◆ FlutterDesktopViewControllerGetViewId()

FLUTTER_EXPORT FlutterDesktopViewId FlutterDesktopViewControllerGetViewId ( FlutterDesktopViewControllerRef view_controller )

Definition at line 55 of file stub_flutter_windows_api.cc.

                                                {
  // The stub ignores this, so just return an arbitrary non-zero value.
  return static_cast<FlutterDesktopViewId>(1);
}

References ViewControllerFromHandle().

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

◆ FlutterDesktopViewControllerHandleTopLevelWindowProc()

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

Definition at line 80 of file stub_flutter_windows_api.cc.

                     {
  if (s_stub_implementation) {
    return s_stub_implementation->ViewControllerHandleTopLevelWindowProc(
        hwnd, message, wparam, lparam, result);
  }
  return false;
}

References message, s_stub_implementation, ViewControllerFromHandle(), and flutter::testing::StubFlutterWindowsApi::ViewControllerHandleTopLevelWindowProc().

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

◆ FlutterDesktopViewGetGraphicsAdapter()

FLUTTER_EXPORT IDXGIAdapter * FlutterDesktopViewGetGraphicsAdapter ( FlutterDesktopViewRef view )

Definition at line 164 of file stub_flutter_windows_api.cc.

                                                                               {
  if (s_stub_implementation) {
    return s_stub_implementation->ViewGetGraphicsAdapter();
  }
  return nullptr;
}

References flutter::FlutterWindowsEngine::egl_manager(), flutter::FlutterWindowsView::GetEngine(), s_stub_implementation, SUCCEEDED, view, ViewFromHandle(), and flutter::testing::StubFlutterWindowsApi::ViewGetGraphicsAdapter().

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

◆ FlutterDesktopViewGetHWND()

FLUTTER_EXPORT HWND FlutterDesktopViewGetHWND ( FlutterDesktopViewRef view )

Definition at line 157 of file stub_flutter_windows_api.cc.

                                                                 {
  if (s_stub_implementation) {
    return s_stub_implementation->ViewGetHWND();
  }
  return reinterpret_cast<HWND>(-1);
}

References flutter::FlutterWindowsView::GetWindowHandle(), s_stub_implementation, view, ViewFromHandle(), and flutter::testing::StubFlutterWindowsApi::ViewGetHWND().

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

Classes

Typedefs

Enumerations

Functions