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, AndroidRenderingAPI rendering_api)
	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 DlISize &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, ImageExternalTexture::ImageLifecycle lifecycle)
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.
bool	IsSurfaceControlEnabled () const
	Whether the SurfaceControl based swapchain is enabled and active.
void	SetupImpellerContext () override
	Performs any deferred setup of the Impeller context.
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.
virtual void	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.
void	DispatchSemanticsAction (int64_t view_id, 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.
void	SendViewFocusEvent (const ViewFocusEvent &event)
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.
HitTestResponse	HitTest (int64_t view_id, const flutter::PointData offset)
	Requests to perform framework hit test from the engine.
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.
virtual void	RequestViewFocusChange (const ViewFocusChangeRequest &request)
	Notifies the client that the Flutter view focus state has changed and the platform view should be updated.

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

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_
fml::WeakPtrFactory< PlatformView >	weak_factory_

Detailed Description

Definition at line 43 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,
		AndroidRenderingAPI	rendering_api
	)

Definition at line 135 of file platform_view_android.cc.

    : PlatformViewAndroid(
          delegate,
          task_runners,
          jni_facade,
          CreateAndroidContext(
              task_runners,
              rendering_api,
              delegate.OnPlatformViewGetSettings().enable_opengl_gpu_tracing,
              CreateContextSettings(delegate.OnPlatformViewGetSettings()))) {}

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 150 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,  //
        delegate.OnPlatformViewGetSettings()
            .impeller_enable_lazy_shader_mode  //
    );
    android_surface_ = surface_factory_->CreateSurface();
    android_meets_hcpp_criteria_ =
        delegate.OnPlatformViewGetSettings().enable_surface_control &&
        android_get_device_api_level() >= kMinAPILevelHCPP &&
        delegate.OnPlatformViewGetSettings().enable_impeller;
    FML_CHECK(android_surface_ && android_surface_->IsValid())
        << "Could not create an OpenGL, Vulkan or Software surface to set "
           "up "
           "rendering.";
  }
}

References flutter::Settings::enable_impeller, flutter::Settings::enable_surface_control, FML_CHECK, flutter::Settings::impeller_enable_lazy_shader_mode, and flutter::PlatformView::Delegate::OnPlatformViewGetSettings().

~PlatformViewAndroid()

flutter::PlatformViewAndroid::~PlatformViewAndroid ( )

overridedefault

Member Function Documentation

DispatchEmptyPlatformMessage()

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

Definition at line 270 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)));
}

References flutter::PlatformView::DispatchPlatformMessage(), flutter::TaskRunners::GetPlatformTaskRunner(), flutter::name, and flutter::PlatformView::task_runners_.

DispatchPlatformMessage()

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

Definition at line 249 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)));
}

References fml::MallocMapping::Copy(), flutter::PlatformView::DispatchPlatformMessage(), flutter::TaskRunners::GetPlatformTaskRunner(), message, flutter::name, and flutter::PlatformView::task_runners_.

DispatchSemanticsAction()

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

