FlutterPlatformViewsController Class Reference

#include <FlutterPlatformViewsController.h>

Inheritance diagram for FlutterPlatformViewsController:

Instance Methods
(instancetype)	- NS_DESIGNATED_INITIALIZER
(void)	- registerViewFactory:withId:gestureRecognizersBlockingPolicy:
	set the factory used to construct embedded UI Views.
(void)	- beginFrameWithSize:
	Mark the beginning of a frame and record the size of the onscreen.
(void)	- cancelFrame
	Cancel the current frame, indicating that no platform views are composited.
(void)	- prerollCompositeEmbeddedView:withParams:
	Record a platform view in the layer tree to be rendered, along with the positioning and mutator parameters.
(FlutterTouchInterceptingView *)	- flutterTouchInterceptingViewForId:
	Returns theFlutterTouchInterceptingView with the provided view_id.
(flutter::PostPrerollResult)	- postPrerollActionWithThreadMerger:
	Determine if thread merging is required after prerolling platform views.
(void)	- endFrameWithResubmit:threadMerger:
	Mark the end of a compositor frame.
(flutter::DlCanvas *)	- compositeEmbeddedViewWithId:
	Returns the Canvas for the overlay slice for the given platform view.
(void)	- reset
	Discards all platform views instances and auxiliary resources.
(BOOL)	- submitFrame:withIosContext:
	Encode rendering for the Flutter overlay views and queue up perform platform view mutations.
(void)	- onMethodCall:result:
	Handler for platform view message channels.
(long)	- firstResponderPlatformViewId
	Returns the platform view id if the platform view (or any of its descendant view) is the first responder.
(void)	- pushFilterToVisitedPlatformViews:withRect:
	Pushes backdrop filter mutation to the mutator stack of each visited platform view.
(void)	- pushVisitedPlatformViewId:
	Pushes the view id of a visted platform view to the list of visied platform views.
(void)	- pushClipRectToVisitedPlatformViews:
	Pushes the outstanding rectangular clips to the mutator stack of each visited platform view.
(void)	- pushClipRRectToVisitedPlatformViews:
	Pushes the outstanding rounded rectangular clips to the mutator stack of each visited platform view.
(void)	- pushClipRSuperellipseToVisitedPlatformViews:
	Pushes the outstanding round super elliptical clips to the mutator stack of each visited platform view.
(void)	- pushClipPathToVisitedPlatformViews:
	Pushes the outstanding path clips to the mutator stack of each visited platform view.
(size_t)	- embeddedViewCount
(UIView *_Nullable)	- platformViewForId:
(void)	- compositeView:withParams:
(const flutter::EmbeddedViewParams &)	- compositionParamsForView:
(NSArray< NSNumber * > *)	- previousCompositionOrder
	The composition order from the previous frame.

Properties
FlutterFMLTaskRunner *	taskRunner
	The task runner used to post rendering tasks to the platform thread.
UIView *_Nullable	flutterView
	The flutter view.
UIViewController< FlutterViewResponder > *_Nullable	flutterViewController
	The flutter view controller.

Detailed Description

Definition at line 31 of file FlutterPlatformViewsController.h.

Method Documentation

beginFrameWithSize:

- (void) beginFrameWithSize:

(flutter::DlISize)

frameSize

Mark the beginning of a frame and record the size of the onscreen.

cancelFrame

- (void) cancelFrame

Cancel the current frame, indicating that no platform views are composited.

Additionally, reverts the composition order to its original state at the beginning of the frame.

Definition at line 320 of file FlutterPlatformViewsController.mm.

                    {
  [self resetFrameState];
}

compositeEmbeddedViewWithId:

- (DlCanvas *) FlutterPlatformViewsController:

(int64_t)

viewId

Returns the Canvas for the overlay slice for the given platform view.

Called from the raster thread.

Definition at line 320 of file FlutterPlatformViewsController.mm.

                                               :(int64_t)viewId {
  FML_DCHECK(self.slices.find(viewId) != self.slices.end());
  return self.slices[viewId]->canvas();
}

compositeView:withParams:

- (void) compositeView:		(int64_t)	viewId
withParams:		(const flutter::EmbeddedViewParams &)	params

Provided by category FlutterPlatformViewsController(Testing).

compositionParamsForView:

- (const EmbeddedViewParams & FlutterPlatformViewsController(Testing)):

(int64_t)

viewId

