Inheritance diagram for io.flutter.plugin.platform.PlatformViewsController:

Public Member Functions
PlatformView	createPlatformView ( @NonNull PlatformViewsChannel.PlatformViewCreationRequest request, boolean wrapContext)

long	configureForTextureLayerComposition ( @NonNull PlatformView platformView, @NonNull PlatformViewsChannel.PlatformViewCreationRequest request)

MotionEvent	toMotionEvent (float density, PlatformViewsChannel.PlatformViewTouch touch, boolean usingVirtualDiplay)

	PlatformViewsController ()

void	attach ( @Nullable Context context, @NonNull TextureRegistry textureRegistry, @NonNull DartExecutor dartExecutor)

void	setSoftwareRendering (boolean useSoftwareRendering)

void	detach ()

void	attachToView (@NonNull FlutterView newFlutterView)

void	detachFromView ()

void	attachAccessibilityBridge (@NonNull AccessibilityBridge accessibilityBridge)

void	detachAccessibilityBridge ()

void	attachTextInputPlugin (@NonNull TextInputPlugin textInputPlugin)

void	detachTextInputPlugin ()

boolean	checkInputConnectionProxy (@Nullable View view)

PlatformViewRegistry	getRegistry ()

void	onAttachedToJNI ()

void	onDetachedFromJNI ()

void	onPreEngineRestart ()

View	getPlatformViewById (int viewId)

boolean	usesVirtualDisplay (int id)

void	disposePlatformView (int viewId)

void	attachToFlutterRenderer (@NonNull FlutterRenderer flutterRenderer)

void	onDisplayPlatformView (int viewId, int x, int y, int width, int height, int viewWidth, int viewHeight, @NonNull FlutterMutatorsStack mutatorsStack)

void	onDisplayOverlaySurface (int id, int x, int y, int width, int height)

void	onBeginFrame ()

void	onEndFrame ()

FlutterOverlaySurface	createOverlaySurface (@NonNull PlatformOverlayView imageView)

FlutterOverlaySurface	createOverlaySurface ()

void	destroyOverlaySurfaces ()

SparseArray< PlatformOverlayView >	getOverlayLayerViews ()

Package Functions
void	initializePlatformViewIfNeeded (int viewId)

Package Attributes
final HashMap< Integer, VirtualDisplayController >	vdControllers

final HashMap< Context, View >	contextToEmbeddedView

Detailed Description

Manages platform views.

Each io.flutter.embedding.engine.FlutterEngine or io.flutter.app.FlutterPluginRegistry has a single platform views controller. A platform views controller can be attached to at most one Flutter view.

Definition at line 52 of file PlatformViewsController.java.

Constructor & Destructor Documentation

◆ PlatformViewsController()

io.flutter.plugin.platform.PlatformViewsController.PlatformViewsController ( )

inline

Definition at line 716 of file PlatformViewsController.java.

                                   {
    registry = new PlatformViewRegistryImpl();
    vdControllers = new HashMap<>();
    accessibilityEventsDelegate = new AccessibilityEventsDelegate();
    contextToEmbeddedView = new HashMap<>();
    overlayLayerViews = new SparseArray<>();
    currentFrameUsedOverlayLayerIds = new HashSet<>();
    currentFrameUsedPlatformViewIds = new HashSet<>();
    viewWrappers = new SparseArray<>();
    platformViews = new SparseArray<>();
    platformViewParent = new SparseArray<>();
 
    motionEventTracker = MotionEventTracker.getInstance();
  }

Member Function Documentation

◆ attach()

void io.flutter.plugin.platform.PlatformViewsController.attach	(	@Nullable Context	context,
		@NonNull TextureRegistry	textureRegistry,
		@NonNull DartExecutor	dartExecutor
	)

inline

Attaches this platform views controller to its input and output channels.

Parameters

context	The base context that will be passed to embedded views created by this controller. This should be the context of the Activity hosting the Flutter application.
textureRegistry	The texture registry which provides the output textures into which the embedded views will be rendered.
dartExecutor	The dart execution context, which is used to set up a system channel.

