io.flutter.plugin.platform.VirtualDisplayController Class Reference

Classes
class	OneTimeOnDrawListener

Public Member Functions
int	getRenderTargetWidth ()
int	getRenderTargetHeight ()
void	resize (final int width, final int height, final Runnable onNewSizeFrameAvailable)
void	dispose ()
View	getView ()
void	dispatchTouchEvent (MotionEvent event)
void	clearSurface ()
void	resetSurface ()

Static Public Member Functions
static VirtualDisplayController	create (Context context, AccessibilityEventsDelegate accessibilityEventsDelegate, PlatformView view, PlatformViewRenderTarget renderTarget, int width, int height, int viewId, Object createParams, OnFocusChangeListener focusChangeListener)

Package Functions
void	onFlutterViewAttached (@NonNull View flutterView)
void	onFlutterViewDetached ()
void	onInputConnectionLocked ()
void	onInputConnectionUnlocked ()

Package Attributes
SingleViewPresentation	presentation

Detailed Description

Definition at line 23 of file VirtualDisplayController.java.

Member Function Documentation

clearSurface()

void io.flutter.plugin.platform.VirtualDisplayController.clearSurface ( )

inline

Definition at line 287 of file VirtualDisplayController.java.

                             {
    virtualDisplay.setSurface(null);
  }

create()

static VirtualDisplayController io.flutter.plugin.platform.VirtualDisplayController.create ( Context  context, AccessibilityEventsDelegate  accessibilityEventsDelegate, PlatformView  view, PlatformViewRenderTarget  renderTarget, int  width, int  height, int  viewId, Object  createParams, OnFocusChangeListener  focusChangeListener  )

inlinestatic

Definition at line 35 of file VirtualDisplayController.java.

                                                 {
    if (width == 0 || height == 0) {
      return null;
    }
 
    DisplayManager displayManager =
        (DisplayManager) context.getSystemService(Context.DISPLAY_SERVICE);
    final DisplayMetrics metrics = context.getResources().getDisplayMetrics();
 
    // Virtual Display crashes for some PlatformViews if the width or height is bigger
    // than the physical screen size. We have tried to clamp or scale down the size to prevent
    // the crash, but both solutions lead to unwanted behavior because the
    // AndroidPlatformView(https://github.com/flutter/flutter/blob/master/packages/flutter/lib/src/widgets/platform_view.dart#L677) widget doesn't
    // scale or clamp, which leads to a mismatch between the size of the widget and the size of
    // virtual display.
    // This mismatch leads to some test failures: https://github.com/flutter/flutter/issues/106750
    // TODO(cyanglaz): find a way to prevent the crash without introducing size mistach betewen
    // virtual display and AndroidPlatformView widget.
    // https://github.com/flutter/flutter/issues/93115
    renderTarget.resize(width, height);
    int flags = 0;
    VirtualDisplay virtualDisplay =
        displayManager.createVirtualDisplay(
            "flutter-vd#" + viewId,
            width,
            height,
            metrics.densityDpi,
            renderTarget.getSurface(),
            flags,
            callback,
            null /* handler */);
 
    if (virtualDisplay == null) {
      return null;
    }
    VirtualDisplayController controller =
        new VirtualDisplayController(
            context,
            accessibilityEventsDelegate,
            virtualDisplay,
            view,
            renderTarget,
            focusChangeListener,
            viewId,
            createParams);
    return controller;
  }

dispatchTouchEvent()

void io.flutter.plugin.platform.VirtualDisplayController.dispatchTouchEvent ( MotionEvent  event )

inline

Dispatches a motion event to the presentation for this controller.

Definition at line 282 of file VirtualDisplayController.java.

                                                    {
    if (presentation == null) return;
    presentation.dispatchTouchEvent(event);
  }

dispose()

void io.flutter.plugin.platform.VirtualDisplayController.dispose ( )

inline

Definition at line 226 of file VirtualDisplayController.java.

                        {
    // Fix rare crash on HuaWei device described in: https://github.com/flutter/engine/pull/9192
    presentation.cancel();
    presentation.detachState();
    virtualDisplay.release();
    renderTarget.release();
  }

getRenderTargetHeight()

int io.flutter.plugin.platform.VirtualDisplayController.getRenderTargetHeight ( )

inline

Definition at line 137 of file VirtualDisplayController.java.

                                     {
    if (renderTarget != null) {
      return renderTarget.getHeight();
    }
    return 0;
  }

getRenderTargetWidth()

int io.flutter.plugin.platform.VirtualDisplayController.getRenderTargetWidth ( )

inline

Definition at line 130 of file VirtualDisplayController.java.

                                    {
    if (renderTarget != null) {
      return renderTarget.getWidth();
    }
    return 0;
  }

getView()

View io.flutter.plugin.platform.VirtualDisplayController.getView ( )

inline

Definition at line 275 of file VirtualDisplayController.java.

                        {
    if (presentation == null) return null;
    PlatformView platformView = presentation.getView();
    return platformView.getView();
  }

onFlutterViewAttached()

void io.flutter.plugin.platform.VirtualDisplayController.onFlutterViewAttached ( @NonNull View  flutterView )

inlinepackage

See PlatformView#onFlutterViewAttached(View)

Definition at line 246 of file VirtualDisplayController.java.

                                                          {
    if (presentation == null || presentation.getView() == null) {
      return;
    }
    presentation.getView().onFlutterViewAttached(flutterView);
  }

onFlutterViewDetached()

void io.flutter.plugin.platform.VirtualDisplayController.onFlutterViewDetached ( )

inlinepackage

See PlatformView#onFlutterViewDetached()

