Flutter Engine
flutter::PlatformViewEmbedder Class Referencefinal

#include <platform_view_embedder.h>

Inheritance diagram for flutter::PlatformViewEmbedder:


struct  PlatformDispatchTable

Public Types

using UpdateSemanticsNodesCallback = std::function< void(flutter::SemanticsNodeUpdates update)>
using UpdateSemanticsCustomActionsCallback = std::function< void(flutter::CustomAccessibilityActionUpdates actions)>
using PlatformMessageResponseCallback = std::function< void(std::unique_ptr< PlatformMessage >)>
using ComputePlatformResolvedLocaleCallback = std::function< std::unique_ptr< std::vector< std::string > >(const std::vector< std::string > &supported_locale_data)>
using OnPreEngineRestartCallback = std::function< void()>

Public Member Functions

 PlatformViewEmbedder (PlatformView::Delegate &delegate, flutter::TaskRunners task_runners, EmbedderSurfaceSoftware::SoftwareDispatchTable software_dispatch_table, PlatformDispatchTable platform_dispatch_table, std::shared_ptr< EmbedderExternalViewEmbedder > external_view_embedder)
 ~PlatformViewEmbedder () override
void UpdateSemantics (flutter::SemanticsNodeUpdates update, flutter::CustomAccessibilityActionUpdates actions) override
 Used by the framework to tell the embedder to apply the specified semantics node updates. The default implementation of this method does nothing. More...
void HandlePlatformMessage (std::unique_ptr< PlatformMessage > message) override
 Overridden by embedders to perform actions in response to platform messages sent from the framework to the embedder. Default implementation of this method simply returns an empty response. More...
- Public Member Functions inherited from flutter::PlatformView
 PlatformView (Delegate &delegate, TaskRunners task_runners)
 Creates a platform view with the specified delegate and task runner. The base class by itself does not do much but is suitable for use in test environments where full platform integration may not be necessary. The platform view may only be created, accessed and destroyed on the platform task runner. More...
virtual ~PlatformView ()
 Destroys the platform view. The platform view is owned by the shell and will be destroyed by the same on the platform tasks runner. More...
void DispatchPlatformMessage (std::unique_ptr< PlatformMessage > message)
 Used by embedders to dispatch a platform message to a running root isolate hosted by the engine. If an isolate is not running, the message is dropped. If there is no one on the other side listening on the channel, the message is dropped. When a platform message is dropped, any response handles associated with that message will be dropped as well. All users of platform messages must assume that message may not be delivered and/or their response handles may not be invoked. Platform messages are not buffered. More...
void DispatchSemanticsAction (int32_t id, SemanticsAction action, fml::MallocMapping args)
 Used by embedders to dispatch an accessibility action to a running isolate hosted by the engine. More...
virtual void SetSemanticsEnabled (bool enabled)
 Used by embedder to notify the running isolate hosted by the engine on the UI thread that the accessibility tree needs to be generated. More...
virtual void SetAccessibilityFeatures (int32_t flags)
 Used by the embedder to specify the features to enable in the accessibility tree generated by the isolate. This information is forwarded to the root isolate hosted by the engine on the UI thread. More...
void SetViewportMetrics (const ViewportMetrics &metrics)
 Used by embedders to specify the updated viewport metrics. In response to this call, on the raster thread, the rasterizer may need to be reconfigured to the updated viewport dimensions. On the UI thread, the framework may need to start generating a new frame for the updated viewport metrics as well. More...
void NotifyCreated ()
 Used by embedders to notify the shell that a platform view has been created. This notification is used to create a rendering surface and pick the client rendering API to use to render into this surface. No frames will be scheduled or rendered before this call. The surface must remain valid till the corresponding call to NotifyDestroyed. More...
virtual void NotifyDestroyed ()
 Used by embedders to notify the shell that the platform view has been destroyed. This notification used to collect the rendering surface and all associated resources. Frame scheduling is also suspended. More...
virtual void ReleaseResourceContext () const
 Used by the shell to notify the embedder that the resource context previously obtained via a call to CreateResourceContext() is being collected. The embedder is free to collect an platform specific resources associated with this context. More...
virtual PointerDataDispatcherMaker GetDispatcherMaker ()
 Returns a platform-specific PointerDataDispatcherMaker so the Engine can construct the PointerDataPacketDispatcher based on platforms. More...