Definition at line 296 of file platform_view_android.cc.

                                                                      {
  // TODO(team-android): Remove implicit view assumption.
  // https://github.com/flutter/flutter/issues/142845
  if (env->IsSameObject(args, NULL)) {
    PlatformView::DispatchSemanticsAction(
        kImplicitViewId, node_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(
      kImplicitViewId, node_id, static_cast<flutter::SemanticsAction>(action),
      std::move(args_vector));
}

References action, args, fml::MallocMapping::Copy(), flutter::PlatformView::DispatchSemanticsAction(), and flutter::kImplicitViewId.

GetAndroidContext()

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

inline

Definition at line 115 of file platform_view_android.h.

                                                           {
    return android_context_;
  }

Referenced by flutter::AndroidShellHolder::Spawn().

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 119 of file platform_view_android.h.

                     {
    return platform_message_handler_;
  }

IsSurfaceControlEnabled()

bool flutter::PlatformViewAndroid::IsSurfaceControlEnabled

(

)

const

Whether the SurfaceControl based swapchain is enabled and active.

Definition at line 557 of file platform_view_android.cc.

                                                        {
  // This needs to know if we're actually using HCPP.
  return android_meets_hcpp_criteria_ &&
         android_context_->RenderingApi() ==
             AndroidRenderingAPI::kImpellerVulkan &&
         impeller::ContextVK::Cast(*android_context_->GetImpellerContext())
             .GetShouldEnableSurfaceControlSwapchain();
}

References impeller::BackendCast< ContextVK, Context >::Cast(), and impeller::ContextVK::GetShouldEnableSurfaceControlSwapchain().

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 507 of file platform_view_android.cc.

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

References flutter::PlatformView::delegate_, and flutter::PlatformView::Delegate::LoadDartDeferredLibrary().

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 516 of file platform_view_android.cc.

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

References flutter::PlatformView::delegate_, and flutter::PlatformView::Delegate::LoadDartDeferredLibraryError().

NotifyChanged()

void flutter::PlatformViewAndroid::NotifyChanged

(

const DlISize &

size

)

Definition at line 235 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();
}

References flutter::TaskRunners::GetRasterTaskRunner(), fml::TaskRunner::RunNowOrPostTask(), flutter::size, surface, flutter::PlatformView::task_runners_, and fml::AutoResetWaitableEvent::Wait().

NotifyCreated()

void flutter::PlatformViewAndroid::NotifyCreated

(

fml::RefPtr< AndroidNativeWindow >

native_window

)

Definition at line 183 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), jni_facade = jni_facade_]() {
          surface->SetNativeWindow(native_window, jni_facade);
          latch.Signal();
        });
    latch.Wait();
  }
 
  PlatformView::NotifyCreated();
}

References flutter::TaskRunners::GetRasterTaskRunner(), flutter::PlatformView::NotifyCreated(), fml::TaskRunner::RunNowOrPostTask(), surface, flutter::PlatformView::task_runners_, and fml::AutoResetWaitableEvent::Wait().

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 220 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();
  }
}

References flutter::TaskRunners::GetRasterTaskRunner(), flutter::PlatformView::NotifyDestroyed(), fml::TaskRunner::RunNowOrPostTask(), surface, flutter::PlatformView::task_runners_, and fml::AutoResetWaitableEvent::Wait().

NotifySurfaceWindowChanged()

void flutter::PlatformViewAndroid::NotifySurfaceWindowChanged

(

fml::RefPtr< AndroidNativeWindow >

native_window

)

Definition at line 202 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), jni_facade = jni_facade_]() {
          surface->TeardownOnScreenContext();
          surface->SetNativeWindow(native_window, jni_facade);
          latch.Signal();
        });
    latch.Wait();
  }
 
  PlatformView::ScheduleFrame();
}

References flutter::TaskRunners::GetRasterTaskRunner(), fml::TaskRunner::RunNowOrPostTask(), flutter::PlatformView::ScheduleFrame(), surface, flutter::PlatformView::task_runners_, and fml::AutoResetWaitableEvent::Wait().

Register()

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

static

