flutter::IOSSurfaceMetalSkia Class Reference

#include <ios_surface_metal_skia.h>

Inheritance diagram for flutter::IOSSurfaceMetalSkia:

Public Member Functions
	IOSSurfaceMetalSkia (const fml::scoped_nsobject< CAMetalLayer > &layer, std::shared_ptr< IOSContext > context)
	~IOSSurfaceMetalSkia ()
Public Member Functions inherited from flutter::IOSSurface
std::shared_ptr< IOSContext >	GetContext () const
virtual	~IOSSurface ()
Public Member Functions inherited from flutter::GPUSurfaceMetalDelegate
	GPUSurfaceMetalDelegate (MTLRenderTargetType render_target)
	Construct a new GPUSurfaceMetalDelegate object with the specified render_target type.
virtual	~GPUSurfaceMetalDelegate ()
MTLRenderTargetType	GetRenderTargetType ()

Private Member Functions
bool	IsValid () const override
void	UpdateStorageSizeIfNecessary () override
std::unique_ptr< Surface >	CreateGPUSurface (GrDirectContext *gr_context) override
GPUCAMetalLayerHandle	GetCAMetalLayer (const SkISize &frame_info) const override __attribute__((cf_audited_transfer))
	Returns the handle to the CAMetalLayer to render to. This is only called when the specified render target type is kCAMetalLayer.
bool	PresentDrawable (GrMTLHandle drawable) const override __attribute__((cf_audited_transfer))
	Presents the drawable to the "screen". The drawable is obtained from the CAMetalLayer that given by GetCAMetalLayer call. This is only called when the specified render target type in kCAMetalLayer.
GPUMTLTextureInfo	GetMTLTexture (const SkISize &frame_info) const override __attribute__((cf_audited_transfer))
	Returns the handle to the MTLTexture to render to. This is only called when the specified render target type is kMTLTexture.
bool	PresentTexture (GPUMTLTextureInfo texture) const override __attribute__((cf_audited_transfer))
	Presents the texture with texture_id to the "screen". texture_id corresponds to a texture that has been obtained by an earlier call to GetMTLTexture. This is only called when the specified render target type is kMTLTexture.
bool	AllowsDrawingWhenGpuDisabled () const override
	Whether to allow drawing to the surface when the GPU is disabled.

Additional Inherited Members
Static Public Member Functions inherited from flutter::IOSSurface
static std::unique_ptr< IOSSurface >	Create (std::shared_ptr< IOSContext > context, const fml::scoped_nsobject< CALayer > &layer)
Protected Member Functions inherited from flutter::IOSSurface
	IOSSurface (std::shared_ptr< IOSContext > ios_context)

Detailed Description

Definition at line 17 of file ios_surface_metal_skia.h.

Constructor & Destructor Documentation

IOSSurfaceMetalSkia()

flutter::IOSSurfaceMetalSkia::IOSSurfaceMetalSkia	(	const fml::scoped_nsobject< CAMetalLayer > &	layer,
		std::shared_ptr< IOSContext >	context
	)

Definition at line 24 of file ios_surface_metal_skia.mm.

    : IOSSurface(std::move(context)),
      GPUSurfaceMetalDelegate(MTLRenderTargetType::kCAMetalLayer),
      layer_(layer) {
  is_valid_ = layer_;
  auto metal_context = CastToMetalContext(GetContext());
  auto darwin_context = metal_context->GetDarwinContext().get();
  command_queue_ = darwin_context.commandQueue;
  device_ = darwin_context.device;
}

~IOSSurfaceMetalSkia()

flutter::IOSSurfaceMetalSkia::~IOSSurfaceMetalSkia ( )

default

Member Function Documentation

AllowsDrawingWhenGpuDisabled()

bool flutter::IOSSurfaceMetalSkia::AllowsDrawingWhenGpuDisabled ( ) const

overrideprivatevirtual

Whether to allow drawing to the surface when the GPU is disabled.

Reimplemented from flutter::GPUSurfaceMetalDelegate.

Definition at line 115 of file ios_surface_metal_skia.mm.

                                                             {
  return false;
}

CreateGPUSurface()

std::unique_ptr< Surface > flutter::IOSSurfaceMetalSkia::CreateGPUSurface ( GrDirectContext *  gr_context )

overrideprivatevirtual

Implements flutter::IOSSurface.

Definition at line 50 of file ios_surface_metal_skia.mm.

                                                                                     {
  FML_DCHECK(context);
  return std::make_unique<GPUSurfaceMetalSkia>(this,                               // delegate
                                               sk_ref_sp(context),                 // context
                                               GetContext()->GetMsaaSampleCount()  // sample count
  );
}

