flutter::GPUSurfaceMetalImpeller Class Reference

#include <gpu_surface_metal_impeller.h>

Inheritance diagram for flutter::GPUSurfaceMetalImpeller:

Public Member Functions
	GPUSurfaceMetalImpeller (GPUSurfaceMetalDelegate *delegate, const std::shared_ptr< impeller::Context > &context, bool render_to_surface=true)
	~GPUSurfaceMetalImpeller ()
bool	IsValid () override
virtual Surface::SurfaceData	GetSurfaceData () const override
Public Member Functions inherited from flutter::Surface
	Surface ()
virtual	~Surface ()
virtual bool	ClearRenderContext ()

Private Member Functions
std::unique_ptr< SurfaceFrame >	AcquireFrame (const SkISize &frame_size) override
SkMatrix	GetRootTransformation () const override
GrDirectContext *	GetContext () override
std::unique_ptr< GLContextResult >	MakeRenderContextCurrent () override
bool	AllowsDrawingWhenGpuDisabled () const override
bool	EnableRasterCache () const override
std::shared_ptr< impeller::AiksContext >	GetAiksContext () const override

Detailed Description

Definition at line 21 of file gpu_surface_metal_impeller.h.

Constructor & Destructor Documentation

GPUSurfaceMetalImpeller()

flutter::GPUSurfaceMetalImpeller::GPUSurfaceMetalImpeller	(	GPUSurfaceMetalDelegate *	delegate,
		const std::shared_ptr< impeller::Context > &	context,
		bool	render_to_surface = true
	)

Definition at line 34 of file gpu_surface_metal_impeller.mm.

    : delegate_(delegate),
      render_target_type_(delegate->GetRenderTargetType()),
      impeller_renderer_(CreateImpellerRenderer(context)),
      aiks_context_(
          std::make_shared<impeller::AiksContext>(impeller_renderer_ ? context : nullptr,
                                                  impeller::TypographerContextSkia::Make())),
      render_to_surface_(render_to_surface) {
  // If this preference is explicitly set, we allow for disabling partial repaint.
  NSNumber* disablePartialRepaint =
      [[NSBundle mainBundle] objectForInfoDictionaryKey:@"FLTDisablePartialRepaint"];
  if (disablePartialRepaint != nil) {
    disable_partial_repaint_ = disablePartialRepaint.boolValue;
  }
}

~GPUSurfaceMetalImpeller()

flutter::GPUSurfaceMetalImpeller::~GPUSurfaceMetalImpeller ( )

default

Member Function Documentation

AcquireFrame()

std::unique_ptr< SurfaceFrame > flutter::GPUSurfaceMetalImpeller::AcquireFrame ( const SkISize &  frame_size )

overrideprivatevirtual

Implements flutter::Surface.

Definition at line 60 of file gpu_surface_metal_impeller.mm.

                                                                                           {
  TRACE_EVENT0("impeller", "GPUSurfaceMetalImpeller::AcquireFrame");
 
  if (!IsValid()) {
    FML_LOG(ERROR) << "Metal surface was invalid.";
    return nullptr;
  }
 
  if (frame_size.isEmpty()) {
    FML_LOG(ERROR) << "Metal surface was asked for an empty frame.";
    return nullptr;
  }
 
  if (!render_to_surface_) {
    return std::make_unique<SurfaceFrame>(
        nullptr, SurfaceFrame::FramebufferInfo(),
        [](const SurfaceFrame& surface_frame, DlCanvas* canvas) { return true; }, frame_size);
  }
 
  switch (render_target_type_) {
    case MTLRenderTargetType::kCAMetalLayer:
      return AcquireFrameFromCAMetalLayer(frame_size);
    case MTLRenderTargetType::kMTLTexture:
      return AcquireFrameFromMTLTexture(frame_size);
    default:
      FML_CHECK(false) << "Unknown MTLRenderTargetType type.";
  }
 
  return nullptr;
}

AllowsDrawingWhenGpuDisabled()

bool flutter::GPUSurfaceMetalImpeller::AllowsDrawingWhenGpuDisabled ( ) const

overrideprivatevirtual

Reimplemented from flutter::Surface.