fml::WeakPtr< PlatformViewGetWeakPtr () const
 Returns a weak pointer to the platform view. Since the platform view may only be created, accessed and destroyed on the platform thread, any access to the platform view from a non-platform task runner needs a weak pointer to the platform view along with a reference to the platform task runner. A task must be posted to the platform task runner with the weak pointer captured in the same. The platform view method may only be called in the posted task once the weak pointer validity has been checked. This method is used by callers to obtain that weak pointer. More...
void SetNextFrameCallback (const fml::closure &closure)
 Sets a callback that gets executed when the rasterizer renders the next frame. Due to the asynchronous nature of rendering in Flutter, embedders usually add a placeholder over the contents in which Flutter is going to render when Flutter is first initialized. This callback may be used as a signal to remove that placeholder. The callback is executed on the render task runner and not the platform task runner. It is the embedder's responsibility to re-thread as necessary. More...
void DispatchPointerDataPacket (std::unique_ptr< PointerDataPacket > packet)
 Dispatches pointer events from the embedder to the framework. Each pointer data packet may contain multiple pointer input events. Each call to this method wakes up the UI thread. More...
void DispatchKeyDataPacket (std::unique_ptr< KeyDataPacket > packet, Delegate::KeyDataResponse callback)
 Dispatches key events from the embedder to the framework. Each key data packet contains one physical event and multiple logical key events. Each call to this method wakes up the UI thread. More...
void RegisterTexture (std::shared_ptr< flutter::Texture > texture)
 Used by the embedder to specify a texture that it wants the rasterizer to composite within the Flutter layer tree. All textures must have a unique identifier. When the rasterizer encounters an external texture within its hierarchy, it gives the embedder a chance to update that texture on the raster thread before it composites the same on-screen. More...
void UnregisterTexture (int64_t texture_id)
 Used by the embedder to notify the rasterizer that it will no longer attempt to composite the specified texture within the layer tree. This allows the rasterizer to collect associated resources. More...
void MarkTextureFrameAvailable (int64_t texture_id)
 Used by the embedder to notify the rasterizer that the context of the previously registered texture have been updated. Typically, Flutter will only render a frame if there is an updated layer tree. However, in cases where the layer tree is static but one of the externally composited textures has been updated by the embedder, the embedder needs to notify the rasterizer to render a new frame. In such cases, the existing layer tree may be reused with the frame re-composited with all updated external textures. Unlike the calls to register and unregister the texture, this call must be made each time a new texture frame is available. More...
virtual void RequestDartDeferredLibrary (intptr_t loading_unit_id)
 Invoked when the dart VM requests that a deferred library be loaded. Notifies the engine that the deferred library identified by the specified loading unit id should be downloaded and loaded into the Dart VM via LoadDartDeferredLibrary More...
virtual void LoadDartDeferredLibrary (intptr_t loading_unit_id, std::unique_ptr< const fml::Mapping > snapshot_data, std::unique_ptr< const fml::Mapping > snapshot_instructions)
 Loads the Dart shared library into the Dart VM. When the Dart library is loaded successfully, the Dart future returned by the originating loadLibrary() call completes. More...
virtual void LoadDartDeferredLibraryError (intptr_t loading_unit_id, const std::string error_message, bool transient)
 Indicates to the dart VM that the request to load a deferred library with the specified loading unit id has failed. More...
virtual void UpdateAssetResolverByType (std::unique_ptr< AssetResolver > updated_asset_resolver, AssetResolver::AssetResolverType type)
 Replaces the asset resolver handled by the engine's AssetManager of the specified type with updated_asset_resolver. The matching AssetResolver is removed and replaced with updated_asset_resolvers. More...
virtual std::unique_ptr< SnapshotSurfaceProducerCreateSnapshotSurfaceProducer ()
 Creates an object that produces surfaces suitable for raster snapshotting. The rasterizer will request this surface if no on screen surface is currently available when an application requests a snapshot, e.g. if Scene.toImage or Picture.toImage are called while the application is in the background. More...

Additional Inherited Members

- Protected Attributes inherited from flutter::PlatformView
const TaskRunners task_runners_
PointerDataPacketConverter pointer_data_packet_converter_
SkISize size_
fml::WeakPtrFactory< PlatformViewweak_factory_

Detailed Description

Definition at line 28 of file platform_view_embedder.h.

Member Typedef Documentation

◆ ComputePlatformResolvedLocaleCallback

using flutter::PlatformViewEmbedder::ComputePlatformResolvedLocaleCallback = std::function<std::unique_ptr<std::vector<std::string> >( const std::vector<std::string>& supported_locale_data)>

