FlutterDarwinContextMetalSkia Class Reference

#import <FlutterDarwinContextMetalSkia.h>

Inheritance diagram for FlutterDarwinContextMetalSkia:

Instance Methods
(instancetype)	- initWithDefaultMTLDevice
(instancetype)	- initWithMTLDevice:commandQueue:
(FlutterDarwinExternalTextureMetal *)	- createExternalTextureWithIdentifier:texture:
(sk_sp< GrDirectContext >)	- createGrContext [implementation]
(void)	- dealloc [implementation]

Class Methods
(sk_sp< GrDirectContext >)	+ createGrContext:commandQueue:

Properties
id< MTLDevice >	device
id< MTLCommandQueue >	commandQueue
sk_sp< GrDirectContext >	mainContext
sk_sp< GrDirectContext >	resourceContext
CVMetalTextureCacheRef	textureCache

Detailed Description

Provides skia GrContexts that are shared between iOS and macOS embeddings.

Definition at line 23 of file FlutterDarwinContextMetalSkia.h.

Method Documentation

createExternalTextureWithIdentifier:texture:

- (FlutterDarwinExternalTextureMetal *) createExternalTextureWithIdentifier:		(int64_t)	textureID
texture:		(NSObject<FlutterTexture>*)	texture

Creates an external texture with the specified ID and contents.

Definition at line 17 of file FlutterDarwinContextMetalSkia.mm.

                                       :(int64_t)textureID
                                texture:(NSObject<FlutterTexture>*)texture {
  return [[FlutterDarwinExternalTextureMetal alloc] initWithTextureCache:_textureCache
                                                               textureID:textureID
                                                                 texture:texture
                                                          enableImpeller:NO];
}

createGrContext

- (sk_sp< GrDirectContext >) createGrContext

implementation

Definition at line 17 of file FlutterDarwinContextMetalSkia.mm.

                                          {
  const auto contextOptions =
      flutter::MakeDefaultContextOptions(flutter::ContextType::kRender, GrBackendApi::kMetal);
  id<MTLDevice> device = _device;
  id<MTLCommandQueue> commandQueue = _commandQueue;
  return [FlutterDarwinContextMetalSkia createGrContext:device commandQueue:commandQueue];
}

createGrContext:commandQueue:

+ (sk_sp< GrDirectContext >) createGrContext:		(id<MTLDevice>)	device
commandQueue:		(id<MTLCommandQueue>)	commandQueue

Creates a GrDirectContext with the provided MTLDevice and MTLCommandQueue.

Definition at line 17 of file FlutterDarwinContextMetalSkia.mm.

                                         :(id<MTLDevice>)device
                             commandQueue:(id<MTLCommandQueue>)commandQueue {
  const auto contextOptions =
      flutter::MakeDefaultContextOptions(flutter::ContextType::kRender, GrBackendApi::kMetal);
  GrMtlBackendContext backendContext = {};
  // Skia expect arguments to `MakeMetal` transfer ownership of the reference in for release later
  // when the GrDirectContext is collected.
  backendContext.fDevice.reset((__bridge_retained void*)device);
  backendContext.fQueue.reset((__bridge_retained void*)commandQueue);
  return GrDirectContexts::MakeMetal(backendContext, contextOptions);
}

dealloc

- (void) dealloc

implementation

Definition at line 17 of file FlutterDarwinContextMetalSkia.mm.

                {
  if (_textureCache) {
    CFRelease(_textureCache);
  }
}

initWithDefaultMTLDevice

- (instancetype) initWithDefaultMTLDevice

Initializes a FlutterDarwinContextMetalSkia with the system default MTLDevice and a new MTLCommandQueue.

Definition at line 17 of file FlutterDarwinContextMetalSkia.mm.

                                         {
  id<MTLDevice> device = MTLCreateSystemDefaultDevice();
  return [self initWithMTLDevice:device commandQueue:[device newCommandQueue]];
}

initWithMTLDevice:commandQueue:

- (instancetype) initWithMTLDevice:		(id<MTLDevice>)	device
commandQueue:		(id<MTLCommandQueue>)	commandQueue

Initializes a FlutterDarwinContextMetalSkia with provided MTLDevice and MTLCommandQueue.

Definition at line 17 of file FlutterDarwinContextMetalSkia.mm.

                                 :(id<MTLDevice>)device
                     commandQueue:(id<MTLCommandQueue>)commandQueue {
  self = [super init];
  if (self != nil) {
    _device = device;
 
    if (!_device) {
      FML_DLOG(ERROR) << "Could not acquire Metal device.";
      return nil;
    }
 
    _commandQueue = commandQueue;
 
    if (!_commandQueue) {
      FML_DLOG(ERROR) << "Could not create Metal command queue.";
      return nil;
    }
 
    [_commandQueue setLabel:@"Flutter Main Queue"];
 
    CVReturn cvReturn = CVMetalTextureCacheCreate(kCFAllocatorDefault,  // allocator
                                                  nil,      // cache attributes (nil default)
                                                  _device,  // metal device
                                                  nil,      // texture attributes (nil default)
                                                  &_textureCache  // [out] cache
    );
    if (cvReturn != kCVReturnSuccess) {
      FML_DLOG(ERROR) << "Could not create Metal texture cache.";
      return nil;
    }
 
    // The devices are in the same "sharegroup" because they share the same device and command
    // queues for now. When the resource context gets its own transfer queue, this will have to be
    // refactored.
    _mainContext = [self createGrContext];
    _resourceContext = [self createGrContext];
 
    if (!_mainContext || !_resourceContext) {
      FML_DLOG(ERROR) << "Could not create Skia Metal contexts.";
      return nil;
    }
 
    // Only log this message on iOS where the default is Impeller. On macOS
    // desktop, Skia is still the default and this log is unecessary.
#if defined(FML_OS_IOS) || defined(FML_OS_IOS_SIM)
    FML_LOG(IMPORTANT) << "Using the Skia rendering backend (Metal).";
#endif  // defined(FML_OS_IOS) || defined(FML_OS_IOS_SIM)
 
    _resourceContext->setResourceCacheLimit(0u);
  }
  return self;
}

Property Documentation

commandQueue

- (id<MTLCommandQueue>) commandQueue

readnonatomicassign

MTLCommandQueue that is acquired from the device. This queue is used both for rendering and resource related commands.

Definition at line 59 of file FlutterDarwinContextMetalSkia.h.

device

- (id<MTLDevice>) device

readnonatomicassign

MTLDevice that is backing this context.s

Definition at line 53 of file FlutterDarwinContextMetalSkia.h.

mainContext

- (sk_sp<GrDirectContext>) mainContext

readnonatomicassign

Skia GrContext that is used for rendering.

Definition at line 64 of file FlutterDarwinContextMetalSkia.h.

resourceContext

- (sk_sp<GrDirectContext>) resourceContext

readnonatomicassign

Skia GrContext that is used for resources (uploading textures etc).

Definition at line 69 of file FlutterDarwinContextMetalSkia.h.

textureCache

- (CVMetalTextureCacheRef) textureCache

readnonatomicassign

Definition at line 74 of file FlutterDarwinContextMetalSkia.h.

---

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

• shell/platform/darwin/graphics/FlutterDarwinContextMetalSkia.h
• shell/platform/darwin/graphics/FlutterDarwinContextMetalSkia.mm