Definition at line 361 of file gpu_surface_metal_impeller.mm.

                                                                 {
  return delegate_->AllowsDrawingWhenGpuDisabled();
}

EnableRasterCache()

bool flutter::GPUSurfaceMetalImpeller::EnableRasterCache ( ) const

overrideprivatevirtual

Reimplemented from flutter::Surface.

Definition at line 366 of file gpu_surface_metal_impeller.mm.

                                                      {
  return false;
}

GetAiksContext()

std::shared_ptr< impeller::AiksContext > flutter::GPUSurfaceMetalImpeller::GetAiksContext ( ) const

overrideprivatevirtual

Reimplemented from flutter::Surface.

Definition at line 371 of file gpu_surface_metal_impeller.mm.

                                                                                 {
  return aiks_context_;
}

GetContext()

GrDirectContext * flutter::GPUSurfaceMetalImpeller::GetContext ( )

overrideprivatevirtual

Implements flutter::Surface.

Definition at line 351 of file gpu_surface_metal_impeller.mm.

                                                     {
  return nullptr;
}

GetRootTransformation()

SkMatrix flutter::GPUSurfaceMetalImpeller::GetRootTransformation ( ) const

overrideprivatevirtual

Implements flutter::Surface.

Definition at line 344 of file gpu_surface_metal_impeller.mm.

                                                              {
  // This backend does not currently support root surface transformations. Just
  // return identity.
  return {};
}

GetSurfaceData()

Surface::SurfaceData flutter::GPUSurfaceMetalImpeller::GetSurfaceData ( ) const

overridevirtual

Capture the SurfaceData currently present in the surface.

Not guaranteed to work on all setups and not intended to be used in production. The data field will be null if it was unable to work.

Reimplemented from flutter::Surface.

Definition at line 375 of file gpu_surface_metal_impeller.mm.

                                                                 {
  if (!(last_texture_ && [last_texture_ conformsToProtocol:@protocol(MTLTexture)])) {
    return {};
  }
  id<MTLTexture> texture = last_texture_.get();
  int bytesPerPixel = 0;
  std::string pixel_format;
  switch (texture.pixelFormat) {
    case MTLPixelFormatBGR10_XR:
      bytesPerPixel = 4;
      pixel_format = "MTLPixelFormatBGR10_XR";
      break;
    case MTLPixelFormatBGRA10_XR:
      bytesPerPixel = 8;
      pixel_format = "MTLPixelFormatBGRA10_XR";
      break;
    case MTLPixelFormatBGRA8Unorm:
      bytesPerPixel = 4;
      pixel_format = "MTLPixelFormatBGRA8Unorm";
      break;
    case MTLPixelFormatRGBA16Float:
      bytesPerPixel = 8;
      pixel_format = "MTLPixelFormatRGBA16Float";
      break;
    default:
      return {};
  }
 
  // Zero initialized so that errors are easier to find at the cost of
  // performance.
  sk_sp<SkData> result =
      SkData::MakeZeroInitialized(texture.width * texture.height * bytesPerPixel);
  [texture getBytes:result->writable_data()
        bytesPerRow:texture.width * bytesPerPixel
         fromRegion:MTLRegionMake2D(0, 0, texture.width, texture.height)
        mipmapLevel:0];
  return {
      .pixel_format = pixel_format,
      .data = result,
  };
}

IsValid()

bool flutter::GPUSurfaceMetalImpeller::IsValid ( )

overridevirtual

Implements flutter::Surface.

Definition at line 55 of file gpu_surface_metal_impeller.mm.

                                      {
  return !!aiks_context_ && aiks_context_->IsValid();
}

MakeRenderContextCurrent()

std::unique_ptr< GLContextResult > flutter::GPUSurfaceMetalImpeller::MakeRenderContextCurrent ( )

overrideprivatevirtual

Reimplemented from flutter::Surface.

Definition at line 356 of file gpu_surface_metal_impeller.mm.

                                                                                 {
  // This backend has no such concept.
  return std::make_unique<GLContextDefaultResult>(true);
}

---

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

• shell/gpu/gpu_surface_metal_impeller.h
• shell/gpu/gpu_surface_metal_impeller.mm