flutter::IOSSurfaceMetalImpeller Class Reference

#include <ios_surface_metal_impeller.h>

Inheritance diagram for flutter::IOSSurfaceMetalImpeller:

Public Member Functions
	IOSSurfaceMetalImpeller (const fml::scoped_nsobject< CAMetalLayer > &layer, const std::shared_ptr< IOSContext > &context)
	~IOSSurfaceMetalImpeller ()
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 20 of file ios_surface_metal_impeller.h.

Constructor & Destructor Documentation

IOSSurfaceMetalImpeller()

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

Definition at line 15 of file ios_surface_metal_impeller.mm.

    : IOSSurface(context),
      GPUSurfaceMetalDelegate(MTLRenderTargetType::kCAMetalLayer),
      layer_(layer),
      impeller_context_(context ? context->GetImpellerContext() : nullptr) {
  if (!impeller_context_) {
    return;
  }
  is_valid_ = true;
}

~IOSSurfaceMetalImpeller()

flutter::IOSSurfaceMetalImpeller::~IOSSurfaceMetalImpeller ( )

default

Member Function Documentation

AllowsDrawingWhenGpuDisabled()

bool flutter::IOSSurfaceMetalImpeller::AllowsDrawingWhenGpuDisabled ( ) const

overrideprivatevirtual

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

Reimplemented from flutter::GPUSurfaceMetalDelegate.

Definition at line 94 of file ios_surface_metal_impeller.mm.

                                                                 {
  return false;
}

CreateGPUSurface()

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

overrideprivatevirtual

Implements flutter::IOSSurface.

Definition at line 41 of file ios_surface_metal_impeller.mm.

                                                                                 {
  impeller_context_->UpdateOffscreenLayerPixelFormat(
      impeller::FromMTLPixelFormat(layer_.get().pixelFormat));
  return std::make_unique<GPUSurfaceMetalImpeller>(this,              //
                                                   impeller_context_  //
  );
}

GetCAMetalLayer()

GPUCAMetalLayerHandle flutter::IOSSurfaceMetalImpeller::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 50 of file ios_surface_metal_impeller.mm.

                                                                                              {
  CAMetalLayer* layer = layer_.get();
  const auto drawable_size = CGSizeMake(frame_info.width(), frame_info.height());
  if (!CGSizeEqualToSize(drawable_size, layer.drawableSize)) {
    layer.drawableSize = drawable_size;
  }
 
  // 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;
 
  // 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, we may not be able to use a transaction as it will dirty the UIViews being
  // presented. If there is a non-Flutter UIView active, such as in add2app or a
  // presentViewController page transition, then this will cause CoreAnimation assertion errors and
  // exit the app.
  layer.presentsWithTransaction = [[NSThread currentThread] isMainThread];
 
  return (__bridge GPUCAMetalLayerHandle)layer;
}

GetMTLTexture()

GPUMTLTextureInfo flutter::IOSSurfaceMetalImpeller::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 79 of file ios_surface_metal_impeller.mm.

                                                                                        {
  FML_CHECK(false);
  return GPUMTLTextureInfo{
      .texture_id = -1,   //
      .texture = nullptr  //
  };
}

IsValid()

bool flutter::IOSSurfaceMetalImpeller::IsValid ( ) const

overrideprivatevirtual

Implements flutter::IOSSurface.

Definition at line 31 of file ios_surface_metal_impeller.mm.

                                            {
  return is_valid_;
}

PresentDrawable()

bool flutter::IOSSurfaceMetalImpeller::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 73 of file ios_surface_metal_impeller.mm.

                                                                        {
  FML_DCHECK(false);
  return false;
}

PresentTexture()

bool flutter::IOSSurfaceMetalImpeller::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 88 of file ios_surface_metal_impeller.mm.

                                                                            {
  FML_CHECK(false);
  return false;
}

UpdateStorageSizeIfNecessary()

void flutter::IOSSurfaceMetalImpeller::UpdateStorageSizeIfNecessary ( )

overrideprivatevirtual

Implements flutter::IOSSurface.

Definition at line 36 of file ios_surface_metal_impeller.mm.

                                                           {
  // Nothing to do.
}

---

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

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