Provided by category FlutterPlatformViewsController(Testing).

embeddedViewCount

- (size_t) embeddedViewCount

Provided by category FlutterPlatformViewsController(Testing).

endFrameWithResubmit:threadMerger:

- (void) endFrameWithResubmit:		(BOOL)	shouldResubmitFrame
threadMerger:		(const fml::RefPtr<fml::RasterThreadMerger>&)	rasterThreadMerger

Mark the end of a compositor frame.

May determine changes are required to the thread merging state. Called from the raster thread.

Definition at line 320 of file FlutterPlatformViewsController.mm.

                            :(BOOL)shouldResubmitFrame
                threadMerger:(const fml::RefPtr<fml::RasterThreadMerger>&)rasterThreadMerger {
}

firstResponderPlatformViewId

- (long) firstResponderPlatformViewId

Returns the platform view id if the platform view (or any of its descendant view) is the first responder.

Returns -1 if no such platform view is found.

Definition at line 320 of file FlutterPlatformViewsController.mm.

                                     {
  for (auto const& [id, platformViewData] : self.platformViews) {
    UIView* rootView = platformViewData.root_view;
    if (rootView.flt_hasFirstResponderInViewHierarchySubtree) {
      return id;
    }
  }
  return -1;
}

flutterTouchInterceptingViewForId:

- (FlutterTouchInterceptingView *) flutterTouchInterceptingViewForId:

(int64_t)

viewId

Returns theFlutterTouchInterceptingView with the provided view_id.

Returns nil if there is no platform view with the provided id. Called from the platform thread.

Definition at line 320 of file FlutterPlatformViewsController.mm.

                                                                  :(int64_t)viewId {
  if (self.platformViews.empty()) {
    return nil;
  }
  return self.platformViews[viewId].touch_interceptor;
}

NS_DESIGNATED_INITIALIZER

- (instancetype) NS_DESIGNATED_INITIALIZER

onMethodCall:result:

- (void) onMethodCall:		(FlutterMethodCall*)	call
result:		(FlutterResult)	result

Handler for platform view message channels.

Definition at line 320 of file FlutterPlatformViewsController.mm.

                    :(FlutterMethodCall*)call result:(FlutterResult)result {
  if ([[call method] isEqualToString:@"create"]) {
    [self onCreate:call result:result];
  } else if ([[call method] isEqualToString:@"dispose"]) {
    [self onDispose:call result:result];
  } else if ([[call method] isEqualToString:@"acceptGesture"]) {
    [self onAcceptGesture:call result:result];
  } else if ([[call method] isEqualToString:@"rejectGesture"]) {
    [self onRejectGesture:call result:result];
  } else {
    result(FlutterMethodNotImplemented);
  }
}

platformViewForId:

- (UIView *_Nullable) platformViewForId:

(int64_t)

viewId

Provided by category FlutterPlatformViewsController(Testing).

postPrerollActionWithThreadMerger:

- (PostPrerollResult) FlutterPlatformViewsController:

(const fml::RefPtr<fml::RasterThreadMerger>&)

rasterThreadMerger

Determine if thread merging is required after prerolling platform views.

Called from the raster thread.

Definition at line 320 of file FlutterPlatformViewsController.mm.

                                                             :
    (const fml::RefPtr<fml::RasterThreadMerger>&)rasterThreadMerger {
  return flutter::PostPrerollResult::kSuccess;
}

prerollCompositeEmbeddedView:withParams:

- (void) prerollCompositeEmbeddedView:		(int64_t)	viewId
withParams:		(std::unique_ptr<flutter::EmbeddedViewParams>)	params

Record a platform view in the layer tree to be rendered, along with the positioning and mutator parameters.

Called from the raster thread.

Definition at line 320 of file FlutterPlatformViewsController.mm.

                                    :(int64_t)viewId
                          withParams:(std::unique_ptr<flutter::EmbeddedViewParams>)params {
  DlRect viewBounds = DlRect::MakeSize(self.frameSize);
  std::unique_ptr<flutter::EmbedderViewSlice> view;
  view = std::make_unique<flutter::DisplayListEmbedderViewSlice>(viewBounds);
  self.slices.insert_or_assign(viewId, std::move(view));
 
  self.compositionOrder.push_back(viewId);
 
  if (self.currentCompositionParams.count(viewId) == 1 &&
      self.currentCompositionParams[viewId] == *params.get()) {
    // Do nothing if the params didn't change.
    return;
  }
  self.currentCompositionParams[viewId] = flutter::EmbeddedViewParams(*params.get());
  self.viewsToRecomposite.insert(viewId);
}

