FlutterOverlayView Class Reference

#include <FlutterOverlayView.h>

Inheritance diagram for FlutterOverlayView:

Instance Methods
(instancetype)	- initWithFrame:
(instancetype)	- initWithCoder:
(instancetype)	- NS_DESIGNATED_INITIALIZER
(instancetype)	- initWithContentsScale:pixelFormat:
(instancetype)	- init [implementation]

Class Methods
(Class)	+ layerClass [implementation]

Detailed Description

UIViews that are used by |FlutterPlatformViews| to present Flutter rendering on top of system compositor rendering (ex. a web view).

When there is a view composited by the system compositor within a Flutter view hierarchy, instead of rendering into a single render target, Flutter renders into multiple render targets (depending on the number of interleaving levels between Flutter & non-Flutter contents). While the FlutterView contains the backing store for the root render target, the FlutterOverlay view contains the backing stores for the rest. The overlay views also handle touch propagation and the like for touches that occurs either on overlays or otherwise may be intercepted by the platform views.

Definition at line 22 of file FlutterOverlayView.h.

Method Documentation

init

- (instancetype) init

implementation

Definition at line 1 of file FlutterOverlayView.mm.

                     {
  self = [super initWithFrame:CGRectZero];
 
  if (self) {
    self.layer.opaque = NO;
    self.userInteractionEnabled = NO;
    self.autoresizingMask = (UIViewAutoresizingFlexibleWidth | UIViewAutoresizingFlexibleHeight);
  }
 
  return self;
}

initWithCoder:

- (instancetype) initWithCoder:

(NSCoder*)

NS_UNAVAILABLE

Definition at line 1 of file FlutterOverlayView.mm.

                             :(NSCoder*)aDecoder {
  NSAssert(NO, @"FlutterOverlayView must init or initWithContentsScale");
  return nil;
}

initWithContentsScale:pixelFormat:

- (instancetype) initWithContentsScale:		(CGFloat)	contentsScale
pixelFormat:		(MTLPixelFormat)	pixelFormat

Definition at line 1 of file FlutterOverlayView.mm.

                                     :(CGFloat)contentsScale
                          pixelFormat:(MTLPixelFormat)pixelFormat {
  self = [self init];
 
  if ([self.layer isKindOfClass:NSClassFromString(@"CAMetalLayer")]) {
    self.layer.allowsGroupOpacity = NO;
    self.layer.contentsScale = contentsScale;
    self.layer.rasterizationScale = contentsScale;
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wunguarded-availability-new"
    CAMetalLayer* layer = (CAMetalLayer*)self.layer;
#pragma clang diagnostic pop
    layer.pixelFormat = pixelFormat;
    if (pixelFormat == MTLPixelFormatRGBA16Float || pixelFormat == MTLPixelFormatBGRA10_XR) {
      self->_colorSpaceRef = fml::CFRef(CGColorSpaceCreateWithName(kCGColorSpaceExtendedSRGB));
      layer.colorspace = self->_colorSpaceRef;
    }
  }
  return self;
}

initWithFrame:

- (instancetype) initWithFrame:

(CGRect)

NS_UNAVAILABLE

Initial value:

{
  fml::CFRef<CGColorSpaceRef> _colorSpaceRef

Definition at line 1 of file FlutterOverlayView.mm.

                             :(CGRect)frame {
  NSAssert(NO, @"FlutterOverlayView must init or initWithContentsScale");
  return nil;
}

layerClass

+ (Class) layerClass

implementation

Definition at line 1 of file FlutterOverlayView.mm.

                    {
  return [FlutterView layerClass];
}

NS_DESIGNATED_INITIALIZER

- (instancetype) NS_DESIGNATED_INITIALIZER

---

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

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