FlutterView Class Reference

#include <FlutterView.h>

Inheritance diagram for FlutterView:

Instance Methods
(instancetype)	- NS_UNAVAILABLE
(instancetype)	- initWithFrame:
(instancetype)	- initWithCoder:
(instancetype)	- initWithDelegate:opaque:enableWideGamut:
(UIScreen *)	- screen
(MTLPixelFormat)	- pixelFormat
(nullable instancetype)	- initWithMTLDevice:commandQueue:delegate:viewIdentifier:
(nullable instancetype)	- initWithFrame:pixelFormat:
(nonnull instancetype)	- initWithFrame:
(nullable instancetype)	- initWithCoder:
(nonnull instancetype)	- NS_UNAVAILABLE
(void)	- setBackgroundColor:
(void)	- didUpdateMouseCursor:
(void)	- shutDown

Class Methods
(instancetype)	+ NS_UNAVAILABLE

Properties
FlutterSurfaceManager *	surfaceManager

Detailed Description

View capable of acting as a rendering target and input source for the Flutter engine.

Definition at line 32 of file FlutterView.h.

Method Documentation

didUpdateMouseCursor:

- (void) didUpdateMouseCursor:

(nonnull NSCursor *)

cursor

Called from the engine to notify the view that mouse cursor was updated while the mouse is over the view. The view is responsible from restoring the cursor when the mouse enters the view from another subview.

Referenced by TEST(), and TEST().

initWithCoder: [1/2]

- (nullable instancetype) initWithCoder:

(nonnull NSCoder *)

NS_UNAVAILABLE

initWithCoder: [2/2]

- (instancetype) initWithCoder:

(NSCoder*)

NS_UNAVAILABLE

Definition at line 16 of file FlutterView.mm.

                             :(NSCoder*)aDecoder {
  NSAssert(NO, @"FlutterView must initWithDelegate");
  return nil;
}

initWithDelegate:opaque:enableWideGamut:

- (instancetype) initWithDelegate:		(id<FlutterViewEngineDelegate>)	delegate
opaque:		(BOOL)	opaque
enableWideGamut:		(BOOL)	NS_DESIGNATED_INITIALIZER

Definition at line 16 of file FlutterView.mm.

                                :(id<FlutterViewEngineDelegate>)delegate
                          opaque:(BOOL)opaque
                 enableWideGamut:(BOOL)isWideGamutEnabled {
  if (delegate == nil) {
    NSLog(@"FlutterView delegate was nil.");
    return nil;
  }
 
  self = [super initWithFrame:CGRectNull];
 
  if (self) {
    _delegate = delegate;
    _isWideGamutEnabled = isWideGamutEnabled;
    self.layer.opaque = opaque;
  }
 
  return self;
}

initWithFrame: [1/2]

- (instancetype) initWithFrame:

(CGRect)

NS_UNAVAILABLE

Definition at line 16 of file FlutterView.mm.

                             :(CGRect)frame {
  NSAssert(NO, @"FlutterView must initWithDelegate");
  return nil;
}

initWithFrame: [2/2]

- (nonnull instancetype) initWithFrame:

(NSRect)

NS_UNAVAILABLE

initWithFrame:pixelFormat:

- (nullable instancetype) initWithFrame:		(NSRect)	frameRect
pixelFormat:		(nullable NSOpenGLPixelFormat *)	NS_UNAVAILABLE

initWithMTLDevice:commandQueue:delegate:viewIdentifier:

- (nullable instancetype) initWithMTLDevice:		(nonnull id< MTLDevice >)	device
commandQueue:		(nonnull id< MTLCommandQueue >)	commandQueue
delegate:		(nonnull id< FlutterViewDelegate >)	delegate
viewIdentifier:		(FlutterViewIdentifier)	NS_DESIGNATED_INITIALIZER

Initialize a FlutterView that will be rendered to using Metal rendering apis.

NS_UNAVAILABLE [1/3]

- (instancetype) NS_UNAVAILABLE

NS_UNAVAILABLE [2/3]

+ (instancetype) NS_UNAVAILABLE

NS_UNAVAILABLE [3/3]

- (nonnull instancetype) NS_UNAVAILABLE

pixelFormat

- (MTLPixelFormat) pixelFormat

Definition at line 16 of file FlutterView.mm.

                              {
  if ([self.layer isKindOfClass:[CAMetalLayer class]]) {
// It is a known Apple bug that CAMetalLayer incorrectly reports its supported
// SDKs. It is, in fact, available since iOS 8.
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wunguarded-availability-new"
    CAMetalLayer* layer = (CAMetalLayer*)self.layer;
    return layer.pixelFormat;
  }
  return MTLPixelFormatBGRA8Unorm;
}

screen

- (UIScreen *) screen

Definition at line 16 of file FlutterView.mm.

                    {
  return self.window.windowScene.screen;
}

setBackgroundColor:

- (void) setBackgroundColor:

(nonnull NSColor *)

color

By default, the FlutterSurfaceManager creates two layers to manage Flutter content, the content layer and containing layer. To set the native background color, onto which the Flutter content is drawn, call this method with the NSColor which you would like to override the default, black background color with.

shutDown

- (void) shutDown

Called from the controller to unblock resize synchronizer when shutting down.

Definition at line 18 of file FlutterView.mm.

                 {
  [_resizeSynchronizer shutDown];
}

Property Documentation

surfaceManager

- (FlutterSurfaceManager *) surfaceManager

readnonatomicassign

Returns SurfaceManager for this view. SurfaceManager is responsible for providing and presenting render surfaces.

Definition at line 56 of file FlutterView.h.

---

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

• shell/platform/darwin/ios/framework/Source/FlutterView.h
• shell/platform/darwin/macos/framework/Source/FlutterView.h
• shell/platform/darwin/ios/framework/Source/FlutterView.mm
• shell/platform/darwin/macos/framework/Source/FlutterView.mm