Definition at line 38 of file platform_view_embedder.h.

◆ OnPreEngineRestartCallback

◆ PlatformMessageResponseCallback

◆ UpdateSemanticsCustomActionsCallback

◆ UpdateSemanticsNodesCallback

Constructor & Destructor Documentation

◆ PlatformViewEmbedder()

flutter::PlatformViewEmbedder::PlatformViewEmbedder ( PlatformView::Delegate delegate,
flutter::TaskRunners  task_runners,
EmbedderSurfaceSoftware::SoftwareDispatchTable  software_dispatch_table,
PlatformDispatchTable  platform_dispatch_table,
std::shared_ptr< EmbedderExternalViewEmbedder external_view_embedder 

Definition at line 9 of file platform_view_embedder.cc.

References flutter::PlatformView::PlatformView(), and ~PlatformViewEmbedder().

15  : PlatformView(delegate, std::move(task_runners)),
16  external_view_embedder_(external_view_embedder),
17  embedder_surface_(
18  std::make_unique<EmbedderSurfaceSoftware>(software_dispatch_table,
19  external_view_embedder_)),
20  platform_dispatch_table_(platform_dispatch_table) {}
PlatformView(Delegate &delegate, TaskRunners task_runners)
Creates a platform view with the specified delegate and task runner. The base class by itself does no...

◆ ~PlatformViewEmbedder()

flutter::PlatformViewEmbedder::~PlatformViewEmbedder ( )

Referenced by PlatformViewEmbedder().

Member Function Documentation

◆ HandlePlatformMessage()

void flutter::PlatformViewEmbedder::HandlePlatformMessage ( std::unique_ptr< PlatformMessage message)

Overridden by embedders to perform actions in response to platform messages sent from the framework to the embedder. Default implementation of this method simply returns an empty response.

Embedders that wish to send platform messages to the framework may use the DispatchPlatformMessage method. This method is for messages that go the other way.

See also
[in]messageThe message

Reimplemented from flutter::PlatformView.

Definition at line 67 of file platform_view_embedder.cc.

References flutter::PlatformViewEmbedder::PlatformDispatchTable::compute_platform_resolved_locale_callback, flutter::PlatformView::CreateVSyncWaiter(), FML_LOG, flutter::PlatformViewEmbedder::PlatformDispatchTable::on_pre_engine_restart_callback, flutter::PlatformViewEmbedder::PlatformDispatchTable::platform_message_response_callback, flutter::PlatformView::task_runners_, and flutter::PlatformViewEmbedder::PlatformDispatchTable::vsync_callback.

68  {
69  if (!message) {
70  return;
71  }
73  if (platform_dispatch_table_.platform_message_response_callback == nullptr) {
74  if (message->response()) {
75  message->response()->CompleteEmpty();
76  }
77  return;
78  }
80  platform_dispatch_table_.platform_message_response_callback(
81  std::move(message));
82 }
PlatformMessageResponseCallback platform_message_response_callback

◆ UpdateSemantics()

void flutter::PlatformViewEmbedder::UpdateSemantics ( flutter::SemanticsNodeUpdates  updates,
flutter::CustomAccessibilityActionUpdates  actions 

Used by the framework to tell the embedder to apply the specified semantics node updates. The default implementation of this method does nothing.

See also
SemanticsNode, SemticsNodeUpdates, CustomAccessibilityActionUpdates
[in]updatesA map with the stable semantics node identifier as key and the node properties as the value.
[in]actionsA map with the stable semantics node identifier as key and the custom node action as the value.

Reimplemented from flutter::PlatformView.

Definition at line 54 of file platform_view_embedder.cc.

References flutter::PlatformViewEmbedder::PlatformDispatchTable::update_semantics_custom_actions_callback, and flutter::PlatformViewEmbedder::PlatformDispatchTable::update_semantics_nodes_callback.

56  {
57  if (platform_dispatch_table_.update_semantics_nodes_callback != nullptr) {
58  platform_dispatch_table_.update_semantics_nodes_callback(std::move(update));
59  }
60  if (platform_dispatch_table_.update_semantics_custom_actions_callback !=
61  nullptr) {
62  platform_dispatch_table_.update_semantics_custom_actions_callback(
63  std::move(actions));
64  }
65 }
UpdateSemanticsCustomActionsCallback update_semantics_custom_actions_callback

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