Definition at line 740 of file PlatformViewsController.java.

                                          {
    if (this.context != null) {
      throw new AssertionError(
          "A PlatformViewsController can only be attached to a single output target.\n"
              + "attach was called while the PlatformViewsController was already attached.");
    }
    this.context = context;
    this.textureRegistry = textureRegistry;
    platformViewsChannel = new PlatformViewsChannel(dartExecutor);
    platformViewsChannel.setPlatformViewsHandler(channelHandler);
  }

◆ attachAccessibilityBridge()

void io.flutter.plugin.platform.PlatformViewsController.attachAccessibilityBridge ( @NonNull AccessibilityBridge accessibilityBridge )

inline

Attaches an accessibility bridge for this platform views accessibility delegate.

Accessibility events originating in platform views belonging to this delegate will be delegated to this accessibility bridge.

Implements io.flutter.plugin.platform.PlatformViewsAccessibilityDelegate.

Definition at line 856 of file PlatformViewsController.java.

                                                                                          {
    accessibilityEventsDelegate.setAccessibilityBridge(accessibilityBridge);
  }

◆ attachTextInputPlugin()

void io.flutter.plugin.platform.PlatformViewsController.attachTextInputPlugin ( @NonNull TextInputPlugin textInputPlugin )

inline

Attaches this controller to a text input plugin.

While a text input plugin is available, the platform views controller interacts with it to facilitate delegation of text input connections to platform views.

A platform views controller should be attached to a text input plugin whenever it is possible for the Flutter framework to receive text input.

Definition at line 874 of file PlatformViewsController.java.

                                                                              {
    this.textInputPlugin = textInputPlugin;
  }

◆ attachToFlutterRenderer()

void io.flutter.plugin.platform.PlatformViewsController.attachToFlutterRenderer ( @NonNull FlutterRenderer flutterRenderer )

inline

Definition at line 1127 of file PlatformViewsController.java.

                                                                                {
    androidTouchProcessor = new AndroidTouchProcessor(flutterRenderer, /*trackMotionEvents=*/ true);
  }

◆ attachToView()

void io.flutter.plugin.platform.PlatformViewsController.attachToView ( @NonNull FlutterView newFlutterView )

inline

Attaches the controller to a FlutterView.

When io.flutter.embedding.android.FlutterFragment is used, this method is called after the device rotates since the FlutterView is recreated after a rotation.

Definition at line 796 of file PlatformViewsController.java.

                                                                {
    flutterView = newFlutterView;
    // Add wrapper for platform views that use GL texture.
    for (int index = 0; index < viewWrappers.size(); index++) {
      final PlatformViewWrapper view = viewWrappers.valueAt(index);
      flutterView.addView(view);
    }
    // Add wrapper for platform views that are composed at the view hierarchy level.
    for (int index = 0; index < platformViewParent.size(); index++) {
      final FlutterMutatorView view = platformViewParent.valueAt(index);
      flutterView.addView(view);
    }
    // Notify platform views that they are now attached to a FlutterView.
    for (int index = 0; index < platformViews.size(); index++) {
      final PlatformView view = platformViews.valueAt(index);
      view.onFlutterViewAttached(flutterView);
    }
  }

◆ checkInputConnectionProxy()

boolean io.flutter.plugin.platform.PlatformViewsController.checkInputConnectionProxy ( @Nullable View view )

inline

Returns true if Flutter should perform input connection proxying for the view.

If the view is a platform view managed by this platform views controller returns true. Else if the view was created in a platform view's VD, delegates the decision to the platform view's View#checkInputConnectionProxy(View) method. Else returns false.

Definition at line 890 of file PlatformViewsController.java.

                                                                {
    // View can be null on some devices
    // See: https://github.com/flutter/flutter/issues/36517
    if (view == null) {
      return false;
    }
    if (!contextToEmbeddedView.containsKey(view.getContext())) {
      return false;
    }
    View platformView = contextToEmbeddedView.get(view.getContext());
    if (platformView == view) {
      return true;
    }
    return platformView.checkInputConnectionProxy(view);
  }

