flutter::EmbedderSurfaceMetal Class Reference

#include <embedder_surface_metal.h>

Inheritance diagram for flutter::EmbedderSurfaceMetal:

Classes
struct	MetalDispatchTable

Public Member Functions
	EmbedderSurfaceMetal (GPUMTLDeviceHandle device, GPUMTLCommandQueueHandle command_queue, MetalDispatchTable dispatch_table, std::shared_ptr< EmbedderExternalViewEmbedder > external_view_embedder)
	~EmbedderSurfaceMetal () override
Public Member Functions inherited from flutter::EmbedderSurface
	EmbedderSurface ()
virtual	~EmbedderSurface ()
virtual std::shared_ptr< impeller::Context >	CreateImpellerContext () const
Public Member Functions inherited from flutter::GPUSurfaceMetalDelegate
	GPUSurfaceMetalDelegate (MTLRenderTargetType render_target)
	Construct a new GPUSurfaceMetalDelegate object with the specified render_target type.
virtual	~GPUSurfaceMetalDelegate ()
virtual bool	AllowsDrawingWhenGpuDisabled () const
	Whether to allow drawing to the surface when the GPU is disabled.
MTLRenderTargetType	GetRenderTargetType ()

Private Member Functions
bool	IsValid () const override
std::unique_ptr< Surface >	CreateGPUSurface () override
sk_sp< GrDirectContext >	CreateResourceContext () const override
GPUCAMetalLayerHandle	GetCAMetalLayer (const SkISize &frame_size) const override
	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
	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_size) const override
	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
	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.

Detailed Description

Definition at line 18 of file embedder_surface_metal.h.

Constructor & Destructor Documentation

EmbedderSurfaceMetal()

flutter::EmbedderSurfaceMetal::EmbedderSurfaceMetal	(	GPUMTLDeviceHandle	device,
		GPUMTLCommandQueueHandle	command_queue,
		MetalDispatchTable	dispatch_table,
		std::shared_ptr< EmbedderExternalViewEmbedder >	external_view_embedder
	)

Definition at line 17 of file embedder_surface_metal.mm.

    : GPUSurfaceMetalDelegate(MTLRenderTargetType::kMTLTexture),
      metal_dispatch_table_(std::move(metal_dispatch_table)),
      external_view_embedder_(std::move(external_view_embedder)) {
  main_context_ =
      [FlutterDarwinContextMetalSkia createGrContext:(id<MTLDevice>)device
                                        commandQueue:(id<MTLCommandQueue>)command_queue];
  resource_context_ =
      [FlutterDarwinContextMetalSkia createGrContext:(id<MTLDevice>)device
                                        commandQueue:(id<MTLCommandQueue>)command_queue];
  valid_ = main_context_ && resource_context_;
}

~EmbedderSurfaceMetal()

flutter::EmbedderSurfaceMetal::~EmbedderSurfaceMetal ( )

overridedefault

Member Function Documentation

CreateGPUSurface()

std::unique_ptr< Surface > flutter::EmbedderSurfaceMetal::CreateGPUSurface ( )

overrideprivatevirtual

Implements flutter::EmbedderSurface.

Definition at line 40 of file embedder_surface_metal.mm.

                                                                                       {
  if (@available(iOS 13.0, *)) {
  } else {
    return nullptr;
  }
  if (!IsValid()) {
    return nullptr;
  }
 
  const bool render_to_surface = !external_view_embedder_;
  auto surface = std::make_unique<GPUSurfaceMetalSkia>(this, main_context_, MsaaSampleCount::kNone,
                                                       render_to_surface);
 
  if (!surface->IsValid()) {
    return nullptr;
  }
 
  return surface;
}

CreateResourceContext()

sk_sp< GrDirectContext > flutter::EmbedderSurfaceMetal::CreateResourceContext ( ) const

overrideprivatevirtual

Reimplemented from flutter::EmbedderSurface.

Definition at line 60 of file embedder_surface_metal.mm.

                                                                         {
  return resource_context_;
}

GetCAMetalLayer()

GPUCAMetalLayerHandle flutter::EmbedderSurfaceMetal::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 64 of file embedder_surface_metal.mm.

                                                                                           {
  FML_CHECK(false) << "Only rendering to MTLTexture is supported.";
  return nullptr;
}

GetMTLTexture()

GPUMTLTextureInfo flutter::EmbedderSurfaceMetal::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 74 of file embedder_surface_metal.mm.

                                                                                     {
  return metal_dispatch_table_.get_texture(frame_info);
}

IsValid()

bool flutter::EmbedderSurfaceMetal::IsValid ( ) const

overrideprivatevirtual

Implements flutter::EmbedderSurface.

Definition at line 36 of file embedder_surface_metal.mm.

                                         {
  return valid_;
}

PresentDrawable()

bool flutter::EmbedderSurfaceMetal::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 69 of file embedder_surface_metal.mm.

                                                                     {
  FML_CHECK(false) << "Only rendering to MTLTexture is supported.";
  return false;
}

PresentTexture()

bool flutter::EmbedderSurfaceMetal::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 78 of file embedder_surface_metal.mm.

                                                                         {
  return metal_dispatch_table_.present(texture);
}

---

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

• shell/platform/embedder/embedder_surface_metal.h
• shell/platform/embedder/embedder_surface_metal.mm