flutter::FlutterCompositor Class Reference

#include <FlutterCompositor.h>

Public Member Functions
	FlutterCompositor (id< FlutterViewProvider > view_provider, FlutterTimeConverter *time_converter, FlutterPlatformViewController *platform_views_controller)
	~FlutterCompositor ()=default
void	AddView (FlutterViewId view_id)
void	RemoveView (FlutterViewId view_id)
bool	CreateBackingStore (const FlutterBackingStoreConfig *config, FlutterBackingStore *backing_store_out)
bool	Present (FlutterViewIdentifier view_id, const FlutterLayer **layers, size_t layers_count)
size_t	DebugNumViews ()

Detailed Description

Definition at line 36 of file FlutterCompositor.h.

Constructor & Destructor Documentation

FlutterCompositor()

flutter::FlutterCompositor::FlutterCompositor	(	id< FlutterViewProvider >	view_provider,
		FlutterTimeConverter *	time_converter,
		FlutterPlatformViewController *	platform_views_controller
	)

Definition at line 35 of file FlutterCompositor.mm.

    : view_provider_(view_provider),
      time_converter_(time_converter),
      platform_view_controller_(platform_view_controller) {
  FML_CHECK(view_provider != nullptr) << "view_provider cannot be nullptr";
}

~FlutterCompositor()

flutter::FlutterCompositor::~FlutterCompositor ( )

default

Member Function Documentation

AddView()

void flutter::FlutterCompositor::AddView

(

FlutterViewId

view_id

)

Definition at line 44 of file FlutterCompositor.mm.

                                                     {
  dispatch_assert_queue(dispatch_get_main_queue());
  presenters_.try_emplace(view_id);
}

CreateBackingStore()

bool flutter::FlutterCompositor::CreateBackingStore	(	const FlutterBackingStoreConfig *	config,
		FlutterBackingStore *	backing_store_out
	)

Definition at line 54 of file FlutterCompositor.mm.

                                                                                   {
  FlutterView* view = [view_provider_ viewForIdentifier:config->view_id];
  if (!view) {
    return false;
  }
 
  CGSize size = CGSizeMake(config->size.width, config->size.height);
  FlutterSurface* surface = [view.surfaceManager surfaceForSize:size];
  memset(backing_store_out, 0, sizeof(FlutterBackingStore));
  backing_store_out->struct_size = sizeof(FlutterBackingStore);
  backing_store_out->type = kFlutterBackingStoreTypeMetal;
  backing_store_out->metal.struct_size = sizeof(FlutterMetalBackingStore);
  backing_store_out->metal.texture = surface.asFlutterMetalTexture;
  return true;
}

References FlutterSurface::asFlutterMetalTexture, and FlutterView::surfaceManager.

DebugNumViews()

size_t flutter::FlutterCompositor::DebugNumViews

(

)

Definition at line 134 of file FlutterCompositor.mm.

                                        {
  return presenters_.size();
}

Present()

bool flutter::FlutterCompositor::Present	(	FlutterViewIdentifier	view_id,
		const FlutterLayer **	layers,
		size_t	layers_count
	)

Definition at line 71 of file FlutterCompositor.mm.

                                                     {
  FlutterView* view = [view_provider_ viewForIdentifier:view_id];
  if (!view) {
    return false;
  }
 
  NSMutableArray* surfaces = [NSMutableArray array];
  for (size_t i = 0; i < layers_count; i++) {
    const FlutterLayer* layer = layers[i];
    if (layer->type == kFlutterLayerContentTypeBackingStore) {
      FlutterSurface* surface =
          [FlutterSurface fromFlutterMetalTexture:&layer->backing_store->metal.texture];
 
      if (surface) {
        FlutterSurfacePresentInfo* info = [[FlutterSurfacePresentInfo alloc] init];
        info.surface = surface;
        info.offset = CGPointMake(layer->offset.x, layer->offset.y);
        info.zIndex = i;
        FlutterBackingStorePresentInfo* present_info = layer->backing_store_present_info;
        if (present_info != nullptr && present_info->paint_region != nullptr) {
          auto paint_region = present_info->paint_region;
          // Safe because the size of FlutterRect is not expected to change.
          info.paintRegion = std::vector<FlutterRect>(
              paint_region->rects, paint_region->rects + paint_region->rects_count);
        }
        [surfaces addObject:info];
      }
    }
  }
 
  CFTimeInterval presentation_time = 0;
 
  if (layers_count > 0 && layers[0]->presentation_time != 0) {
    presentation_time = [time_converter_ engineTimeToCAMediaTime:layers[0]->presentation_time];
  }
 
  // Notify block below may be called asynchronously, hence the need to copy
  // the layer information instead of passing the original pointers from embedder.
  auto layers_copy = std::make_shared<std::vector<LayerVariant>>(CopyLayers(layers, layers_count));
 
  [view.surfaceManager presentSurfaces:surfaces
                                atTime:presentation_time
                                notify:^{
                                  // Accessing presenters_ here does not need a
                                  // lock to avoid race condition against
                                  // AddView and RemoveView, since all three
                                  // take place on the platform thread. (The
                                  // macOS API requires platform view presenting
                                  // to take place on the platform thread,
                                  // enforced by `FlutterThreadSynchronizer`.)
                                  dispatch_assert_queue(dispatch_get_main_queue());
                                  auto found_presenter = presenters_.find(view_id);
                                  if (found_presenter != presenters_.end()) {
                                    found_presenter->second.PresentPlatformViews(
                                        view, *layers_copy, platform_view_controller_);
                                  }
                                }];
 
  return true;
}

References FlutterSurfacePresentInfo::offset, FlutterSurfacePresentInfo::paintRegion, FlutterSurfacePresentInfo::surface, FlutterView::surfaceManager, and FlutterSurfacePresentInfo::zIndex.

RemoveView()

void flutter::FlutterCompositor::RemoveView

(

FlutterViewId

view_id

)

Definition at line 49 of file FlutterCompositor.mm.

                                                        {
  dispatch_assert_queue(dispatch_get_main_queue());
  presenters_.erase(view_id);
}

---

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

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