◆ configureForTextureLayerComposition()

long io.flutter.plugin.platform.PlatformViewsController.configureForTextureLayerComposition	(	@NonNull PlatformView	platformView,
		@NonNull PlatformViewsChannel.PlatformViewCreationRequest	request
	)

inline

Definition at line 599 of file PlatformViewsController.java.

                                                                         {
    // This mode attaches the view to the Android view hierarchy and record its drawing
    // operations, so they can be forwarded to a GL texture that is composed by the
    // Flutter engine.
 
    // API level 23 is required to use Surface#lockHardwareCanvas().
    enforceMinimumAndroidApiVersion(23);
    Log.i(TAG, "Hosting view in view hierarchy for platform view: " + request.viewId);
 
    final int physicalWidth = toPhysicalPixels(request.logicalWidth);
    final int physicalHeight = toPhysicalPixels(request.logicalHeight);
    PlatformViewWrapper viewWrapper;
    long textureId;
    if (usesSoftwareRendering) {
      viewWrapper = new PlatformViewWrapper(context);
      textureId = -1;
    } else {
      final PlatformViewRenderTarget renderTarget = makePlatformViewRenderTarget(textureRegistry);
      viewWrapper = new PlatformViewWrapper(context, renderTarget);
      textureId = renderTarget.getId();
    }
    viewWrapper.setTouchProcessor(androidTouchProcessor);
    viewWrapper.resizeRenderTarget(physicalWidth, physicalHeight);
 
    final FrameLayout.LayoutParams viewWrapperLayoutParams =
        new FrameLayout.LayoutParams(physicalWidth, physicalHeight);
 
    // Size and position the view wrapper.
    final int physicalTop = toPhysicalPixels(request.logicalTop);
    final int physicalLeft = toPhysicalPixels(request.logicalLeft);
    viewWrapperLayoutParams.topMargin = physicalTop;
    viewWrapperLayoutParams.leftMargin = physicalLeft;
    viewWrapper.setLayoutParams(viewWrapperLayoutParams);
 
    // Size the embedded view.
    final View embeddedView = platformView.getView();
    embeddedView.setLayoutParams(new FrameLayout.LayoutParams(physicalWidth, physicalHeight));
 
    // Accessibility in the embedded view is initially disabled because if a Flutter app
    // disabled accessibility in the first frame, the embedding won't receive an update to
    // disable accessibility since the embedding never received an update to enable it.
    // The AccessibilityBridge keeps track of the accessibility nodes, and handles the deltas
    // when the framework sends a new a11y tree to the embedding.
    // To prevent races, the framework populate the SemanticsNode after the platform view has
    // been created.
    embeddedView.setImportantForAccessibility(View.IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS);
 
    // Add the embedded view to the wrapper.
    viewWrapper.addView(embeddedView);
 
    // Listen for focus changed in any subview, so the framework is notified when the platform
    // view is focused.
    viewWrapper.setOnDescendantFocusChangeListener(
        (v, hasFocus) -> {
          if (hasFocus) {
            platformViewsChannel.invokeViewFocused(request.viewId);
          } else if (textInputPlugin != null) {
            textInputPlugin.clearPlatformViewClient(request.viewId);
          }
        });
 
    flutterView.addView(viewWrapper);
    viewWrappers.append(request.viewId, viewWrapper);
 
    maybeInvokeOnFlutterViewAttached(platformView);
 
    return textureId;
  }

◆ createOverlaySurface() [1/2]

FlutterOverlaySurface io.flutter.plugin.platform.PlatformViewsController.createOverlaySurface ( )

inline

Creates an overlay surface while the Flutter view is rendered by PlatformOverlayView.

This method is invoked by FlutterJNI only.

This member is not intended for public use, and is only visible for testing.

