#include <platform_view_ios.h>

Inheritance diagram for flutter::PlatformViewIOS:

Public Member Functions
	PlatformViewIOS (PlatformView::Delegate &delegate, const std::shared_ptr< IOSContext > &context, const std::shared_ptr< FlutterPlatformViewsController > &platform_views_controller, const flutter::TaskRunners &task_runners)

	PlatformViewIOS (PlatformView::Delegate &delegate, IOSRenderingAPI rendering_api, const std::shared_ptr< FlutterPlatformViewsController > &platform_views_controller, const flutter::TaskRunners &task_runners, const std::shared_ptr< fml::ConcurrentTaskRunner > &worker_task_runner, const std::shared_ptr< const fml::SyncSwitch > &is_gpu_disabled_sync_switch)

	~PlatformViewIOS () override

fml::WeakNSObject< FlutterViewController >	GetOwnerViewController () const

void	SetOwnerViewController (const fml::WeakNSObject< FlutterViewController > &owner_controller)

void	attachView ()

void	RegisterExternalTexture (int64_t id, NSObject< FlutterTexture > *texture)

PointerDataDispatcherMaker	GetDispatcherMaker () override

void	SetSemanticsEnabled (bool enabled) override

const std::shared_ptr< IOSContext > &	GetIosContext ()

std::shared_ptr< PlatformMessageHandlerIos >	GetPlatformMessageHandlerIos () const

std::shared_ptr< PlatformMessageHandler >	GetPlatformMessageHandler () const override

Detailed Description

A bridge connecting the platform agnostic shell and the iOS embedding.

The shell provides and requests for UI related data and this PlatformView subclass fulfills it with iOS specific capabilities. As an example, the iOS embedding (the FlutterEngine and the FlutterViewController) sends pointer data to the shell and receives the shell's request for a Skia GrDirectContext and supplies it.

Despite the name "view", this class is unrelated to UIViews on iOS and doesn't have the same lifecycle. It's a long lived bridge owned by the FlutterEngine and can be attached and detached sequentially to multiple FlutterViewControllers and FlutterViews.

Definition at line 41 of file platform_view_ios.h.

Constructor & Destructor Documentation

◆ PlatformViewIOS() [1/2]

flutter::PlatformViewIOS::PlatformViewIOS	(	PlatformView::Delegate &	delegate,
		const std::shared_ptr< IOSContext > &	context,
		const std::shared_ptr< FlutterPlatformViewsController > &	platform_views_controller,
		const flutter::TaskRunners &	task_runners
	)

Definition at line 42 of file platform_view_ios.mm.

     : PlatformView(delegate, task_runners),
       ios_context_(context),
       platform_views_controller_(platform_views_controller),
       accessibility_bridge_([this](bool enabled) { PlatformView::SetSemanticsEnabled(enabled); }),
       platform_message_handler_(
           new PlatformMessageHandlerIos(task_runners.GetPlatformTaskRunner())) {}

◆ PlatformViewIOS() [2/2]

flutter::PlatformViewIOS::PlatformViewIOS	(	PlatformView::Delegate &	delegate,
		IOSRenderingAPI	rendering_api,
		const std::shared_ptr< FlutterPlatformViewsController > &	platform_views_controller,
		const flutter::TaskRunners &	task_runners,
		const std::shared_ptr< fml::ConcurrentTaskRunner > &	worker_task_runner,
		const std::shared_ptr< const fml::SyncSwitch > &	is_gpu_disabled_sync_switch
	)

explicit

Definition at line 54 of file platform_view_ios.mm.

     : PlatformViewIOS(
           delegate,
           IOSContext::Create(
               rendering_api,
               delegate.OnPlatformViewGetSettings().enable_impeller ? IOSRenderingBackend::kImpeller
                                                                    : IOSRenderingBackend::kSkia,
               static_cast<MsaaSampleCount>(delegate.OnPlatformViewGetSettings().msaa_samples),
               is_gpu_disabled_sync_switch),
           platform_views_controller,
           task_runners) {}

References flutter::kImpeller, and flutter::kSkia.

◆ ~PlatformViewIOS()

flutter::PlatformViewIOS::~PlatformViewIOS ( )

overridedefault

Member Function Documentation

◆ attachView()

void flutter::PlatformViewIOS::attachView ( )

Called one time per FlutterViewController when the FlutterViewController's UIView is first loaded.

Can be used to perform late initialization after FlutterViewController's init.

