FlutterView Class Reference

#import <FlutterView.h>

Inheritance diagram for FlutterView:

Instance Methods
(nullable instancetype)	- initWithMTLDevice:commandQueue:delegate:threadSynchronizer:viewIdentifier:
(nullable instancetype)	- initWithFrame:pixelFormat:
(nonnull instancetype)	- initWithFrame:
(nullable instancetype)	- initWithCoder:
(nonnull instancetype)	- NS_UNAVAILABLE
(void)	- setBackgroundColor:
(void)	- didUpdateMouseCursor:

Properties
FlutterSurfaceManager *	surfaceManager

Detailed Description

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

Definition at line 35 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().

initWithCoder:

- (nullable instancetype) initWithCoder:

(nonnull NSCoder *)

NS_UNAVAILABLE

initWithFrame:

- (nonnull instancetype) initWithFrame:

(NSRect)

NS_UNAVAILABLE

initWithFrame:pixelFormat:

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

initWithMTLDevice:commandQueue:delegate:threadSynchronizer:viewIdentifier:

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

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

NS_UNAVAILABLE

- (nonnull instancetype) NS_UNAVAILABLE

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.

Property Documentation

surfaceManager

- (FlutterSurfaceManager *) surfaceManager

readnonatomicassign

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

Definition at line 57 of file FlutterView.h.

Referenced by flutter::FlutterCompositor::CreateBackingStore(), and flutter::FlutterCompositor::Present().

---

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

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