Definition at line 1306 of file PlatformViewsController.java.

                                                      {
    // Overlay surfaces have the same size as the background surface.
    //
    // This allows to reuse these surfaces in consecutive frames even
    // if the drawings they contain have a different tight bound.
    //
    // The final view size is determined when its frame is set.
    return createOverlaySurface(
        new PlatformOverlayView(
            flutterView.getContext(),
            flutterView.getWidth(),
            flutterView.getHeight(),
            accessibilityEventsDelegate));
  }

◆ createOverlaySurface() [2/2]

FlutterOverlaySurface io.flutter.plugin.platform.PlatformViewsController.createOverlaySurface ( @NonNull PlatformOverlayView imageView )

inline

Creates and tracks the overlay surface.

Parameters

imageView The surface that displays the overlay.

Returns: Wrapper object that provides the layer id and the surface. This member is not intended for public use, and is only visible for testing.

Definition at line 1292 of file PlatformViewsController.java.

                                                                                            {
    final int id = nextOverlayLayerId++;
    overlayLayerViews.put(id, imageView);
    return new FlutterOverlaySurface(id, imageView.getSurface());
  }

◆ createPlatformView()

PlatformView io.flutter.plugin.platform.PlatformViewsController.createPlatformView	(	@NonNull PlatformViewsChannel.PlatformViewCreationRequest	request,
		boolean	wrapContext
	)

inline

Definition at line 506 of file PlatformViewsController.java.

                                                                                              {
    final PlatformViewFactory viewFactory = registry.getFactory(request.viewType);
    if (viewFactory == null) {
      throw new IllegalStateException(
          "Trying to create a platform view of unregistered type: " + request.viewType);
    }
 
    Object createParams = null;
    if (request.params != null) {
      createParams = viewFactory.getCreateArgsCodec().decodeMessage(request.params);
    }
 
    // In some display modes, the context needs to be modified during display.
    // TODO(stuartmorgan): Make this wrapping unconditional if possible; for context see
    // https://github.com/flutter/flutter/issues/113449
    final Context mutableContext = wrapContext ? new MutableContextWrapper(context) : context;
    final PlatformView platformView =
        viewFactory.create(mutableContext, request.viewId, createParams);
 
    // Configure the view to match the requested layout direction.
    final View embeddedView = platformView.getView();
    if (embeddedView == null) {
      throw new IllegalStateException(
          "PlatformView#getView() returned null, but an Android view reference was expected.");
    }
    embeddedView.setLayoutDirection(request.direction);
    platformViews.put(request.viewId, platformView);
    maybeInvokeOnFlutterViewAttached(platformView);
    return platformView;
  }

◆ destroyOverlaySurfaces()

void io.flutter.plugin.platform.PlatformViewsController.destroyOverlaySurfaces ( )

inline

Destroys the overlay surfaces and removes them from the view hierarchy.

This method is used only internally by FlutterJNI.

Definition at line 1326 of file PlatformViewsController.java.

                                       {
    for (int viewId = 0; viewId < overlayLayerViews.size(); viewId++) {
      final PlatformOverlayView overlayView = overlayLayerViews.valueAt(viewId);
      overlayView.detachFromRenderer();
      overlayView.closeImageReader();
      // Don't remove overlayView from the view hierarchy since this method can
      // be called while the Android framework is iterating over the array of views.
      // See ViewGroup#dispatchDetachedFromWindow(), and
      // https://github.com/flutter/flutter/issues/97679.
    }
  }

◆ detach()

void io.flutter.plugin.platform.PlatformViewsController.detach ( )

inline

Detaches this platform views controller.

This is typically called when a Flutter applications moves to run in the background, or is destroyed. After calling this the platform views controller will no longer listen to it's previous messenger, and will not maintain references to the texture registry, context, and messenger passed to the previous attach call.

Definition at line 780 of file PlatformViewsController.java.

                       {
    if (platformViewsChannel != null) {
      platformViewsChannel.setPlatformViewsHandler(null);
    }
    destroyOverlaySurfaces();
    platformViewsChannel = null;
    context = null;
    textureRegistry = null;
  }