Definition at line 115 of file platform_view_ios.mm.

                                  {
   FML_DCHECK(owner_controller_);
   FML_DCHECK(owner_controller_.get().isViewLoaded)
       << "FlutterViewController's view should be loaded "
          "before attaching to PlatformViewIOS.";
   auto flutter_view = static_cast<FlutterView*>(owner_controller_.get().view);
   auto ca_layer = fml::scoped_nsobject<CALayer>{[[flutter_view layer] retain]};
   ios_surface_ = IOSSurface::Create(ios_context_, ca_layer);
   FML_DCHECK(ios_surface_ != nullptr);
  
   if (accessibility_bridge_) {
     accessibility_bridge_.Set(std::make_unique<AccessibilityBridge>(
         owner_controller_.get(), this, [owner_controller_.get() platformViewsController]));
   }
 }

References flutter::IOSSurface::Create().

Referenced by SetOwnerViewController().

◆ GetDispatcherMaker()

PointerDataDispatcherMaker flutter::PlatformViewIOS::GetDispatcherMaker ( )

override

Definition at line 131 of file platform_view_ios.mm.

                                                                {
   return [](DefaultPointerDataDispatcher::Delegate& delegate) {
     return std::make_unique<SmoothPointerDataDispatcher>(delegate);
   };
 }

◆ GetIosContext()

const std::shared_ptr<IOSContext>& flutter::PlatformViewIOS::GetIosContext ( )

inline

Accessor for the IOSContext associated with the platform view.

Definition at line 93 of file platform_view_ios.h.

93 { return ios_context_; }

◆ GetOwnerViewController()

fml::WeakNSObject< FlutterViewController > flutter::PlatformViewIOS::GetOwnerViewController ( ) const

Returns the FlutterViewController currently attached to the FlutterEngine owning this PlatformViewIOS.

Definition at line 79 of file platform_view_ios.mm.

                                                                                      {
   return owner_controller_;
 }

◆ GetPlatformMessageHandler()

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

inlineoverride

Definition at line 99 of file platform_view_ios.h.

                                                                                    {
     return platform_message_handler_;
   }

◆ GetPlatformMessageHandlerIos()

std::shared_ptr<PlatformMessageHandlerIos> flutter::PlatformViewIOS::GetPlatformMessageHandlerIos ( ) const

inline

Definition at line 95 of file platform_view_ios.h.

                                                                                 {
     return platform_message_handler_;
   }

◆ RegisterExternalTexture()

void flutter::PlatformViewIOS::RegisterExternalTexture	(	int64_t	id,
		NSObject< FlutterTexture > *	texture
	)

Called through when an external texture such as video or camera is given to the FlutterEngine or FlutterViewController.

Definition at line 137 of file platform_view_ios.mm.

                                                                                  {
   RegisterTexture(ios_context_->CreateExternalTexture(
       texture_id, fml::scoped_nsobject<NSObject<FlutterTexture>>{[texture retain]}));
 }

References texture_id.

◆ SetOwnerViewController()

void flutter::PlatformViewIOS::SetOwnerViewController ( const fml::WeakNSObject< FlutterViewController > & owner_controller )

Updates the FlutterViewController currently attached to the FlutterEngine owning this PlatformViewIOS. This should be updated when the FlutterEngine is given a new FlutterViewController.

Definition at line 83 of file platform_view_ios.mm.

                                                                     {
   FML_DCHECK(task_runners_.GetPlatformTaskRunner()->RunsTasksOnCurrentThread());
   std::lock_guard<std::mutex> guard(ios_surface_mutex_);
   if (ios_surface_ || !owner_controller) {
     NotifyDestroyed();
     ios_surface_.reset();
     accessibility_bridge_.Clear();
   }
   owner_controller_ = owner_controller;
  
   // Add an observer that will clear out the owner_controller_ ivar and
   // the accessibility_bridge_ in case the view controller is deleted.
   dealloc_view_controller_observer_.reset(
       [[[NSNotificationCenter defaultCenter] addObserverForName:FlutterViewControllerWillDealloc
                                                          object:owner_controller_.get()
                                                           queue:[NSOperationQueue mainQueue]
                                                      usingBlock:^(NSNotification* note) {
                                                        // Implicit copy of 'this' is fine.
                                                        accessibility_bridge_.Clear();
                                                        owner_controller_.reset();
                                                      }] retain]);
  
   if (owner_controller_ && [owner_controller_.get() isViewLoaded]) {
     this->attachView();
   }
   // Do not call `NotifyCreated()` here - let FlutterViewController take care
   // of that when its Viewport is sized.  If `NotifyCreated()` is called here,
   // it can occasionally get invoked before the viewport is sized resulting in
   // a framebuffer that will not be able to completely attach.
 }

References attachView(), and FlutterViewControllerWillDealloc.

◆ SetSemanticsEnabled()

void flutter::PlatformViewIOS::SetSemanticsEnabled ( bool enabled )