flutter::PlatformViewAndroid Class Reference

#include <platform_view_android.h>

Inheritance diagram for flutter::PlatformViewAndroid:

Public Member Functions
	PlatformViewAndroid (PlatformView::Delegate &delegate, const flutter::TaskRunners &task_runners, const std::shared_ptr< PlatformViewAndroidJNI > &jni_facade, bool use_software_rendering, uint8_t msaa_samples)
	PlatformViewAndroid (PlatformView::Delegate &delegate, const flutter::TaskRunners &task_runners, const std::shared_ptr< PlatformViewAndroidJNI > &jni_facade, const std::shared_ptr< flutter::AndroidContext > &android_context)
	Creates a new PlatformViewAndroid but using an existing Android GPU context to create new surfaces. This maximizes resource sharing between 2 PlatformViewAndroids of 2 Shells.
	~PlatformViewAndroid () override
void	NotifyCreated (fml::RefPtr< AndroidNativeWindow > native_window)
void	NotifySurfaceWindowChanged (fml::RefPtr< AndroidNativeWindow > native_window)
void	NotifyChanged (const SkISize &size)
void	NotifyDestroyed () override
	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.
void	DispatchPlatformMessage (JNIEnv *env, std::string name, jobject message_data, jint message_position, jint response_id)
void	DispatchEmptyPlatformMessage (JNIEnv *env, std::string name, jint response_id)
void	DispatchSemanticsAction (JNIEnv *env, jint id, jint action, jobject args, jint args_position)
void	RegisterExternalTexture (int64_t texture_id, const fml::jni::ScopedJavaGlobalRef< jobject > &surface_texture)
void	RegisterImageTexture (int64_t texture_id, const fml::jni::ScopedJavaGlobalRef< jobject > &image_texture_entry)
void	LoadDartDeferredLibrary (intptr_t loading_unit_id, std::unique_ptr< const fml::Mapping > snapshot_data, std::unique_ptr< const fml::Mapping > snapshot_instructions) override
	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.
void	LoadDartDeferredLibraryError (intptr_t loading_unit_id, const std::string error_message, bool transient) override
	Indicates to the dart VM that the request to load a deferred library with the specified loading unit id has failed.
void	UpdateAssetResolverByType (std::unique_ptr< AssetResolver > updated_asset_resolver, AssetResolver::AssetResolverType type) override
	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.
const std::shared_ptr< AndroidContext > &	GetAndroidContext ()
std::shared_ptr< PlatformMessageHandler >	GetPlatformMessageHandler () const override
	Specifies a delegate that will receive PlatformMessages from Flutter to the host platform.