◆ detachAccessibilityBridge()

void io.flutter.plugin.platform.PlatformViewsController.detachAccessibilityBridge ( )

inline

Detaches the current accessibility bridge.

Any accessibility events sent by platform views belonging to this delegate will be ignored until a new accessibility bridge is attached.

Implements io.flutter.plugin.platform.PlatformViewsAccessibilityDelegate.

Definition at line 861 of file PlatformViewsController.java.

                                          {
    accessibilityEventsDelegate.setAccessibilityBridge(null);
  }

◆ detachFromView()

void io.flutter.plugin.platform.PlatformViewsController.detachFromView ( )

inline

Detaches the controller from FlutterView.

When io.flutter.embedding.android.FlutterFragment is used, this method is called when the device rotates since the FlutterView is detached from the fragment. The next time the fragment needs to be displayed, a new Flutter view is created, so attachToView is called again.

Definition at line 822 of file PlatformViewsController.java.

                               {
    // Remove wrapper for platform views that use GL texture.
    for (int index = 0; index < viewWrappers.size(); index++) {
      final PlatformViewWrapper view = viewWrappers.valueAt(index);
      flutterView.removeView(view);
    }
    // Remove wrapper for platform views that are composed at the view hierarchy level.
    for (int index = 0; index < platformViewParent.size(); index++) {
      final FlutterMutatorView view = platformViewParent.valueAt(index);
      flutterView.removeView(view);
    }
 
    destroyOverlaySurfaces();
    removeOverlaySurfaces();
    flutterView = null;
    flutterViewConvertedToImageView = false;
 
    // Notify that the platform view have been detached from FlutterView.
    for (int index = 0; index < platformViews.size(); index++) {
      final PlatformView view = platformViews.valueAt(index);
      view.onFlutterViewDetached();
    }
  }

◆ detachTextInputPlugin()

void io.flutter.plugin.platform.PlatformViewsController.detachTextInputPlugin ( )

inline

Detaches this controller from the currently attached text input plugin.

Definition at line 879 of file PlatformViewsController.java.

                                      {
    textInputPlugin = null;
  }

◆ disposePlatformView()

void io.flutter.plugin.platform.PlatformViewsController.disposePlatformView ( int viewId )

inline

Disposes a single

Parameters

viewId the PlatformView ID.

Definition at line 1062 of file PlatformViewsController.java.

                                              {
    channelHandler.dispose(viewId);
  }

◆ getOverlayLayerViews()

SparseArray< PlatformOverlayView > io.flutter.plugin.platform.PlatformViewsController.getOverlayLayerViews ( )

inline

Definition at line 1350 of file PlatformViewsController.java.

                                                                 {
    return overlayLayerViews;
  }

◆ getPlatformViewById()

View io.flutter.plugin.platform.PlatformViewsController.getPlatformViewById ( int viewId )

inline

Returns the root of the view hierarchy for the platform view with the requested id, or null if there is no corresponding view.

Implements io.flutter.plugin.platform.PlatformViewsAccessibilityDelegate.

Definition at line 932 of file PlatformViewsController.java.

                                              {
    if (usesVirtualDisplay(viewId)) {
      final VirtualDisplayController controller = vdControllers.get(viewId);
      return controller.getView();
    }
 
    final PlatformView platformView = platformViews.get(viewId);
    if (platformView == null) {
      return null;
    }
    return platformView.getView();
  }

◆ getRegistry()

PlatformViewRegistry io.flutter.plugin.platform.PlatformViewsController.getRegistry ( )

inline

Definition at line 906 of file PlatformViewsController.java.

                                            {
    return registry;
  }

◆ initializePlatformViewIfNeeded()

void io.flutter.plugin.platform.PlatformViewsController.initializePlatformViewIfNeeded ( int viewId )

inlinepackage

Initializes a platform view and adds it to the view hierarchy.

Parameters

viewId The view ID. This member is not intended for public use, and is only visible for testing.