previousCompositionOrder

- (NSArray< NSNumber * > *) previousCompositionOrder

The composition order from the previous frame.

Only accessed from the platform thread.

Provided by category FlutterPlatformViewsController(Testing).

pushClipPathToVisitedPlatformViews:

- (void) pushClipPathToVisitedPlatformViews:

(const flutter::DlPath&)

clipPath

Pushes the outstanding path clips to the mutator stack of each visited platform view.

Definition at line 320 of file FlutterPlatformViewsController.mm.

                                          :(const flutter::DlPath&)clipPath {
  for (int64_t id : self.visitedPlatformViews) {
    flutter::EmbeddedViewParams params = self.currentCompositionParams[id];
    params.PushPlatformViewClipPath(clipPath);
    self.currentCompositionParams[id] = params;
  }
}

pushClipRectToVisitedPlatformViews:

- (void) pushClipRectToVisitedPlatformViews:

(const flutter::DlRect&)

clipRect

Pushes the outstanding rectangular clips to the mutator stack of each visited platform view.

Definition at line 320 of file FlutterPlatformViewsController.mm.

                                          :(const flutter::DlRect&)clipRect {
  for (int64_t id : self.visitedPlatformViews) {
    flutter::EmbeddedViewParams params = self.currentCompositionParams[id];
    params.PushPlatformViewClipRect(clipRect);
    self.currentCompositionParams[id] = params;
  }
}

pushClipRRectToVisitedPlatformViews:

- (void) pushClipRRectToVisitedPlatformViews:

(const flutter::DlRoundRect&)

clipRRect

Pushes the outstanding rounded rectangular clips to the mutator stack of each visited platform view.

Definition at line 320 of file FlutterPlatformViewsController.mm.

                                           :(const flutter::DlRoundRect&)clipRRect {
  for (int64_t id : self.visitedPlatformViews) {
    flutter::EmbeddedViewParams params = self.currentCompositionParams[id];
    params.PushPlatformViewClipRRect(clipRRect);
    self.currentCompositionParams[id] = params;
  }
}

pushClipRSuperellipseToVisitedPlatformViews:

- (void) pushClipRSuperellipseToVisitedPlatformViews:

(const flutter::DlRoundSuperellipse&)

clipRse

Pushes the outstanding round super elliptical clips to the mutator stack of each visited platform view.

Definition at line 320 of file FlutterPlatformViewsController.mm.

                                                   :(const flutter::DlRoundSuperellipse&)clipRse {
  for (int64_t id : self.visitedPlatformViews) {
    flutter::EmbeddedViewParams params = self.currentCompositionParams[id];
    params.PushPlatformViewClipRSuperellipse(clipRse);
    self.currentCompositionParams[id] = params;
  }
}

pushFilterToVisitedPlatformViews:withRect:

- (void) pushFilterToVisitedPlatformViews:		(const std::shared_ptr<flutter::DlImageFilter>&)	filter
withRect:		(const flutter::DlRect&)	filterRect

Pushes backdrop filter mutation to the mutator stack of each visited platform view.

Definition at line 320 of file FlutterPlatformViewsController.mm.

                                        :(const std::shared_ptr<flutter::DlImageFilter>&)filter
                                withRect:(const flutter::DlRect&)filterRect {
  for (int64_t id : self.visitedPlatformViews) {
    flutter::EmbeddedViewParams params = self.currentCompositionParams[id];
    params.PushImageFilter(filter, filterRect);
    self.currentCompositionParams[id] = params;
  }
}

pushVisitedPlatformViewId:

- (void) pushVisitedPlatformViewId:

(int64_t)

viewId

Pushes the view id of a visted platform view to the list of visied platform views.

Definition at line 320 of file FlutterPlatformViewsController.mm.

                                 :(int64_t)viewId {
  self.visitedPlatformViews.push_back(viewId);
}

registerViewFactory:withId:gestureRecognizersBlockingPolicy:

- (void) registerViewFactory:		(NSObject<FlutterPlatformViewFactory>*)	factory
withId:		(NSString*)	factoryId
gestureRecognizersBlockingPolicy:		(FlutterPlatformViewGestureRecognizersBlockingPolicy)	gestureRecognizerBlockingPolicy

