FlutterRenderer Class Reference

#include <FlutterRenderer.h>

Instance Methods
(nullable instancetype)	- initWithFlutterEngine:
(FlutterRendererConfig)	- createRendererConfig
(BOOL)	- populateTextureWithIdentifier:metalTexture:
(BOOL)	- populateTextureWithIdentifier:metalTexture: [implementation]
(FlutterExternalTexture *)	- onRegisterTexture: [implementation]

Protected Attributes
	: FlutterTextureRegistrar <FlutterTextureRegistry

Properties
FlutterTextureRegistrarDelegate id< MTLDevice >	device
id< MTLCommandQueue >	commandQueue

Detailed Description

Rendering backend agnostic FlutterRendererConfig provider to be used by the embedder API.

Definition at line 18 of file FlutterRenderer.h.

Method Documentation

createRendererConfig

- (FlutterRendererConfig) createRendererConfig

Creates a FlutterRendererConfig that renders using the appropriate backend.

Definition at line 26 of file FlutterRenderer.mm.

                                              {
  FlutterRendererConfig config = {
      .type = FlutterRendererType::kMetal,
      .metal = {
          .struct_size = sizeof(FlutterMetalRendererConfig),
          .device = (__bridge FlutterMetalDeviceHandle)_device,
          .present_command_queue = (__bridge FlutterMetalCommandQueueHandle)_commandQueue,
          .get_next_drawable_callback =
              reinterpret_cast<FlutterMetalTextureCallback>(OnGetNextDrawable),
          .present_drawable_callback =
              reinterpret_cast<FlutterMetalPresentCallback>(OnPresentDrawable),
          .external_texture_frame_callback =
              reinterpret_cast<FlutterMetalTextureFrameCallback>(OnAcquireExternalTexture),
      }};
  return config;
}

initWithFlutterEngine:

- (instancetype) initWithFlutterEngine:

(nonnull FlutterEngine*)

flutterEngine

Initial value:

{
  FlutterDarwinContextMetalSkia* _darwinMetalContext

Intializes the renderer with the given FlutterEngine.

Definition at line 26 of file FlutterRenderer.mm.

                                     :(nonnull FlutterEngine*)flutterEngine {
  self = [super initWithDelegate:self engine:flutterEngine];
  if (self) {
    _device = MTLCreateSystemDefaultDevice();
    if (!_device) {
      NSLog(@"Could not acquire Metal device.");
      return nil;
    }
 
    _commandQueue = [_device newCommandQueue];
    if (!_commandQueue) {
      NSLog(@"Could not create Metal command queue.");
      return nil;
    }
 
    _darwinMetalContext = [[FlutterDarwinContextMetalSkia alloc] initWithMTLDevice:_device
                                                                      commandQueue:_commandQueue];
  }
  return self;
}

onRegisterTexture:

- (FlutterExternalTexture *) onRegisterTexture: (id<FlutterTexture>)  texture

implementation

Definition at line 26 of file FlutterRenderer.mm.

                                            :(id<FlutterTexture>)texture {
  return [[FlutterExternalTexture alloc] initWithFlutterTexture:texture
                                             darwinMetalContext:_darwinMetalContext];
}

populateTextureWithIdentifier:metalTexture: [1/2]

- (BOOL) populateTextureWithIdentifier: (int64_t)  textureID metalTexture: (FlutterMetalExternalTexture*)  textureOut

implementation

Definition at line 26 of file FlutterRenderer.mm.

                                     :(int64_t)textureID
                         metalTexture:(FlutterMetalExternalTexture*)textureOut {
  FlutterExternalTexture* texture = [self getTextureWithID:textureID];
  return [texture populateTexture:textureOut];
}

populateTextureWithIdentifier:metalTexture: [2/2]

- (BOOL) populateTextureWithIdentifier:		(int64_t)	textureID
metalTexture:		(nonnull FlutterMetalExternalTexture *)	metalTexture

Populates the texture registry with the provided metalTexture.

Member Data Documentation

__pad0__

- __pad0__

protected

Definition at line 1 of file FlutterRenderer.h.

Property Documentation

commandQueue

- (id<MTLCommandQueue>) commandQueue

readnonatomicassign

Used to get the command buffers for the MTLDevice to render to.

Definition at line 29 of file FlutterRenderer.h.

device

- (FlutterTextureRegistrarDelegate id<MTLDevice>) device

readnonatomicassign

Interface to the system GPU. Used to issue all the rendering commands.

Definition at line 24 of file FlutterRenderer.h.

---

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

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