Definition at line 1080 of file PlatformViewsController.java.

                                                  {
    final PlatformView platformView = platformViews.get(viewId);
    if (platformView == null) {
      throw new IllegalStateException(
          "Platform view hasn't been initialized from the platform view channel.");
    }
    if (platformViewParent.get(viewId) != null) {
      return;
    }
    final View embeddedView = platformView.getView();
    if (embeddedView == null) {
      throw new IllegalStateException(
          "PlatformView#getView() returned null, but an Android view reference was expected.");
    }
    if (embeddedView.getParent() != null) {
      throw new IllegalStateException(
          "The Android view returned from PlatformView#getView() was already added to a parent"
              + " view.");
    }
    final FlutterMutatorView parentView =
        new FlutterMutatorView(
            context, context.getResources().getDisplayMetrics().density, androidTouchProcessor);
 
    parentView.setOnDescendantFocusChangeListener(
        (view, hasFocus) -> {
          if (hasFocus) {
            platformViewsChannel.invokeViewFocused(viewId);
          } else if (textInputPlugin != null) {
            textInputPlugin.clearPlatformViewClient(viewId);
          }
        });
 
    platformViewParent.put(viewId, parentView);
 
    // Accessibility in the embedded view is initially disabled because if a Flutter app disabled
    // accessibility in the first frame, the embedding won't receive an update to disable
    // accessibility since the embedding never received an update to enable it.
    // The AccessibilityBridge keeps track of the accessibility nodes, and handles the deltas when
    // the framework sends a new a11y tree to the embedding.
    // To prevent races, the framework populate the SemanticsNode after the platform view has been
    // created.
    embeddedView.setImportantForAccessibility(View.IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS);
 
    parentView.addView(embeddedView);
    flutterView.addView(parentView);
  }

◆ onAttachedToJNI()

void io.flutter.plugin.platform.PlatformViewsController.onAttachedToJNI ( )

inline

Invoked when the io.flutter.embedding.engine.FlutterEngine that owns this PlatformViewsController attaches to JNI.

Definition at line 914 of file PlatformViewsController.java.

                                {
    // Currently no action needs to be taken after JNI attachment.
  }

◆ onBeginFrame()

void io.flutter.plugin.platform.PlatformViewsController.onBeginFrame ( )

inline

Definition at line 1201 of file PlatformViewsController.java.

                             {
    currentFrameUsedOverlayLayerIds.clear();
    currentFrameUsedPlatformViewIds.clear();
  }

◆ onDetachedFromJNI()

void io.flutter.plugin.platform.PlatformViewsController.onDetachedFromJNI ( )

inline

Invoked when the io.flutter.embedding.engine.FlutterEngine that owns this PlatformViewsController detaches from JNI.

Definition at line 922 of file PlatformViewsController.java.

                                  {
    diposeAllViews();
  }

◆ onDisplayOverlaySurface()

void io.flutter.plugin.platform.PlatformViewsController.onDisplayOverlaySurface	(	int	id,
		int	x,
		int	y,
		int	width,
		int	height
	)

inline

Called when an overlay surface is displayed in the current frame.

Parameters

id	The ID of the surface.
x	The left position relative to `FlutterView`.
y	The top position relative to `FlutterView`.
width	The width of the surface.
height	The height of the surface. This member is not intended for public use, and is only visible for testing.

Definition at line 1181 of file PlatformViewsController.java.

                                                                                   {
    if (overlayLayerViews.get(id) == null) {
      throw new IllegalStateException("The overlay surface (id:" + id + ") doesn't exist");
    }
    initializeRootImageViewIfNeeded();
 
    final PlatformOverlayView overlayView = overlayLayerViews.get(id);
    if (overlayView.getParent() == null) {
      flutterView.addView(overlayView);
    }
 
    FrameLayout.LayoutParams layoutParams = new FrameLayout.LayoutParams((int) width, (int) height);
    layoutParams.leftMargin = (int) x;
    layoutParams.topMargin = (int) y;
    overlayView.setLayoutParams(layoutParams);
    overlayView.setVisibility(View.VISIBLE);
    overlayView.bringToFront();
    currentFrameUsedOverlayLayerIds.add(id);
  }