set the factory used to construct embedded UI Views.

Definition at line 320 of file FlutterPlatformViewsController.mm.

                           :(NSObject<FlutterPlatformViewFactory>*)factory
                              withId:(NSString*)factoryId
    gestureRecognizersBlockingPolicy:
        (FlutterPlatformViewGestureRecognizersBlockingPolicy)gestureRecognizerBlockingPolicy {
  std::string idString([factoryId UTF8String]);
  FML_CHECK(self.factories.count(idString) == 0);
  self.factories[idString] = factory;
  self.gestureRecognizersBlockingPoliciesByType[idString] = gestureRecognizerBlockingPolicy;
}

reset

- (void) reset

Discards all platform views instances and auxiliary resources.

Called from the raster thread.

Definition at line 320 of file FlutterPlatformViewsController.mm.

              {
  // Reset will only be called from the raster thread or a merged raster/platform thread.
  // _platformViews must only be modified on the platform thread, and any operations that
  // read or modify platform views should occur there.
  std::vector<int64_t> compositionOrder = self.compositionOrder;
  [self.taskRunner runNowOrPostTask:^{
    for (int64_t viewId : compositionOrder) {
      [self.platformViews[viewId].root_view removeFromSuperview];
    }
    self.platformViews.clear();
    _previousCompositionOrder.clear();
  }];
 
  self.compositionOrder.clear();
  self.slices.clear();
  self.currentCompositionParams.clear();
  self.viewsToRecomposite.clear();
  self.layerPool->RecycleLayers();
  self.visitedPlatformViews.clear();
}

submitFrame:withIosContext:

- (BOOL) submitFrame:		(std::unique_ptr<flutter::SurfaceFrame>)	frame
withIosContext:		(const std::shared_ptr<flutter::IOSContext>&)	iosContext

Encode rendering for the Flutter overlay views and queue up perform platform view mutations.

Called from the raster thread.