GetCAMetalLayer()

GPUCAMetalLayerHandle flutter::IOSSurfaceMetalSkia::GetCAMetalLayer ( const SkISize &  frame_info ) const

overrideprivatevirtual

Returns the handle to the CAMetalLayer to render to. This is only called when the specified render target type is kCAMetalLayer.

Implements flutter::GPUSurfaceMetalDelegate.

Definition at line 59 of file ios_surface_metal_skia.mm.

                                                                                          {
  CAMetalLayer* layer = layer_.get();
  layer.device = device_;
 
  layer.pixelFormat = MTLPixelFormatBGRA8Unorm;
  // Flutter needs to read from the color attachment in cases where there are effects such as
  // backdrop filters. Flutter plugins that create platform views may also read from the layer.
  layer.framebufferOnly = NO;
 
  const auto drawable_size = CGSizeMake(frame_info.width(), frame_info.height());
  if (!CGSizeEqualToSize(drawable_size, layer.drawableSize)) {
    layer.drawableSize = drawable_size;
  }
 
  // When there are platform views in the scene, the drawable needs to be presented in the same
  // transaction as the one created for platform views. When the drawable are being presented from
  // the raster thread, there is no such transaction.
  layer.presentsWithTransaction = [[NSThread currentThread] isMainThread];
 
  return (__bridge GPUCAMetalLayerHandle)layer;
}

GetMTLTexture()

GPUMTLTextureInfo flutter::IOSSurfaceMetalSkia::GetMTLTexture ( const SkISize &  frame_info ) const

overrideprivatevirtual

Returns the handle to the MTLTexture to render to. This is only called when the specified render target type is kMTLTexture.

Implements flutter::GPUSurfaceMetalDelegate.

Definition at line 103 of file ios_surface_metal_skia.mm.

                                                                                    {
  FML_CHECK(false) << "render to texture not supported on ios";
  return {.texture_id = -1, .texture = nullptr};
}

IsValid()

bool flutter::IOSSurfaceMetalSkia::IsValid ( ) const

overrideprivatevirtual

Implements flutter::IOSSurface.

Definition at line 40 of file ios_surface_metal_skia.mm.

                                        {
  return is_valid_;
}

PresentDrawable()

bool flutter::IOSSurfaceMetalSkia::PresentDrawable ( GrMTLHandle  drawable ) const

overrideprivatevirtual

Presents the drawable to the "screen". The drawable is obtained from the CAMetalLayer that given by GetCAMetalLayer call. This is only called when the specified render target type in kCAMetalLayer.

See also

|GPUSurfaceMetalDelegateGetCAMetalLayer|

Implements flutter::GPUSurfaceMetalDelegate.

Definition at line 82 of file ios_surface_metal_skia.mm.

                                                                    {
  if (drawable == nullptr) {
    FML_DLOG(ERROR) << "Could not acquire next Metal drawable from the SkSurface.";
    return false;
  }
 
  id<MTLCommandBuffer> command_buffer = [command_queue_ commandBuffer];
 
  id<CAMetalDrawable> metal_drawable = (__bridge id<CAMetalDrawable>)drawable;
  if ([metal_drawable conformsToProtocol:@protocol(FlutterMetalDrawable)]) {
    [(id<FlutterMetalDrawable>)metal_drawable flutterPrepareForPresent:command_buffer];
  }
 
  [command_buffer commit];
  [command_buffer waitUntilScheduled];
 
  [metal_drawable present];
  return true;
}

PresentTexture()

bool flutter::IOSSurfaceMetalSkia::PresentTexture ( GPUMTLTextureInfo  texture ) const

overrideprivatevirtual

Presents the texture with texture_id to the "screen". texture_id corresponds to a texture that has been obtained by an earlier call to GetMTLTexture. This is only called when the specified render target type is kMTLTexture.

See also

|GPUSurfaceMetalDelegateGetMTLTexture|

Implements flutter::GPUSurfaceMetalDelegate.

Definition at line 109 of file ios_surface_metal_skia.mm.

                                                                        {
  FML_CHECK(false) << "render to texture not supported on ios";
  return false;
}

UpdateStorageSizeIfNecessary()

void flutter::IOSSurfaceMetalSkia::UpdateStorageSizeIfNecessary ( )

overrideprivatevirtual

Implements flutter::IOSSurface.

Definition at line 45 of file ios_surface_metal_skia.mm.

                                                       {
  // Nothing to do.
}

---

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

• shell/platform/darwin/ios/ios_surface_metal_skia.h
• shell/platform/darwin/ios/ios_surface_metal_skia.mm