◆ onDisplayPlatformView()

void io.flutter.plugin.platform.PlatformViewsController.onDisplayPlatformView	(	int	viewId,
		int	x,
		int	y,
		int	width,
		int	height,
		int	viewWidth,
		int	viewHeight,
		@NonNull FlutterMutatorsStack	mutatorsStack
	)

inline

Called when a platform view id displayed in the current frame.

Parameters

viewId	The ID of the platform view.
x	The left position relative to `FlutterView`.
y	The top position relative to `FlutterView`.
width	The width of the platform view.
height	The height of the platform view.
viewWidth	The original width of the platform view before applying the mutator stack.
viewHeight	The original height of the platform view before applying the mutator stack.
mutatorsStack	The mutator stack. This member is not intended for public use, and is only visible for testing.

Definition at line 1144 of file PlatformViewsController.java.

                                                   {
    initializeRootImageViewIfNeeded();
    initializePlatformViewIfNeeded(viewId);
 
    final FlutterMutatorView parentView = platformViewParent.get(viewId);
    parentView.readyToDisplay(mutatorsStack, x, y, width, height);
    parentView.setVisibility(View.VISIBLE);
    parentView.bringToFront();
 
    final FrameLayout.LayoutParams layoutParams =
        new FrameLayout.LayoutParams(viewWidth, viewHeight);
    final View view = platformViews.get(viewId).getView();
    if (view != null) {
      view.setLayoutParams(layoutParams);
      view.bringToFront();
    }
    currentFrameUsedPlatformViewIds.add(viewId);
  }

◆ onEndFrame()

void io.flutter.plugin.platform.PlatformViewsController.onEndFrame ( )

inline

Called by FlutterJNI when the Flutter frame was submitted.

This member is not intended for public use, and is only visible for testing.

Definition at line 1211 of file PlatformViewsController.java.

                           {
    // If there are no platform views in the current frame,
    // then revert the image view surface and use the previous surface.
    //
    // Otherwise, acquire the latest image.
    if (flutterViewConvertedToImageView && currentFrameUsedPlatformViewIds.isEmpty()) {
      flutterViewConvertedToImageView = false;
      flutterView.revertImageView(
          () -> {
            // Destroy overlay surfaces once the surface reversion is completed.
            finishFrame(false);
          });
      return;
    }
    // Whether the current frame was rendered using ImageReaders.
    //
    // Since the image readers may not have images available at this point,
    // this becomes true if all the required surfaces have images available.
    //
    // This is used to decide if the platform views can be rendered in the current frame.
    // If one of the surfaces doesn't have an image, the frame may be incomplete and must be
    // dropped.
    // For example, a toolbar widget painted by Flutter may not be rendered.
    final boolean isFrameRenderedUsingImageReaders =
        flutterViewConvertedToImageView && flutterView.acquireLatestImageViewFrame();
    finishFrame(isFrameRenderedUsingImageReaders);
  }

◆ onPreEngineRestart()

void io.flutter.plugin.platform.PlatformViewsController.onPreEngineRestart ( )

inline

Definition at line 926 of file PlatformViewsController.java.

                                   {
    diposeAllViews();
  }

◆ setSoftwareRendering()

void io.flutter.plugin.platform.PlatformViewsController.setSoftwareRendering ( boolean useSoftwareRendering )

inline

Sets whether Flutter uses software rendering.

When software rendering is used, no GL context is available on the raster thread. When this is set to true, there's no Flutter composition of Android views and Flutter widgets since GL textures cannot be used.

Software rendering is only used for testing in emulators, and it should never be set to true in a production environment.

Parameters

useSoftwareRendering Whether software rendering is used.

Definition at line 767 of file PlatformViewsController.java.

                                                                 {
    usesSoftwareRendering = useSoftwareRendering;
  }

◆ toMotionEvent()