Definition at line 1028 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_mutators_stack_push_opacity_method =
      env->GetMethodID(g_mutators_stack_class->obj(), "pushOpacity", "(F)V");
  if (g_mutators_stack_push_opacity_method == nullptr) {
    FML_LOG(ERROR)
        << "Could not locate FlutterMutatorsStack.pushOpacity method";
    return false;
  }
 
  g_mutators_stack_push_clippath_method =
      env->GetMethodID(g_mutators_stack_class->obj(), "pushClipPath",
                       "(Landroid/graphics/Path;)V");
  if (g_mutators_stack_push_clippath_method == nullptr) {
    FML_LOG(ERROR)
        << "Could not locate FlutterMutatorsStack.pushClipPath 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;
  }
 
  // Android path class and methods.
  path_class = new fml::jni::ScopedJavaGlobalRef<jclass>(
      env, env->FindClass("android/graphics/Path"));
  if (path_class->is_null()) {
    FML_LOG(ERROR) << "Could not locate android.graphics.Path class";
    return false;
  }
 
  path_constructor = env->GetMethodID(path_class->obj(), "<init>", "()V");
  if (path_constructor == nullptr) {
    FML_LOG(ERROR) << "Could not locate android.graphics.Path constructor";
    return false;
  }
 
  path_set_fill_type_method = env->GetMethodID(
      path_class->obj(), "setFillType", "(Landroid/graphics/Path$FillType;)V");
  if (path_set_fill_type_method == nullptr) {
    FML_LOG(ERROR)
        << "Could not locate android.graphics.Path.setFillType method";
    return false;
  }
 
  path_move_to_method = env->GetMethodID(path_class->obj(), "moveTo", "(FF)V");
  if (path_move_to_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate android.graphics.Path.moveTo method";
    return false;
  }
  path_line_to_method = env->GetMethodID(path_class->obj(), "lineTo", "(FF)V");
  if (path_line_to_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate android.graphics.Path.lineTo method";
    return false;
  }
  path_quad_to_method =
      env->GetMethodID(path_class->obj(), "quadTo", "(FFFF)V");
  if (path_quad_to_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate android.graphics.Path.quadTo method";
    return false;
  }
  path_cubic_to_method =
      env->GetMethodID(path_class->obj(), "cubicTo", "(FFFFFF)V");
  if (path_cubic_to_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate android.graphics.Path.cubicTo method";
    return false;
  }
  // Ensure we don't have any pending exceptions.
  FML_CHECK(fml::jni::CheckException(env));
 
  path_conic_to_method =
      env->GetMethodID(path_class->obj(), "conicTo", "(FFFFF)V");
  if (path_conic_to_method == nullptr) {
    // Continue on as this method may not exist at API <= 34.
    fml::jni::ClearException(env, true);
  }
  path_close_method = env->GetMethodID(path_class->obj(), "close", "()V");
  if (path_close_method == nullptr) {
    FML_LOG(ERROR) << "Could not locate android.graphics.Path.close method";
    return false;
  }
 
  g_path_fill_type_class = new fml::jni::ScopedJavaGlobalRef<jclass>(
      env, env->FindClass("android/graphics/Path$FillType"));
  if (g_path_fill_type_class->is_null()) {
    FML_LOG(ERROR) << "Could not locate android.graphics.Path$FillType class";
    return false;
  }
 
  g_path_fill_type_winding_field =
      env->GetStaticFieldID(g_path_fill_type_class->obj(), "WINDING",
                            "Landroid/graphics/Path$FillType;");
  if (g_path_fill_type_winding_field == nullptr) {
    FML_LOG(ERROR) << "Could not locate Path.FillType.WINDING field";
    return false;
  }
 
  g_path_fill_type_even_odd_field =
      env->GetStaticFieldID(g_path_fill_type_class->obj(), "EVEN_ODD",
                            "Landroid/graphics/Path$FillType;");
  if (g_path_fill_type_even_odd_field == nullptr) {
    FML_LOG(ERROR) << "Could not locate Path.FillType.EVEN_ODD field";
    return false;
  }
 
  return RegisterApi(env);
}

References fml::jni::CheckException(), fml::jni::ClearException(), FML_CHECK, FML_LOG, flutter::g_acquire_latest_image_method, flutter::g_attach_to_gl_context_method, flutter::g_compute_platform_resolved_locale_method, flutter::g_detach_from_gl_context_method, flutter::g_flutter_callback_info_class, flutter::g_flutter_callback_info_constructor, flutter::g_flutter_jni_class, flutter::g_get_transform_matrix_method, flutter::g_hardware_buffer_class, flutter::g_hardware_buffer_close_method, flutter::g_image_class, flutter::g_image_close_method, flutter::g_image_consumer_texture_registry_interface, flutter::g_image_get_hardware_buffer_method, flutter::g_java_long_class, flutter::g_java_weak_reference_class, flutter::g_java_weak_reference_get_method, flutter::g_mutators_stack_class, flutter::g_mutators_stack_init_method, flutter::g_mutators_stack_push_clippath_method, flutter::g_mutators_stack_push_cliprect_method, flutter::g_mutators_stack_push_cliprrect_method, flutter::g_mutators_stack_push_opacity_method, flutter::g_mutators_stack_push_transform_method, flutter::g_path_fill_type_class, flutter::g_path_fill_type_even_odd_field, flutter::g_path_fill_type_winding_field, flutter::g_request_dart_deferred_library_method, flutter::g_surface_texture_wrapper_should_update, flutter::g_texture_wrapper_class, flutter::g_update_tex_image_method, flutter::path_class, flutter::path_close_method, flutter::path_conic_to_method, flutter::path_constructor, flutter::path_cubic_to_method, flutter::path_line_to_method, flutter::path_move_to_method, flutter::path_quad_to_method, flutter::path_set_fill_type_method, and flutter::RegisterApi().

