Flutter Engine
FlutterEngine() Category Reference

#import <FlutterEngine_Internal.h>

Inheritance diagram for FlutterEngine():

Instance Methods

(flutter::Shell &) - shell
 
(void) - updateViewportMetrics:
 
(void) - dispatchPointerDataPacket:
 
(fml::RefPtr< fml::TaskRunner >) - platformTaskRunner
 
(fml::RefPtr< fml::TaskRunner >) - RasterTaskRunner
 
(fml::WeakPtr< flutter::PlatformView >) - platformView
 
(flutter::Rasterizer::Screenshot- screenshot:base64Encode:
 
(nonnull FlutterPlatformPlugin *) - platformPlugin
 
(std::shared_ptr< flutter::FlutterPlatformViewsController > &) - platformViewsController
 
(nonnull FlutterTextInputPlugin *) - textInputPlugin
 
(nonnull FlutterRestorationPlugin *) - restorationPlugin
 
(void) - launchEngine:libraryURI:
 
(BOOL- createShell:libraryURI:initialRoute:
 
(void) - attachView
 
(void) - notifyLowMemory
 
(nonnull flutter::PlatformViewIOS *) - iosPlatformView
 
(void) - waitForFirstFrame:callback:
 
(nonnull FlutterEngine *) - spawnWithEntrypoint:libraryURI:initialRoute:
 
(void) - sendKeyEvent:callback:userData:
 
(BOOL- createShell:libraryURI:initialRoute:
 
(void) - dispatchPointerDataPacket:
 
(FlutterTextInputPlugin *) - textInputPlugin
 
(void) - sendKeyEvent:callback:userData:
 
(BOOL- createShell:libraryURI:initialRoute:
 
(void) - dispatchPointerDataPacket:
 
(void) - updateViewportMetrics:
 
(void) - attachView
 
(void) - sendUserLocales
 
(void) - engineCallbackOnPlatformMessage:
 
(void) - postMainThreadTask:targetTimeInNanoseconds:
 
(void) - loadAOTData:
 
(void) - updateWindowMetrics
 
(void) - sendPointerEvent:
 
(void) - sendKeyEvent:callback:userData:
 
(BOOL- registerTextureWithID:
 
(BOOL- markTextureFrameAvailable:
 
(BOOL- unregisterTextureWithID:
 
(void) - dispatchSemanticsAction:toTarget:withData:
 

Properties

NSMutableDictionary * pluginPublications
 
NSMutableDictionary< NSString *, FlutterEngineRegistrar * > * registrars
 
NSString * isolateId
 
NSString * initialRoute
 
id< NSObject > flutterViewControllerWillDeallocObserver
 
BOOL running
 
id< FlutterRenderer > renderer
 
FlutterEngineProcTableembedderAPI
 
std::weak_ptr< flutter::AccessibilityBridgeaccessibilityBridge
 
BOOL semanticsEnabled
 

Detailed Description

Private interface declaration for FlutterEngine.

Definition at line 45 of file FlutterEngine.mm.

Method Documentation

◆ attachView() [1/2]

- (void) attachView

◆ attachView() [2/2]

- (void) attachView

◆ createShell:libraryURI:initialRoute:() [1/3]

- (BOOL) createShell: (NSString *)  entrypoint
libraryURI: (NSString *)  libraryURI
initialRoute: (NSString *)  initialRoute 

◆ createShell:libraryURI:initialRoute:() [2/3]

- (BOOL) createShell: (nullable NSString *)  entrypoint
libraryURI: (nullable NSString *)  libraryOrNil
initialRoute: (nullable NSString *)  initialRoute 

◆ createShell:libraryURI:initialRoute:() [3/3]

- (BOOL) createShell: (NSString *)  entrypoint
libraryURI: (NSString *)  libraryURI
initialRoute: (NSString *)  initialRoute 

◆ dispatchPointerDataPacket:() [1/3]

- (void) dispatchPointerDataPacket: (std::unique_ptr< flutter::PointerDataPacket >)  packet

◆ dispatchPointerDataPacket:() [2/3]

- (void) dispatchPointerDataPacket: (std::unique_ptr< flutter::PointerDataPacket >)  packet

◆ dispatchPointerDataPacket:() [3/3]

- (void) dispatchPointerDataPacket: (std::unique_ptr< flutter::PointerDataPacket >)  packet

◆ dispatchSemanticsAction:toTarget:withData:()

- (void) dispatchSemanticsAction: (FlutterSemanticsAction action
toTarget: (uint16_t)  target
withData: (fml::MallocMapping data 

Dispatches semantics action back to the framework. The semantics must be enabled by calling the updateSemanticsEnabled before dispatching semantics actions.

◆ engineCallbackOnPlatformMessage:()

- (void) engineCallbackOnPlatformMessage: (const FlutterPlatformMessage *)  message

Handles a platform message from the engine.

◆ iosPlatformView()

- (nonnull PlatformViewIOS* FlutterEngine()):

◆ launchEngine:libraryURI:()

- (void) launchEngine: (nullable NSString *)  entrypoint
libraryURI: (nullable NSString *)  libraryOrNil 

◆ loadAOTData:()

- (void) loadAOTData: (NSString *)  assetsDir

Loads the AOT snapshots and instructions from the elf bundle (app_elf_snapshot.so) into _aotData, if it is present in the assets directory.

◆ markTextureFrameAvailable:()

- (BOOL) markTextureFrameAvailable: (int64_t)  textureID

Marks texture with the given id as available. Returns YES on success.

◆ notifyLowMemory()

- (void) notifyLowMemory

◆ platformPlugin()

- (nonnull FlutterPlatformPlugin*) platformPlugin

◆ platformTaskRunner()

- (RefPtr<)fml:

◆ platformView()

- (WeakPtr<)flutter:

◆ platformViewsController()

- (shared_ptr<)flutter:

◆ postMainThreadTask:targetTimeInNanoseconds:()

- (void) postMainThreadTask: (FlutterTask task
targetTimeInNanoseconds: (uint64_t)  targetTime 

Requests that the task be posted back the to the Flutter engine at the target time. The target time is in the clock used by the Flutter engine.

◆ RasterTaskRunner()

- (RefPtr<)fml:

◆ registerTextureWithID:()

- (BOOL) registerTextureWithID: (int64_t)  textureId

Registers an external texture with the given id. Returns YES on success.

◆ restorationPlugin()

- (nonnull FlutterRestorationPlugin*) restorationPlugin

◆ screenshot:base64Encode:()

- Rasterizer: (flutter::Rasterizer::ScreenshotType type
base64Encode: (bool)  base64Encode 

◆ sendKeyEvent:callback:userData:() [1/3]

- (void) sendKeyEvent: (const FlutterKeyEvent &)  event
callback: (nullable FlutterKeyEventCallback callback
userData: (nullable void *)  userData 

Dispatches the given key event data to the framework through the engine. The callback is called once the response from the framework is received.

◆ sendKeyEvent:callback:userData:() [2/3]

- (void) sendKeyEvent: (const FlutterKeyEvent &)  event
callback: (nullable FlutterKeyEventCallback callback
userData: (nullable void *)  userData 

Dispatches the given pointer event data to engine.

◆ sendKeyEvent:callback:userData:() [3/3]

- (void) sendKeyEvent: (const FlutterKeyEvent &)  event
callback: (nullable FlutterKeyEventCallback callback
userData: (nullable void *)  userData 

◆ sendPointerEvent:()

- (void) sendPointerEvent: (const FlutterPointerEvent &)  event

Dispatches the given pointer event data to engine.

◆ sendUserLocales()

- (void) sendUserLocales

Sends the list of user-preferred locales to the Flutter engine.

◆ shell()

- (Shell& FlutterEngine()):

◆ spawnWithEntrypoint:libraryURI:initialRoute:()

- (nonnull FlutterEngine*) spawnWithEntrypoint: (nullable NSString *)  entrypoint
libraryURI: (nullable NSString *)  libraryURI
initialRoute: (nullable NSString *)  initialRoute 

Creates one running FlutterEngine from another, sharing components between them.

This results in a faster creation time and a smaller memory footprint engine. This should only be called on a FlutterEngine that is running.

◆ textInputPlugin() [1/2]

- (nonnull FlutterTextInputPlugin*) textInputPlugin

◆ textInputPlugin() [2/2]

- (FlutterTextInputPlugin*) textInputPlugin

◆ unregisterTextureWithID:()

- (BOOL) unregisterTextureWithID: (int64_t)  textureID

Unregisters an external texture with the given id. Returns YES on success.

◆ updateViewportMetrics:() [1/2]

- (void) updateViewportMetrics: (flutter::ViewportMetrics viewportMetrics

◆ updateViewportMetrics:() [2/2]

- (void) updateViewportMetrics: (flutter::ViewportMetrics viewportMetrics

◆ updateWindowMetrics()

- (void) updateWindowMetrics

Informs the engine that the associated view controller's view size has changed.

◆ waitForFirstFrame:callback:()

- (void) waitForFirstFrame: (NSTimeInterval)  timeout
callback: (nonnull void(^)(BOOL didTimeout))  callback 

Property Documentation

◆ accessibilityBridge

- (weak_ptr<)flutter:
readnonatomicassign

Definition at line 33 of file FlutterEngine_Internal.h.

◆ embedderAPI

- (FlutterEngineProcTable&) embedderAPI
readwritenonatomicassign

Function pointers for interacting with the embedder.h API.

Definition at line 31 of file FlutterEngine_Internal.h.

◆ flutterViewControllerWillDeallocObserver

- (id<NSObject>) flutterViewControllerWillDeallocObserver
readwritenonatomicretain

Definition at line 53 of file FlutterEngine.mm.

◆ initialRoute

- (NSString*) initialRoute
readwritenonatomiccopy

Definition at line 52 of file FlutterEngine.mm.

◆ isolateId

- (NSString*) isolateId
readwritenonatomiccopy

Definition at line 51 of file FlutterEngine.mm.

◆ pluginPublications

- (NSMutableDictionary*) pluginPublications
readnonatomicassign

Definition at line 48 of file FlutterEngine.mm.

◆ registrars

- (NSMutableDictionary<NSString*, FlutterEngineRegistrar*>*) registrars
readnonatomicassign

Definition at line 49 of file FlutterEngine.mm.

◆ renderer

- (id<FlutterRenderer>) renderer
readnonatomicassign

Provides the renderer config needed to initialize the engine and also handles external texture management.

Definition at line 26 of file FlutterEngine_Internal.h.

◆ running

- (BOOL) running
readnonatomicassign

True if the engine is currently running.

Definition at line 20 of file FlutterEngine_Internal.h.

◆ semanticsEnabled

- (BOOL) semanticsEnabled
readwritenonatomicassign

True if the semantics is enabled. The Flutter framework starts sending semantics update through the embedder as soon as it is set to YES.

Definition at line 39 of file FlutterEngine_Internal.h.


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