Definition at line 320 of file FlutterPlatformViewsController.mm.

                   :(std::unique_ptr<flutter::SurfaceFrame>)background_frame
     withIosContext:(const std::shared_ptr<flutter::IOSContext>&)iosContext {
  TRACE_EVENT0("flutter", "PlatformViewsController::SubmitFrame");
 
  // No platform views to render.
  if (self.flutterView == nil || (self.compositionOrder.empty() && !self.hadPlatformViews)) {
    // No platform views to render but the FlutterView may need to be resized.
    __weak FlutterPlatformViewsController* weakSelf = self;
    if (self.flutterView != nil) {
      // Pass frameSize by value since self.frameSize is mutated both here (on the platform
      // thread) and in beginFrameWithSize: (on the raster thread).
      const flutter::DlISize frameSize = self.frameSize;
      [self.taskRunner runNowOrPostTask:^{
        FlutterPlatformViewsController* strongSelf = weakSelf;
        if (!strongSelf) {
          return;
        }
        [strongSelf performResize:frameSize];
      }];
    }
 
    self.hadPlatformViews = NO;
    return background_frame->Submit();
  }
  self.hadPlatformViews = !self.compositionOrder.empty();
 
  bool didEncode = true;
  LayersMap platformViewLayers;
  std::vector<std::unique_ptr<flutter::SurfaceFrame>> surfaceFrames;
  surfaceFrames.reserve(self.compositionOrder.size());
  std::unordered_map<int64_t, DlRect> viewRects;
  std::unordered_set<int64_t> viewsWithUnderlayPreserved;
 
  for (int64_t viewId : self.compositionOrder) {
    const flutter::EmbeddedViewParams& params = self.currentCompositionParams[viewId];
    viewRects[viewId] = params.finalBoundingRect();
    if (HasNonRectClipForUnderlayCutout(params)) {
      viewsWithUnderlayPreserved.insert(viewId);
    }
  }
 
  std::unordered_map<int64_t, DlRect> overlayLayers =
      SliceViews(background_frame->Canvas(), self.compositionOrder, self.slices, viewRects,
                 viewsWithUnderlayPreserved);
 
  size_t requiredOverlayLayers = 0;
  for (int64_t viewId : self.compositionOrder) {
    std::unordered_map<int64_t, DlRect>::const_iterator overlay = overlayLayers.find(viewId);
    if (overlay == overlayLayers.end()) {
      continue;
    }
    requiredOverlayLayers++;
  }
 
  // If there are not sufficient overlay layers, we must construct them on the platform
  // thread, at least until we've refactored iOS surface creation to use IOSurfaces
  // instead of CALayers.
  [self createMissingOverlays:requiredOverlayLayers withIosContext:iosContext];
 
  int64_t overlayId = 0;
  for (int64_t viewId : self.compositionOrder) {
    std::unordered_map<int64_t, DlRect>::const_iterator overlay = overlayLayers.find(viewId);
    if (overlay == overlayLayers.end()) {
      continue;
    }
    std::shared_ptr<flutter::OverlayLayer> layer = self.nextLayerInPool;
    if (!layer) {
      continue;
    }
 
    std::unique_ptr<flutter::SurfaceFrame> frame = layer->surface->AcquireFrame(self.frameSize);
    // If frame is null, AcquireFrame already printed out an error message.
    if (!frame) {
      continue;
    }
    flutter::DlCanvas* overlayCanvas = frame->Canvas();
    int restoreCount = overlayCanvas->GetSaveCount();
    overlayCanvas->Save();
    overlayCanvas->ClipRect(overlay->second);
    if (viewsWithUnderlayPreserved.find(viewId) != viewsWithUnderlayPreserved.end()) {
      ApplyNonRectClipToOverlayCanvas(overlayCanvas, self.currentCompositionParams[viewId]);
    }
    overlayCanvas->Clear(flutter::DlColor::kTransparent());
    self.slices[viewId]->render_into(overlayCanvas);
    overlayCanvas->RestoreToCount(restoreCount);
 
    // This flutter view is never the last in a frame, since we always submit the
    // underlay view last.
    frame->set_submit_info({.frame_boundary = false, .present_with_transaction = true});
    layer->did_submit_last_frame = frame->Encode();
 
    didEncode &= layer->did_submit_last_frame;
    platformViewLayers[viewId] = LayerData{
        .rect = overlay->second,  //
        .view_id = viewId,        //
        .overlay_id = overlayId,  //
        .layer = layer            //
    };
    surfaceFrames.push_back(std::move(frame));
    overlayId++;
  }
 
  auto previousSubmitInfo = background_frame->submit_info();
  background_frame->set_submit_info({
      .frame_damage = previousSubmitInfo.frame_damage,
      .buffer_damage = previousSubmitInfo.buffer_damage,
      .present_with_transaction = true,
  });
  background_frame->Encode();
  surfaceFrames.push_back(std::move(background_frame));
 
  // Mark all layers as available, so they can be used in the next frame.
  std::vector<std::shared_ptr<flutter::OverlayLayer>> unusedLayers =
      self.layerPool->RemoveUnusedLayers();
  self.layerPool->RecycleLayers();
  auto task = fml::MakeCopyable([self,                                                      //
                                 platformViewLayers = std::move(platformViewLayers),        //
                                 currentCompositionParams = self.currentCompositionParams,  //
                                 viewsToRecomposite = self.viewsToRecomposite,              //
                                 compositionOrder = self.compositionOrder,                  //
                                 unusedLayers = std::move(unusedLayers),                    //
                                 surfaceFrames = std::move(surfaceFrames)]() mutable {
    [self performSubmit:platformViewLayers
        currentCompositionParams:currentCompositionParams
              viewsToRecomposite:viewsToRecomposite
                compositionOrder:compositionOrder
                    unusedLayers:unusedLayers
                   surfaceFrames:surfaceFrames];
  });
 
  [self.taskRunner runNowOrPostTask:^{
    task();
  }];
  return didEncode;
}

Property Documentation

flutterView

- (UIView* _Nullable) flutterView

readwritenonatomicweak

The flutter view.

Definition at line 39 of file FlutterPlatformViewsController.h.

flutterViewController

- (UIViewController<FlutterViewResponder>* _Nullable) flutterViewController

readwritenonatomicweak

The flutter view controller.

Definition at line 42 of file FlutterPlatformViewsController.h.

taskRunner

- (FlutterFMLTaskRunner *) taskRunner

readwritenonatomicstrong

The task runner used to post rendering tasks to the platform thread.

Definition at line 36 of file FlutterPlatformViewsController.h.

Referenced by flutter::testing::CreateTestPlatformViewsController().

---

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

• shell/platform/darwin/ios/framework/Source/FlutterPlatformViewsController.h
• shell/platform/darwin/ios/framework/Source/FlutterPlatformViewsController.mm