MotionEvent io.flutter.plugin.platform.PlatformViewsController.toMotionEvent	(	float	density,
		PlatformViewsChannel.PlatformViewTouch	touch,
		boolean	usingVirtualDiplay
	)

inline

Definition at line 671 of file PlatformViewsController.java.

                                                                                               {
    MotionEventTracker.MotionEventId motionEventId =
        MotionEventTracker.MotionEventId.from(touch.motionEventId);
    MotionEvent trackedEvent = motionEventTracker.pop(motionEventId);
 
    if (!usingVirtualDiplay && trackedEvent != null) {
      // We have the original event, deliver it as it will pass the verifiable
      // input check.
      return trackedEvent;
    }
    // We are in virtual display mode or don't have a reference to the original MotionEvent.
    // In this case we manually recreate a MotionEvent to be delivered. This MotionEvent
    // will fail the verifiable input check.
 
    // Pointer coordinates in the tracked events are global to FlutterView
    // framework converts them to be local to a widget, given that
    // motion events operate on local coords, we need to replace these in the tracked
    // event with their local counterparts.
    PointerProperties[] pointerProperties =
        parsePointerPropertiesList(touch.rawPointerPropertiesList)
            .toArray(new PointerProperties[touch.pointerCount]);
    PointerCoords[] pointerCoords =
        parsePointerCoordsList(touch.rawPointerCoords, density)
            .toArray(new PointerCoords[touch.pointerCount]);
 
    // TODO (kaushikiska) : warn that we are potentially using an untracked
    // event in the platform views.
    return MotionEvent.obtain(
        touch.downTime.longValue(),
        touch.eventTime.longValue(),
        touch.action,
        touch.pointerCount,
        pointerProperties,
        pointerCoords,
        touch.metaState,
        touch.buttonState,
        touch.xPrecision,
        touch.yPrecision,
        touch.deviceId,
        touch.edgeFlags,
        touch.source,
        touch.flags);
  }

◆ usesVirtualDisplay()

boolean io.flutter.plugin.platform.PlatformViewsController.usesVirtualDisplay ( int id )

inline

Returns true if the platform view uses virtual displays.

Implements io.flutter.plugin.platform.PlatformViewsAccessibilityDelegate.

Definition at line 946 of file PlatformViewsController.java.

                                            {
    return vdControllers.containsKey(id);
  }

Member Data Documentation

◆ contextToEmbeddedView

final HashMap<Context, View> io.flutter.plugin.platform.PlatformViewsController.contextToEmbeddedView

package

Definition at line 99 of file PlatformViewsController.java.

◆ vdControllers

final HashMap<Integer, VirtualDisplayController> io.flutter.plugin.platform.PlatformViewsController.vdControllers

package

Definition at line 93 of file PlatformViewsController.java.

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

shell/platform/android/io/flutter/plugin/platform/PlatformViewsController.java

Public Member Functions

Package Functions

Package Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PlatformViewsController()

Member Function Documentation

◆ attach()

◆ attachAccessibilityBridge()

◆ attachTextInputPlugin()

◆ attachToFlutterRenderer()

◆ attachToView()

◆ checkInputConnectionProxy()

◆ configureForTextureLayerComposition()

◆ createOverlaySurface() [1/2]

◆ createOverlaySurface() [2/2]

◆ createPlatformView()

◆ destroyOverlaySurfaces()

◆ detach()

◆ detachAccessibilityBridge()

◆ detachFromView()

◆ detachTextInputPlugin()

◆ disposePlatformView()

◆ getOverlayLayerViews()

◆ getPlatformViewById()

◆ getRegistry()

◆ initializePlatformViewIfNeeded()

◆ onAttachedToJNI()

◆ onBeginFrame()

◆ onDetachedFromJNI()

◆ onDisplayOverlaySurface()

◆ onDisplayPlatformView()

◆ onEndFrame()

◆ onPreEngineRestart()

◆ setSoftwareRendering()

◆ toMotionEvent()

◆ usesVirtualDisplay()

Member Data Documentation

◆ contextToEmbeddedView

◆ vdControllers