flutter::EmbedderSurfaceMetalImpeller Class Reference

#include <embedder_surface_metal_impeller.h>

Inheritance diagram for flutter::EmbedderSurfaceMetalImpeller:

Classes
struct	MetalDispatchTable

Public Member Functions
	EmbedderSurfaceMetalImpeller (GPUMTLDeviceHandle device, GPUMTLCommandQueueHandle command_queue, MetalDispatchTable dispatch_table, std::shared_ptr< EmbedderExternalViewEmbedder > external_view_embedder)
	~EmbedderSurfaceMetalImpeller () override
Public Member Functions inherited from flutter::EmbedderSurface
	EmbedderSurface ()
virtual	~EmbedderSurface ()
virtual sk_sp< GrDirectContext >	CreateResourceContext () 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
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.
std::shared_ptr< impeller::Context >	CreateImpellerContext () const override

Detailed Description

Definition at line 22 of file embedder_surface_metal_impeller.h.

Constructor & Destructor Documentation

EmbedderSurfaceMetalImpeller()

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

Definition at line 28 of file embedder_surface_metal_impeller.mm.

    : GPUSurfaceMetalDelegate(MTLRenderTargetType::kMTLTexture),
      metal_dispatch_table_(std::move(metal_dispatch_table)),
      external_view_embedder_(std::move(external_view_embedder)) {
  std::vector<std::shared_ptr<fml::Mapping>> shader_mappings = {
      std::make_shared<fml::NonOwnedMapping>(impeller_entity_shaders_data,
                                             impeller_entity_shaders_length),
#if IMPELLER_ENABLE_3D
      std::make_shared<fml::NonOwnedMapping>(impeller_scene_shaders_data,
                                             impeller_scene_shaders_length),
#endif  // IMPELLER_ENABLE_3D
      std::make_shared<fml::NonOwnedMapping>(impeller_modern_shaders_data,
                                             impeller_modern_shaders_length),
      std::make_shared<fml::NonOwnedMapping>(impeller_framebuffer_blend_shaders_data,
                                             impeller_framebuffer_blend_shaders_length),
  };
  context_ = impeller::ContextMTL::Create(
      (id<MTLDevice>)device,                     // device
      (id<MTLCommandQueue>)command_queue,        // command_queue
      shader_mappings,                           // shader_libraries_data
      std::make_shared<fml::SyncSwitch>(false),  // is_gpu_disabled_sync_switch
      "Impeller Library"                         // library_label
  );
  FML_LOG(IMPORTANT) << "Using the Impeller rendering backend (Metal).";
 
  valid_ = !!context_;
}

~EmbedderSurfaceMetalImpeller()

flutter::EmbedderSurfaceMetalImpeller::~EmbedderSurfaceMetalImpeller ( )

overridedefault

Member Function Documentation

CreateGPUSurface()

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

overrideprivatevirtual

Implements flutter::EmbedderSurface.

Definition at line 66 of file embedder_surface_metal_impeller.mm.

                                      {
  if (!IsValid()) {
    return nullptr;
  }
 
  const bool render_to_surface = !external_view_embedder_;
  auto surface = std::make_unique<GPUSurfaceMetalImpeller>(this, context_, render_to_surface);
 
  if (!surface->IsValid()) {
    return nullptr;
  }
 
  return surface;
}

CreateImpellerContext()

std::shared_ptr< impeller::Context > flutter::EmbedderSurfaceMetalImpeller::CreateImpellerContext ( ) const

overrideprivatevirtual

Reimplemented from flutter::EmbedderSurface.

Definition at line 82 of file embedder_surface_metal_impeller.mm.

                                                                                         {
  return context_;
}

GetCAMetalLayer()

GPUCAMetalLayerHandle flutter::EmbedderSurfaceMetalImpeller::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 86 of file embedder_surface_metal_impeller.mm.

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

GetMTLTexture()

GPUMTLTextureInfo flutter::EmbedderSurfaceMetalImpeller::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 97 of file embedder_surface_metal_impeller.mm.

                                                                                             {
  return metal_dispatch_table_.get_texture(frame_info);
}

IsValid()

bool flutter::EmbedderSurfaceMetalImpeller::IsValid ( ) const

overrideprivatevirtual

Implements flutter::EmbedderSurface.

Definition at line 62 of file embedder_surface_metal_impeller.mm.

                                                 {
  return valid_;
}

PresentDrawable()

bool flutter::EmbedderSurfaceMetalImpeller::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 92 of file embedder_surface_metal_impeller.mm.

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

PresentTexture()

bool flutter::EmbedderSurfaceMetalImpeller::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 101 of file embedder_surface_metal_impeller.mm.

                                                                                 {
  return metal_dispatch_table_.present(texture);
}

---

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

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