Definition at line 254 of file VirtualDisplayController.java.

                                 {
    if (presentation == null || presentation.getView() == null) {
      return;
    }
    presentation.getView().onFlutterViewDetached();
  }

onInputConnectionLocked()

void io.flutter.plugin.platform.VirtualDisplayController.onInputConnectionLocked ( )

inlinepackage

Definition at line 261 of file VirtualDisplayController.java.

                                   {
    if (presentation == null || presentation.getView() == null) {
      return;
    }
    presentation.getView().onInputConnectionLocked();
  }

onInputConnectionUnlocked()

void io.flutter.plugin.platform.VirtualDisplayController.onInputConnectionUnlocked ( )

inlinepackage

Definition at line 268 of file VirtualDisplayController.java.

                                     {
    if (presentation == null || presentation.getView() == null) {
      return;
    }
    presentation.getView().onInputConnectionUnlocked();
  }

resetSurface()

void io.flutter.plugin.platform.VirtualDisplayController.resetSurface ( )

inline

Definition at line 291 of file VirtualDisplayController.java.

                             {
    final int width = getRenderTargetWidth();
    final int height = getRenderTargetHeight();
    final boolean isFocused = getView().isFocused();
    final SingleViewPresentation.PresentationState presentationState = presentation.detachState();
 
    // We detach the surface to prevent it being destroyed when releasing the vd.
    virtualDisplay.setSurface(null);
    virtualDisplay.release();
    final DisplayManager displayManager =
        (DisplayManager) context.getSystemService(Context.DISPLAY_SERVICE);
    int flags = 0;
    virtualDisplay =
        displayManager.createVirtualDisplay(
            "flutter-vd#" + viewId,
            width,
            height,
            densityDpi,
            renderTarget.getSurface(),
            flags,
            callback,
            null /* handler */);
    // Create a new SingleViewPresentation and show() it before we cancel() the existing
    // presentation. Calling show() and cancel() in this order fixes
    // https://github.com/flutter/flutter/issues/26345 and maintains seamless transition
    // of the contents of the presentation.
    SingleViewPresentation newPresentation =
        new SingleViewPresentation(
            context,
            virtualDisplay.getDisplay(),
            accessibilityEventsDelegate,
            presentationState,
            focusChangeListener,
            isFocused);
    newPresentation.show();
    presentation.cancel();
    presentation = newPresentation;
  }

resize()

void io.flutter.plugin.platform.VirtualDisplayController.resize ( final int  width, final int  height, final Runnable  onNewSizeFrameAvailable  )

inline

Definition at line 144 of file VirtualDisplayController.java.

                                                                                                {
    // When 'hot reload', although the resize method is triggered, the size of the native View has
    // not changed.
    if (width == getRenderTargetWidth() && height == getRenderTargetHeight()) {
      getView().postDelayed(onNewSizeFrameAvailable, 0);
      return;
    }
    if (Build.VERSION.SDK_INT >= API_LEVELS.API_31) {
      resize31(getView(), width, height, onNewSizeFrameAvailable);
      return;
    }
    boolean isFocused = getView().isFocused();
    final SingleViewPresentation.PresentationState presentationState = presentation.detachState();
    // We detach the surface to prevent it being destroyed when releasing the vd.
    virtualDisplay.setSurface(null);
    virtualDisplay.release();
 
    final DisplayManager displayManager =
        (DisplayManager) context.getSystemService(Context.DISPLAY_SERVICE);
    renderTarget.resize(width, height);
    int flags = 0;
    virtualDisplay =
        displayManager.createVirtualDisplay(
            "flutter-vd#" + viewId,
            width,
            height,
            densityDpi,
            renderTarget.getSurface(),
            flags,
            callback,
            null /* handler */);
 
    final View embeddedView = getView();
    // There's a bug in Android version older than O where view tree observer onDrawListeners don't
    // get properly
    // merged when attaching to window, as a workaround we register the on draw listener after the
    // view is attached.
    embeddedView.addOnAttachStateChangeListener(
        new View.OnAttachStateChangeListener() {
          @Override
          public void onViewAttachedToWindow(View v) {
            OneTimeOnDrawListener.schedule(
                embeddedView,
                new Runnable() {
                  @Override
                  public void run() {
                    // We need some delay here until the frame propagates through the vd surface to
                    // the texture,
                    // 128ms was picked pretty arbitrarily based on trial and error.
                    // As long as we invoke the runnable after a new frame is available we avoid the
                    // scaling jank
                    // described in: https://github.com/flutter/flutter/issues/19572
                    // We should ideally run onNewSizeFrameAvailable ASAP to make the embedded view
                    // more responsive
                    // following a resize.
                    embeddedView.postDelayed(onNewSizeFrameAvailable, 128);
                  }
                });
            embeddedView.removeOnAttachStateChangeListener(this);
          }
 
          @Override
          public void onViewDetachedFromWindow(View v) {}
        });
 
    // Create a new SingleViewPresentation and show() it before we cancel() the existing
    // presentation. Calling show() and cancel() in this order fixes
    // https://github.com/flutter/flutter/issues/26345 and maintains seamless transition
    // of the contents of the presentation.
    SingleViewPresentation newPresentation =
        new SingleViewPresentation(
            context,
            virtualDisplay.getDisplay(),
            accessibilityEventsDelegate,
            presentationState,
            focusChangeListener,
            isFocused);
    newPresentation.show();
    presentation.cancel();
    presentation = newPresentation;
  }

Member Data Documentation

presentation

SingleViewPresentation io.flutter.plugin.platform.VirtualDisplayController.presentation

package

Definition at line 92 of file VirtualDisplayController.java.

---

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

• shell/platform/android/io/flutter/plugin/platform/VirtualDisplayController.java