Public Member Functions inherited from flutter::PlatformView
	PlatformView (Delegate &delegate, const 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.
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.
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.
void	DispatchSemanticsAction (int32_t node_id, SemanticsAction action, fml::MallocMapping args)
	Used by embedders to dispatch an accessibility action to a running isolate hosted by the engine.
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.
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.
virtual void	SendChannelUpdate (const std::string &name, bool listening)
	Used by the framework to tell the embedder that it has registered a listener on a given channel.
void	SetViewportMetrics (int64_t view_id, const ViewportMetrics &metrics)
	Used by embedders to specify the updated viewport metrics for a view. 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.
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.
void	ScheduleFrame ()
	Used by embedders to schedule a frame. In response to this call, the framework may need to start generating a new frame.
void	AddView (int64_t view_id, const ViewportMetrics &viewport_metrics, AddViewCallback callback)
	Used by embedders to notify the shell of a new non-implicit view.
void	RemoveView (int64_t view_id, RemoveViewCallback callback)
	Used by embedders to notify the shell of a removed non-implicit view.
virtual PointerDataDispatcherMaker	GetDispatcherMaker ()
	Returns a platform-specific PointerDataDispatcherMaker so the Engine can construct the PointerDataPacketDispatcher based on platforms.
fml::WeakPtr< PlatformView >	GetWeakPtr () 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.
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.
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.
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.
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.
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.
const Settings &	GetSettings () const
	Get the settings for this platform view instance.

Static Public Member Functions
static bool	Register (JNIEnv *env)

Private Member Functions
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.
void	HandlePlatformMessage (std::unique_ptr< flutter::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.
void	OnPreEngineRestart () const override
	Gives embedders a chance to react to a "cold restart" of the running isolate. The default implementation of this method does nothing.
std::unique_ptr< VsyncWaiter >	CreateVSyncWaiter () override
	Invoked by the shell to obtain a platform specific vsync waiter. It is optional for platforms to override this method and provide a custom vsync waiter because a timer based fall-back waiter is used by default. However, it is highly recommended that platform provide their own Vsync waiter as the timer based fall-back will not render frames aligned with vsync boundaries.
std::unique_ptr< Surface >	CreateRenderingSurface () override
std::shared_ptr< ExternalViewEmbedder >	CreateExternalViewEmbedder () override
std::unique_ptr< SnapshotSurfaceProducer >	CreateSnapshotSurfaceProducer () override
	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.
sk_sp< GrDirectContext >	CreateResourceContext () const override
	Used by the shell to obtain a Skia GPU context that is capable of operating on the IO thread. The context must be in the same share-group as the Skia GPU context used on the render thread. This context will always be used on the IO thread. Because it is in the same share-group as the separate render thread context, any GPU resources uploaded in this context will be visible to the render thread context (synchronization of GPU resources is managed by Skia).
void	ReleaseResourceContext () const override
	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.
std::shared_ptr< impeller::Context >	GetImpellerContext () const override
std::unique_ptr< std::vector< std::string > >	ComputePlatformResolvedLocales (const std::vector< std::string > &supported_locale_data) override
	Directly invokes platform-specific APIs to compute the locale the platform would have natively resolved to.
void	RequestDartDeferredLibrary (intptr_t loading_unit_id) override
	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
double	GetScaledFontSize (double unscaled_font_size, int configuration_id) const override
	Synchronously invokes platform-specific APIs to apply the system text scaling on the given unscaled font size.

Additional Inherited Members
Public Types inherited from flutter::PlatformView
using	AddViewCallback = std::function< void(bool added)>
using	RemoveViewCallback = std::function< void(bool removed)>
Protected Attributes inherited from flutter::PlatformView
PlatformView::Delegate &	delegate_
const TaskRunners	task_runners_
PointerDataPacketConverter	pointer_data_packet_converter_
fml::WeakPtrFactory< PlatformView >	weak_factory_

Detailed Description

Definition at line 42 of file platform_view_android.h.

Constructor & Destructor Documentation

PlatformViewAndroid() [1/2]

flutter::PlatformViewAndroid::PlatformViewAndroid	(	PlatformView::Delegate &	delegate,
		const flutter::TaskRunners &	task_runners,
		const std::shared_ptr< PlatformViewAndroidJNI > &	jni_facade,
		bool	use_software_rendering,
		uint8_t	msaa_samples
	)

Definition at line 91 of file platform_view_android.cc.

    : PlatformViewAndroid(
          delegate,
          task_runners,
          jni_facade,
          CreateAndroidContext(
              use_software_rendering,
              task_runners,
              msaa_samples,
              delegate.OnPlatformViewGetSettings().android_rendering_api,
              delegate.OnPlatformViewGetSettings().enable_vulkan_validation,
              delegate.OnPlatformViewGetSettings().enable_opengl_gpu_tracing,
              delegate.OnPlatformViewGetSettings().enable_vulkan_gpu_tracing)) {
}

PlatformViewAndroid() [2/2]

flutter::PlatformViewAndroid::PlatformViewAndroid	(	PlatformView::Delegate &	delegate,
		const flutter::TaskRunners &	task_runners,
		const std::shared_ptr< PlatformViewAndroidJNI > &	jni_facade,
		const std::shared_ptr< flutter::AndroidContext > &	android_context
	)

Creates a new PlatformViewAndroid but using an existing Android GPU context to create new surfaces. This maximizes resource sharing between 2 PlatformViewAndroids of 2 Shells.

Definition at line 111 of file platform_view_android.cc.

    : PlatformView(delegate, task_runners),
      jni_facade_(jni_facade),
      android_context_(android_context),
      platform_view_android_delegate_(jni_facade),
      platform_message_handler_(new PlatformMessageHandlerAndroid(jni_facade)) {
  if (android_context_) {
    FML_CHECK(android_context_->IsValid())
        << "Could not create surface from invalid Android context.";
    surface_factory_ = std::make_shared<AndroidSurfaceFactoryImpl>(
        android_context_,                                     //
        delegate.OnPlatformViewGetSettings().enable_impeller  //
    );
    android_surface_ = surface_factory_->CreateSurface();
    FML_CHECK(android_surface_ && android_surface_->IsValid())
        << "Could not create an OpenGL, Vulkan or Software surface to set up "
           "rendering.";
  }
}

~PlatformViewAndroid()

flutter::PlatformViewAndroid::~PlatformViewAndroid ( )

overridedefault

Member Function Documentation

ComputePlatformResolvedLocales()

std::unique_ptr< std::vector< std::string > > flutter::PlatformViewAndroid::ComputePlatformResolvedLocales ( const std::vector< std::string > &  supported_locale_data )

overrideprivatevirtual

Directly invokes platform-specific APIs to compute the locale the platform would have natively resolved to.

Parameters

[in]

supported_locale_data

The vector of strings that represents the locales supported by the app. Each locale consists of three strings: languageCode, countryCode, and scriptCode in that order.

Returns

A vector of 3 strings languageCode, countryCode, and scriptCode that represents the locale selected by the platform. Empty strings mean the value was unassigned. Empty vector represents a null locale.

Reimplemented from flutter::PlatformView.

Definition at line 401 of file platform_view_android.cc.

                                                       {
  return jni_facade_->FlutterViewComputePlatformResolvedLocale(
      supported_locale_data);
}

CreateExternalViewEmbedder()

std::shared_ptr< ExternalViewEmbedder > flutter::PlatformViewAndroid::CreateExternalViewEmbedder ( )

overrideprivatevirtual

Reimplemented from flutter::PlatformView.

Definition at line 349 of file platform_view_android.cc.

                                                {
  return std::make_shared<AndroidExternalViewEmbedder>(
      *android_context_, jni_facade_, surface_factory_, task_runners_);
}

CreateRenderingSurface()

std::unique_ptr< Surface > flutter::PlatformViewAndroid::CreateRenderingSurface ( )

overrideprivatevirtual

Reimplemented from flutter::PlatformView.

Definition at line 339 of file platform_view_android.cc.

                                                                   {
  if (!android_surface_) {
    return nullptr;
  }
  return android_surface_->CreateGPUSurface(
      android_context_->GetMainSkiaContext().get());
}

CreateResourceContext()

sk_sp< GrDirectContext > flutter::PlatformViewAndroid::CreateResourceContext ( ) const

overrideprivatevirtual

Used by the shell to obtain a Skia GPU context that is capable of operating on the IO thread. The context must be in the same share-group as the Skia GPU context used on the render thread. This context will always be used on the IO thread. Because it is in the same share-group as the separate render thread context, any GPU resources uploaded in this context will be visible to the render thread context (synchronization of GPU resources is managed by Skia).

If such context cannot be created on the IO thread, callers may return nullptr. This will mean that all texture uploads will be queued onto the render thread which will cause performance issues. When this context is nullptr, an error is logged to the console. It is highly recommended that all platforms provide a resource context.

Attention

Unlike all other methods on the platform view, this will be called on IO task runner.

Returns

The Skia GPU context that is in the same share-group as the main render thread GPU context. May be nullptr in case such a context cannot be created.

Reimplemented from flutter::PlatformView.

Definition at line 364 of file platform_view_android.cc.

                                                                        {
  if (!android_surface_) {
    return nullptr;
  }
  sk_sp<GrDirectContext> resource_context;
  if (android_surface_->ResourceContextMakeCurrent()) {
    // TODO(chinmaygarde): Currently, this code depends on the fact that only
    // the OpenGL surface will be able to make a resource context current. If
    // this changes, this assumption breaks. Handle the same.
    resource_context = ShellIOManager::CreateCompatibleResourceLoadingContext(
        GrBackendApi::kOpenGL,
        GPUSurfaceGLDelegate::GetDefaultPlatformGLInterface());
  } else {
    FML_DLOG(ERROR) << "Could not make the resource context current.";
  }
 
  return resource_context;
}

CreateSnapshotSurfaceProducer()

std::unique_ptr< SnapshotSurfaceProducer > flutter::PlatformViewAndroid::CreateSnapshotSurfaceProducer ( )

overrideprivatevirtual

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.

Not all backends support this kind of surface usage, and the default implementation returns nullptr. Platforms should override this if they can support GPU operations in the background and support GPU resource context usage.

Reimplemented from flutter::PlatformView.

Definition at line 356 of file platform_view_android.cc.

                                                   {
  if (!android_surface_) {
    return nullptr;
  }
  return std::make_unique<AndroidSnapshotSurfaceProducer>(*android_surface_);
}

CreateVSyncWaiter()

std::unique_ptr< VsyncWaiter > flutter::PlatformViewAndroid::CreateVSyncWaiter ( )

overrideprivatevirtual

Invoked by the shell to obtain a platform specific vsync waiter. It is optional for platforms to override this method and provide a custom vsync waiter because a timer based fall-back waiter is used by default. However, it is highly recommended that platform provide their own Vsync waiter as the timer based fall-back will not render frames aligned with vsync boundaries.

Attention

If a timer based fall-back is used, a warning is logged to the console. In case this method is overridden in a subclass, it must return a valid vsync waiter. Returning null will lead to internal errors. If a valid vsync waiter cannot be returned, subclasses should just call the based class method instead.

Returns

A vsync waiter. If is an internal error to return a null waiter.

Reimplemented from flutter::PlatformView.

Definition at line 334 of file platform_view_android.cc.

                                                                  {
  return std::make_unique<VsyncWaiterAndroid>(task_runners_);
}

DispatchEmptyPlatformMessage()

void flutter::PlatformViewAndroid::DispatchEmptyPlatformMessage	(	JNIEnv *	env,
		std::string	name,
		jint	response_id
	)

Definition at line 224 of file platform_view_android.cc.

                                                                         {
  fml::RefPtr<flutter::PlatformMessageResponse> response;
  if (response_id) {
    response = fml::MakeRefCounted<PlatformMessageResponseAndroid>(
        response_id, jni_facade_, task_runners_.GetPlatformTaskRunner());
  }
 
  PlatformView::DispatchPlatformMessage(
      std::make_unique<flutter::PlatformMessage>(std::move(name),
                                                 std::move(response)));
}

DispatchPlatformMessage()

void flutter::PlatformViewAndroid::DispatchPlatformMessage	(	JNIEnv *	env,
		std::string	name,
		jobject	message_data,
		jint	message_position,
		jint	response_id
	)

Definition at line 203 of file platform_view_android.cc.

                                                                    {
  uint8_t* message_data =
      static_cast<uint8_t*>(env->GetDirectBufferAddress(java_message_data));
  fml::MallocMapping message =
      fml::MallocMapping::Copy(message_data, java_message_position);
 
  fml::RefPtr<flutter::PlatformMessageResponse> response;
  if (response_id) {
    response = fml::MakeRefCounted<PlatformMessageResponseAndroid>(
        response_id, jni_facade_, task_runners_.GetPlatformTaskRunner());
  }
 
  PlatformView::DispatchPlatformMessage(
      std::make_unique<flutter::PlatformMessage>(
          std::move(name), std::move(message), std::move(response)));
}

DispatchSemanticsAction()

void flutter::PlatformViewAndroid::DispatchSemanticsAction	(	JNIEnv *	env,
		jint	id,
		jint	action,
		jobject	args,
		jint	args_position
	)

Definition at line 250 of file platform_view_android.cc.

                                                                      {
  if (env->IsSameObject(args, NULL)) {
    PlatformView::DispatchSemanticsAction(
        id, static_cast<flutter::SemanticsAction>(action),
        fml::MallocMapping());
    return;
  }
 
  uint8_t* args_data = static_cast<uint8_t*>(env->GetDirectBufferAddress(args));
  auto args_vector = fml::MallocMapping::Copy(args_data, args_position);
 
  PlatformView::DispatchSemanticsAction(
      id, static_cast<flutter::SemanticsAction>(action),
      std::move(args_vector));
}

GetAndroidContext()

const std::shared_ptr< AndroidContext > & flutter::PlatformViewAndroid::GetAndroidContext ( )

inline

Definition at line 114 of file platform_view_android.h.

                                                           {
    return android_context_;
  }

GetImpellerContext()

std::shared_ptr< impeller::Context > flutter::PlatformViewAndroid::GetImpellerContext ( ) const

overrideprivatevirtual

Reimplemented from flutter::PlatformView.

Definition at line 391 of file platform_view_android.cc.

          {
  if (android_surface_) {
    return android_surface_->GetImpellerContext();
  }
  return nullptr;
}

GetPlatformMessageHandler()

std::shared_ptr< PlatformMessageHandler > flutter::PlatformViewAndroid::GetPlatformMessageHandler ( ) const

inlineoverridevirtual

Specifies a delegate that will receive PlatformMessages from Flutter to the host platform.

If this returns null that means PlatformMessages should be sent to the PlatformView. That is to protect legacy behavior, any embedder that wants to support executing Platform Channel handlers on background threads should be returning a thread-safe PlatformMessageHandler instead.

Reimplemented from flutter::PlatformView.

Definition at line 118 of file platform_view_android.h.

                     {
    return platform_message_handler_;
  }

GetScaledFontSize()

double flutter::PlatformViewAndroid::GetScaledFontSize ( double  unscaled_font_size, int  configuration_id  ) const

overrideprivatevirtual

Synchronously invokes platform-specific APIs to apply the system text scaling on the given unscaled font size.

Platforms that support this feature (currently it's only implemented for Android SDK level 34+) will send a valid configuration_id to potential callers, before this method can be called.

Parameters

[in]	unscaled_font_size	The unscaled font size specified by the app developer. The value is in logical pixels, and is guaranteed to be finite and non-negative.
[in]	configuration_id	The unique id of the configuration to use for computing the scaled font size.

Returns

The scaled font size in logical pixels, or -1 if the given configuration_id did not match a valid configuration.

Reimplemented from flutter::PlatformView.

Definition at line 460 of file platform_view_android.cc.

                                                                          {
  return jni_facade_->FlutterViewGetScaledFontSize(unscaled_font_size,
                                                   configuration_id);
}

HandlePlatformMessage()

void flutter::PlatformViewAndroid::HandlePlatformMessage ( std::unique_ptr< flutter::PlatformMessage >  message )

overrideprivatevirtual

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

DispatchPlatformMessage()

Parameters

[in]

message

The message

Reimplemented from flutter::PlatformView.

Definition at line 239 of file platform_view_android.cc.

                                                   {
  // Called from the ui thread.
  platform_message_handler_->HandlePlatformMessage(std::move(message));
}

LoadDartDeferredLibrary()

void flutter::PlatformViewAndroid::LoadDartDeferredLibrary ( intptr_t  loading_unit_id, std::unique_ptr< const fml::Mapping >  snapshot_data, std::unique_ptr< const fml::Mapping >  snapshot_instructions  )

overridevirtual

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.

The Dart compiler may generate separate shared libraries files called 'loading units' when libraries are imported as deferred. Each of these shared libraries are identified by a unique loading unit id. Callers should open and resolve a SymbolMapping from the shared library. The Mappings should be moved into this method, as ownership will be assumed by the dart isolate after successful loading and released after shutdown of the dart isolate. If loading fails, the mappings will naturally go out of scope.

This method is paired with a RequestDartDeferredLibrary invocation that provides the embedder with the loading unit id of the deferred library to load.

Parameters

[in]	loading_unit_id	The unique id of the deferred library's loading unit, as passed in by RequestDartDeferredLibrary.
[in]	snapshot_data	Dart snapshot data of the loading unit's shared library.
[in]	snapshot_data	Dart snapshot instructions of the loading unit's shared library.

Reimplemented from flutter::PlatformView.

Definition at line 416 of file platform_view_android.cc.

                                                           {
  delegate_.LoadDartDeferredLibrary(loading_unit_id, std::move(snapshot_data),
                                    std::move(snapshot_instructions));
}

LoadDartDeferredLibraryError()

void flutter::PlatformViewAndroid::LoadDartDeferredLibraryError ( intptr_t  loading_unit_id, const std::string  error_message, bool  transient  )

overridevirtual

Indicates to the dart VM that the request to load a deferred library with the specified loading unit id has failed.

The dart future returned by the initiating loadLibrary() call will complete with an error.

Parameters

[in]	loading_unit_id	The unique id of the deferred library's loading unit, as passed in by RequestDartDeferredLibrary.
[in]	error_message	The error message that will appear in the dart Future.
[in]	transient	A transient error is a failure due to temporary conditions such as no network. Transient errors allow the dart VM to re-request the same deferred library and loading_unit_id again. Non-transient errors are permanent and attempts to re-request the library will instantly complete with an error.

Reimplemented from flutter::PlatformView.

Definition at line 425 of file platform_view_android.cc.

                    {
  delegate_.LoadDartDeferredLibraryError(loading_unit_id, error_message,
                                         transient);
}

NotifyChanged()

void flutter::PlatformViewAndroid::NotifyChanged

(

const SkISize &

size

)

Definition at line 189 of file platform_view_android.cc.

                                                           {
  if (!android_surface_) {
    return;
  }
  fml::AutoResetWaitableEvent latch;
  fml::TaskRunner::RunNowOrPostTask(
      task_runners_.GetRasterTaskRunner(),  //
      [&latch, surface = android_surface_.get(), size]() {
        surface->OnScreenSurfaceResize(size);
        latch.Signal();
      });
  latch.Wait();
}

NotifyCreated()

void flutter::PlatformViewAndroid::NotifyCreated

(

fml::RefPtr< AndroidNativeWindow >

native_window

)

Definition at line 137 of file platform_view_android.cc.

                                                  {
  if (android_surface_) {
    InstallFirstFrameCallback();
 
    fml::AutoResetWaitableEvent latch;
    fml::TaskRunner::RunNowOrPostTask(
        task_runners_.GetRasterTaskRunner(),
        [&latch, surface = android_surface_.get(),
         native_window = std::move(native_window)]() {
          surface->SetNativeWindow(native_window);
          latch.Signal();
        });
    latch.Wait();
  }
 
  PlatformView::NotifyCreated();
}

NotifyDestroyed()

void flutter::PlatformViewAndroid::NotifyDestroyed ( )

overridevirtual

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.

Attention

Subclasses may choose to override this method to perform platform specific functions. However, they must call the base class method at some point in their implementation.

Reimplemented from flutter::PlatformView.

Definition at line 174 of file platform_view_android.cc.

                                          {
  PlatformView::NotifyDestroyed();
 
  if (android_surface_) {
    fml::AutoResetWaitableEvent latch;
    fml::TaskRunner::RunNowOrPostTask(
        task_runners_.GetRasterTaskRunner(),
        [&latch, surface = android_surface_.get()]() {
          surface->TeardownOnScreenContext();
          latch.Signal();
        });
    latch.Wait();
  }
}

NotifySurfaceWindowChanged()

void flutter::PlatformViewAndroid::NotifySurfaceWindowChanged

(

fml::RefPtr< AndroidNativeWindow >

native_window

)

Definition at line 156 of file platform_view_android.cc.

                                                  {
  if (android_surface_) {
    fml::AutoResetWaitableEvent latch;
    fml::TaskRunner::RunNowOrPostTask(
        task_runners_.GetRasterTaskRunner(),
        [&latch, surface = android_surface_.get(),
         native_window = std::move(native_window)]() {
          surface->TeardownOnScreenContext();
          surface->SetNativeWindow(native_window);
          latch.Signal();
        });
    latch.Wait();
  }
 
  PlatformView::ScheduleFrame();
}

OnPreEngineRestart()

void flutter::PlatformViewAndroid::OnPreEngineRestart ( ) const

overrideprivatevirtual

Gives embedders a chance to react to a "cold restart" of the running isolate. The default implementation of this method does nothing.

While a "hot restart" patches a running isolate, a "cold restart" restarts the root isolate in a running shell.

Reimplemented from flutter::PlatformView.

Definition at line 246 of file platform_view_android.cc.

                                                   {
  jni_facade_->FlutterViewOnPreEngineRestart();
}

Register()

bool flutter::PlatformViewAndroid::Register ( JNIEnv *  env )

static

Definition at line 1027 of file platform_view_android_jni_impl.cc.

                                              {
  if (env == nullptr) {
    FML_LOG(ERROR) << "No JNIEnv provided";
    return false;
  }
 
  g_flutter_callback_info_class = new fml::jni::ScopedJavaGlobalRef<jclass>(
      env, env->FindClass("io/flutter/view/FlutterCallbackInformation"));
  if (g_flutter_callback_info_class->is_null()) {
    FML_LOG(ERROR) << "Could not locate FlutterCallbackInformation class";
    return false;
  }
 
  g_flutter_callback_info_constructor = env->GetMethodID(
      g_flutter_callback_info_class->obj(), "<init>",
      "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V");
  if (g_flutter_callback_info_constructor == nullptr) {
    FML_LOG(ERROR) << "Could not locate FlutterCallbackInformation constructor";
    return false;
  }
 
  g_flutter_jni_class = new fml::jni::ScopedJavaGlobalRef<jclass>(
      env, env->FindClass("io/flutter/embedding/engine/FlutterJNI"));
  if (g_flutter_jni_class->is_null()) {
    FML_LOG(ERROR) << "Failed to find FlutterJNI Class.";
    return false;
  }
 
  g_mutators_stack_class = new fml::jni::ScopedJavaGlobalRef<jclass>(
      env,
      env->FindClass(
          "io/flutter/embedding/engine/mutatorsstack/FlutterMutatorsStack"));
  if (g_mutators_stack_class == nullptr) {
    FML_LOG(ERROR) << "Could not locate FlutterMutatorsStack";
    return false;
  }
 
  g_mutators_stack_init_method =
      env->GetMethodID(g_mutators_stack_class->obj(), "<init>", "()V");
  if (g_mutators_stack_init_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate FlutterMutatorsStack.init method";
    return false;
  }
 
  g_mutators_stack_push_transform_method =
      env->GetMethodID(g_mutators_stack_class->obj(), "pushTransform", "([F)V");
  if (g_mutators_stack_push_transform_method == nullptr) {
    FML_LOG(ERROR)
        << "Could not locate FlutterMutatorsStack.pushTransform method";
    return false;
  }
 
  g_mutators_stack_push_cliprect_method = env->GetMethodID(
      g_mutators_stack_class->obj(), "pushClipRect", "(IIII)V");
  if (g_mutators_stack_push_cliprect_method == nullptr) {
    FML_LOG(ERROR)
        << "Could not locate FlutterMutatorsStack.pushClipRect method";
    return false;
  }
 
  g_mutators_stack_push_cliprrect_method = env->GetMethodID(
      g_mutators_stack_class->obj(), "pushClipRRect", "(IIII[F)V");
  if (g_mutators_stack_push_cliprrect_method == nullptr) {
    FML_LOG(ERROR)
        << "Could not locate FlutterMutatorsStack.pushClipRRect method";
    return false;
  }
 
  g_on_display_platform_view_method =
      env->GetMethodID(g_flutter_jni_class->obj(), "onDisplayPlatformView",
                       "(IIIIIIILio/flutter/embedding/engine/mutatorsstack/"
                       "FlutterMutatorsStack;)V");
 
  if (g_on_display_platform_view_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate onDisplayPlatformView method";
    return false;
  }
 
  g_on_begin_frame_method =
      env->GetMethodID(g_flutter_jni_class->obj(), "onBeginFrame", "()V");
 
  if (g_on_begin_frame_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate onBeginFrame method";
    return false;
  }
 
  g_on_end_frame_method =
      env->GetMethodID(g_flutter_jni_class->obj(), "onEndFrame", "()V");
 
  if (g_on_end_frame_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate onEndFrame method";
    return false;
  }
 
  g_on_display_overlay_surface_method = env->GetMethodID(
      g_flutter_jni_class->obj(), "onDisplayOverlaySurface", "(IIIII)V");
 
  if (g_on_display_overlay_surface_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate onDisplayOverlaySurface method";
    return false;
  }
 
  g_java_weak_reference_class = new fml::jni::ScopedJavaGlobalRef<jclass>(
      env, env->FindClass("java/lang/ref/WeakReference"));
  if (g_java_weak_reference_class->is_null()) {
    FML_LOG(ERROR) << "Could not locate WeakReference class";
    return false;
  }
 
  g_java_weak_reference_get_method = env->GetMethodID(
      g_java_weak_reference_class->obj(), "get", "()Ljava/lang/Object;");
  if (g_java_weak_reference_get_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate WeakReference.get method";
    return false;
  }
 
  g_texture_wrapper_class = new fml::jni::ScopedJavaGlobalRef<jclass>(
      env, env->FindClass(
               "io/flutter/embedding/engine/renderer/SurfaceTextureWrapper"));
  if (g_texture_wrapper_class->is_null()) {
    FML_LOG(ERROR) << "Could not locate SurfaceTextureWrapper class";
    return false;
  }
 
  g_attach_to_gl_context_method = env->GetMethodID(
      g_texture_wrapper_class->obj(), "attachToGLContext", "(I)V");
 
  if (g_attach_to_gl_context_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate attachToGlContext method";
    return false;
  }
 
  g_surface_texture_wrapper_should_update =
      env->GetMethodID(g_texture_wrapper_class->obj(), "shouldUpdate", "()Z");
 
  if (g_surface_texture_wrapper_should_update == nullptr) {
    FML_LOG(ERROR)
        << "Could not locate SurfaceTextureWrapper.shouldUpdate method";
    return false;
  }
 
  g_update_tex_image_method =
      env->GetMethodID(g_texture_wrapper_class->obj(), "updateTexImage", "()V");
 
  if (g_update_tex_image_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate updateTexImage method";
    return false;
  }
 
  g_get_transform_matrix_method = env->GetMethodID(
      g_texture_wrapper_class->obj(), "getTransformMatrix", "([F)V");
 
  if (g_get_transform_matrix_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate getTransformMatrix method";
    return false;
  }
 
  g_detach_from_gl_context_method = env->GetMethodID(
      g_texture_wrapper_class->obj(), "detachFromGLContext", "()V");
 
  if (g_detach_from_gl_context_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate detachFromGlContext method";
    return false;
  }
  g_image_consumer_texture_registry_interface =
      new fml::jni::ScopedJavaGlobalRef<jclass>(
          env, env->FindClass("io/flutter/view/TextureRegistry$ImageConsumer"));
  if (g_image_consumer_texture_registry_interface->is_null()) {
    FML_LOG(ERROR) << "Could not locate TextureRegistry.ImageConsumer class";
    return false;
  }
 
  g_acquire_latest_image_method =
      env->GetMethodID(g_image_consumer_texture_registry_interface->obj(),
                       "acquireLatestImage", "()Landroid/media/Image;");
  if (g_acquire_latest_image_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate acquireLatestImage on "
                      "TextureRegistry.ImageConsumer class";
    return false;
  }
 
  g_image_class = new fml::jni::ScopedJavaGlobalRef<jclass>(
      env, env->FindClass("android/media/Image"));
  if (g_image_class->is_null()) {
    FML_LOG(ERROR) << "Could not locate Image class";
    return false;
  }
 
  // Ensure we don't have any pending exceptions.
  FML_CHECK(fml::jni::CheckException(env));
 
  g_image_get_hardware_buffer_method =
      env->GetMethodID(g_image_class->obj(), "getHardwareBuffer",
                       "()Landroid/hardware/HardwareBuffer;");
 
  if (g_image_get_hardware_buffer_method == nullptr) {
    // Continue on as this method may not exist at API <= 29.
    fml::jni::ClearException(env, true);
  }
 
  g_image_close_method = env->GetMethodID(g_image_class->obj(), "close", "()V");
 
  if (g_image_close_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate close on Image class";
    return false;
  }
 
  // Ensure we don't have any pending exceptions.
  FML_CHECK(fml::jni::CheckException(env));
  g_hardware_buffer_class = new fml::jni::ScopedJavaGlobalRef<jclass>(
      env, env->FindClass("android/hardware/HardwareBuffer"));
 
  if (!g_hardware_buffer_class->is_null()) {
    g_hardware_buffer_close_method =
        env->GetMethodID(g_hardware_buffer_class->obj(), "close", "()V");
    if (g_hardware_buffer_close_method == nullptr) {
      // Continue on as this class may not exist at API <= 26.
      fml::jni::ClearException(env, true);
    }
  } else {
    // Continue on as this class may not exist at API <= 26.
    fml::jni::ClearException(env, true);
  }
 
  g_compute_platform_resolved_locale_method = env->GetMethodID(
      g_flutter_jni_class->obj(), "computePlatformResolvedLocale",
      "([Ljava/lang/String;)[Ljava/lang/String;");
 
  if (g_compute_platform_resolved_locale_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate computePlatformResolvedLocale method";
    return false;
  }
 
  g_request_dart_deferred_library_method = env->GetMethodID(
      g_flutter_jni_class->obj(), "requestDartDeferredLibrary", "(I)V");
 
  if (g_request_dart_deferred_library_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate requestDartDeferredLibrary method";
    return false;
  }
 
  g_java_long_class = new fml::jni::ScopedJavaGlobalRef<jclass>(
      env, env->FindClass("java/lang/Long"));
  if (g_java_long_class->is_null()) {
    FML_LOG(ERROR) << "Could not locate java.lang.Long class";
    return false;
  }
 
  return RegisterApi(env);
}

RegisterExternalTexture()

void flutter::PlatformViewAndroid::RegisterExternalTexture	(	int64_t	texture_id,
		const fml::jni::ScopedJavaGlobalRef< jobject > &	surface_texture
	)

Definition at line 277 of file platform_view_android.cc.

                                                               {
  switch (android_context_->RenderingApi()) {
    case AndroidRenderingAPI::kImpellerOpenGLES:
      // Impeller GLES.
      RegisterTexture(std::make_shared<SurfaceTextureExternalTextureImpellerGL>(
          std::static_pointer_cast<impeller::ContextGLES>(
              android_context_->GetImpellerContext()),
          texture_id, surface_texture, jni_facade_));
      break;
    case AndroidRenderingAPI::kSkiaOpenGLES:
      // Legacy GL.
      RegisterTexture(std::make_shared<SurfaceTextureExternalTextureGL>(
          texture_id, surface_texture, jni_facade_));
      break;
    case AndroidRenderingAPI::kSoftware:
    case AndroidRenderingAPI::kImpellerVulkan:
      FML_LOG(INFO)
          << "Attempted to use a SurfaceTextureExternalTexture with an "
             "unsupported rendering API.";
      break;
  }
}

RegisterImageTexture()

void flutter::PlatformViewAndroid::RegisterImageTexture	(	int64_t	texture_id,
		const fml::jni::ScopedJavaGlobalRef< jobject > &	image_texture_entry
	)

Definition at line 302 of file platform_view_android.cc.

                                                                   {
  switch (android_context_->RenderingApi()) {
    case AndroidRenderingAPI::kImpellerOpenGLES:
      // Impeller GLES.
      RegisterTexture(std::make_shared<ImageExternalTextureGLImpeller>(
          std::static_pointer_cast<impeller::ContextGLES>(
              android_context_->GetImpellerContext()),
          texture_id, image_texture_entry, jni_facade_));
      break;
    case AndroidRenderingAPI::kSkiaOpenGLES:
      // Legacy GL.
      RegisterTexture(std::make_shared<ImageExternalTextureGLSkia>(
          std::static_pointer_cast<AndroidContextGLSkia>(android_context_),
          texture_id, image_texture_entry, jni_facade_));
      break;
    case AndroidRenderingAPI::kImpellerVulkan:
      RegisterTexture(std::make_shared<ImageExternalTextureVK>(
          std::static_pointer_cast<impeller::ContextVK>(
              android_context_->GetImpellerContext()),
          texture_id, image_texture_entry, jni_facade_));
      break;
    case AndroidRenderingAPI::kSoftware:
      FML_LOG(INFO)
          << "Attempted to use a SurfaceTextureExternalTexture with an "
             "unsupported rendering API.";
      break;
  }
}

ReleaseResourceContext()

void flutter::PlatformViewAndroid::ReleaseResourceContext ( ) const

overrideprivatevirtual

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.

Attention

Unlike all other methods on the platform view, this will be called on IO task runner.

Reimplemented from flutter::PlatformView.

Definition at line 384 of file platform_view_android.cc.

                                                       {
  if (android_surface_) {
    android_surface_->ResourceContextClearCurrent();
  }
}

RequestDartDeferredLibrary()

void flutter::PlatformViewAndroid::RequestDartDeferredLibrary ( intptr_t  loading_unit_id )

overrideprivatevirtual

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

Upon encountering errors or otherwise failing to load a loading unit with the specified id, the failure should be directly reported to dart by calling LoadDartDeferredLibraryFailure to ensure the waiting dart future completes with an error.

Parameters

[in]

loading_unit_id

The unique id of the deferred library's loading unit. This id is to be passed back into LoadDartDeferredLibrary in order to identify which deferred library to load.

Reimplemented from flutter::PlatformView.

Definition at line 408 of file platform_view_android.cc.

                                                                             {
  if (jni_facade_->RequestDartDeferredLibrary(loading_unit_id)) {
    return;
  }
  return;  // TODO(garyq): Call LoadDartDeferredLibraryFailure()
}

UpdateAssetResolverByType()

void flutter::PlatformViewAndroid::UpdateAssetResolverByType ( std::unique_ptr< AssetResolver >  updated_asset_resolver, AssetResolver::AssetResolverType  type  )

overridevirtual

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.

AssetResolvers should be updated when the existing resolver becomes obsolete and a newer one becomes available that provides updated access to the same type of assets as the existing one. This update process is meant to be performed at runtime.

If a null resolver is provided, nothing will be done. If no matching resolver is found, the provided resolver will be added to the end of the AssetManager resolvers queue. The replacement only occurs with the first matching resolver. Any additional matching resolvers are untouched.

Parameters

[in]	updated_asset_resolver	The asset resolver to replace the resolver of matching type with.
[in]	type	The type of AssetResolver to update. Only resolvers of the specified type will be replaced by the updated resolver.

Reimplemented from flutter::PlatformView.

Definition at line 434 of file platform_view_android.cc.

                                         {
  delegate_.UpdateAssetResolverByType(std::move(updated_asset_resolver), type);
}

UpdateSemantics()

void flutter::PlatformViewAndroid::UpdateSemantics ( flutter::SemanticsNodeUpdates  updates, flutter::CustomAccessibilityActionUpdates  actions  )

overrideprivatevirtual

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

Parameters

[in]	updates	A map with the stable semantics node identifier as key and the node properties as the value.
[in]	actions	A map with the stable semantics node identifier as key and the custom node action as the value.

Reimplemented from flutter::PlatformView.

Definition at line 271 of file platform_view_android.cc.

                                                     {
  platform_view_android_delegate_.UpdateSemantics(update, actions);
}

---

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

• shell/platform/android/platform_view_android.h
• shell/platform/android/platform_view_android.cc
• shell/platform/android/platform_view_android_jni_impl.cc