Referenced by JNI_OnLoad().

RegisterExternalTexture()

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

Definition at line 336 of file platform_view_android.cc.

                                                               {
  switch (android_context_->RenderingApi()) {
    case AndroidRenderingAPI::kImpellerOpenGLES:
      // Impeller GLES.
      RegisterTexture(std::make_shared<SurfaceTextureExternalTextureGLImpeller>(
          std::static_pointer_cast<impeller::ContextGLES>(
              android_context_->GetImpellerContext()),  //
          texture_id,                                   //
          surface_texture,                              //
          jni_facade_                                   //
          ));
      break;
#if !SLIMPELLER
    case AndroidRenderingAPI::kSkiaOpenGLES:
      // Legacy GL.
      RegisterTexture(std::make_shared<SurfaceTextureExternalTextureGLSkia>(
          texture_id,       //
          surface_texture,  //
          jni_facade_       //
          ));
      break;
    case AndroidRenderingAPI::kSoftware:
      FML_LOG(INFO) << "Software rendering does not support external textures.";
      break;
#endif  // !SLIMPELLER
    case AndroidRenderingAPI::kImpellerVulkan:
      FML_LOG(IMPORTANT)
          << "Flutter recommends migrating plugins that create and "
             "register surface textures to the new surface producer "
             "API. See https://docs.flutter.dev/release/breaking-changes/"
             "android-surface-plugins";
      RegisterTexture(std::make_shared<SurfaceTextureExternalTextureVKImpeller>(
          std::static_pointer_cast<impeller::ContextVK>(
              android_context_->GetImpellerContext()),  //
          texture_id,                                   //
          surface_texture,                              //
          jni_facade_                                   //
          ));
      break;
    case AndroidRenderingAPI::kImpellerAutoselect:
    default:
      FML_CHECK(false);
      break;
  }
}

References FML_CHECK, FML_LOG, flutter::kImpellerAutoselect, flutter::kImpellerOpenGLES, flutter::kImpellerVulkan, flutter::kSkiaOpenGLES, flutter::kSoftware, flutter::PlatformView::RegisterTexture(), and texture_id.

RegisterImageTexture()

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

Definition at line 384 of file platform_view_android.cc.

                                                  {
  switch (android_context_->RenderingApi()) {
#if !SLIMPELLER
    case AndroidRenderingAPI::kSkiaOpenGLES:
      // Legacy GL.
      RegisterTexture(std::make_shared<ImageExternalTextureGLSkia>(
          std::static_pointer_cast<AndroidContextGLSkia>(android_context_),
          texture_id, image_texture_entry, jni_facade_, lifecycle));
      break;
    case AndroidRenderingAPI::kSoftware:
      FML_LOG(INFO) << "Software rendering does not support external textures.";
      break;
#endif  // !SLIMPELLER
    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_, lifecycle));
      break;
    case AndroidRenderingAPI::kImpellerVulkan:
      RegisterTexture(std::make_shared<ImageExternalTextureVKImpeller>(
          std::static_pointer_cast<impeller::ContextVK>(
              android_context_->GetImpellerContext()),
          texture_id, image_texture_entry, jni_facade_, lifecycle));
      break;
    case AndroidRenderingAPI::kImpellerAutoselect:
      FML_CHECK(false);
      break;
  }
}

References FML_CHECK, FML_LOG, flutter::kImpellerAutoselect, flutter::kImpellerOpenGLES, flutter::kImpellerVulkan, flutter::kSkiaOpenGLES, flutter::kSoftware, flutter::PlatformView::RegisterTexture(), and texture_id.

SetupImpellerContext()

void flutter::PlatformViewAndroid::SetupImpellerContext ( )

overridevirtual

Performs any deferred setup of the Impeller context.

        This is intended to be called from the raster thread so that
        Impeller context creation can be moved off the startup path. 

Reimplemented from flutter::PlatformView.

Definition at line 566 of file platform_view_android.cc.

                                               {
  android_context_->SetupImpellerContext();
  android_surface_->SetupImpellerSurface();
}

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 525 of file platform_view_android.cc.

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

References flutter::PlatformView::delegate_, type, and flutter::PlatformView::Delegate::UpdateAssetResolverByType().

---

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