flutter::SnapshotController Class Reference

#include <snapshot_controller.h>

Inheritance diagram for flutter::SnapshotController:

Classes
class	Delegate

Public Member Functions
virtual	~SnapshotController ()=default
virtual void	MakeSkiaSnapshot (sk_sp< DisplayList > display_list, DlISize picture_size, std::function< void(const sk_sp< SkImage > &)> callback, SnapshotPixelFormat pixel_format)=0
virtual sk_sp< SkImage >	MakeSkiaSnapshotSync (sk_sp< DisplayList > display_list, DlISize picture_size, SnapshotPixelFormat pixel_format)=0
virtual void	MakeImpellerSnapshot (sk_sp< DisplayList > display_list, DlISize picture_size, std::function< void(const std::shared_ptr< impeller::Texture > &)> callback, SnapshotPixelFormat pixel_format)=0
virtual std::shared_ptr< impeller::Texture >	MakeImpellerSnapshotSync (sk_sp< DisplayList > display_list, DlISize picture_size, SnapshotPixelFormat pixel_format)=0
virtual sk_sp< SkImage >	MakeSkiaTextureImage (sk_sp< SkImage > image, SnapshotPixelFormat pixel_format)=0
virtual std::shared_ptr< impeller::Texture >	MakeImpellerTextureImage (sk_sp< SkImage > image, SnapshotPixelFormat pixel_format)=0
virtual sk_sp< SkImage >	ConvertToRasterImage (sk_sp< SkImage > image)=0
virtual void	CacheRuntimeStage (const std::shared_ptr< impeller::RuntimeStage > &runtime_stage)=0
virtual bool	MakeRenderContextCurrent ()=0

Static Public Member Functions
static std::unique_ptr< SnapshotController >	Make (const Delegate &delegate, const Settings &settings)

Protected Member Functions
	SnapshotController (const Delegate &delegate)
const Delegate &	GetDelegate ()

Detailed Description

Definition at line 24 of file snapshot_controller.h.

Constructor & Destructor Documentation

~SnapshotController()

virtual flutter::SnapshotController::~SnapshotController ( )

virtualdefault

SnapshotController()

flutter::SnapshotController::SnapshotController ( const Delegate &  delegate )

explicitprotected

Definition at line 32 of file snapshot_controller.cc.

    : delegate_(delegate) {}

Member Function Documentation

CacheRuntimeStage()

virtual void flutter::SnapshotController::CacheRuntimeStage ( const std::shared_ptr< impeller::RuntimeStage > &  runtime_stage )

pure virtual

Implemented in flutter::SnapshotControllerImpeller, and flutter::SnapshotControllerSkia.

ConvertToRasterImage()

virtual sk_sp< SkImage > flutter::SnapshotController::ConvertToRasterImage ( sk_sp< SkImage >  image )

pure virtual

Implemented in flutter::SnapshotControllerImpeller, and flutter::SnapshotControllerSkia.

GetDelegate()

const Delegate & flutter::SnapshotController::GetDelegate ( )

inlineprotected

Definition at line 86 of file snapshot_controller.h.

{ return delegate_; }

Referenced by flutter::SnapshotControllerImpeller::CacheRuntimeStage(), flutter::SnapshotControllerSkia::ConvertToRasterImage(), flutter::SnapshotControllerImpeller::MakeImpellerSnapshot(), flutter::SnapshotControllerImpeller::MakeImpellerSnapshotSync(), flutter::SnapshotControllerImpeller::MakeImpellerTextureImage(), and flutter::SnapshotControllerImpeller::MakeRenderContextCurrent().

Make()

std::unique_ptr< SnapshotController > flutter::SnapshotController::Make ( const Delegate &  delegate, const Settings &  settings  )

static

Definition at line 15 of file snapshot_controller.cc.

                              {
#if IMPELLER_SUPPORTS_RENDERING
  if (settings.enable_impeller) {
    return std::make_unique<SnapshotControllerImpeller>(delegate);
  }
#endif  // IMPELLER_SUPPORTS_RENDERING
#if !SLIMPELLER
  return std::make_unique<SnapshotControllerSkia>(delegate);
#else   //  !SLIMPELLER
  FML_LOG(FATAL)
      << "Cannot create a Skia snapshot controller in an Impeller build.";
  return nullptr;
#endif  //  !SLIMPELLER
}

References flutter::Settings::enable_impeller, and FML_LOG.

MakeImpellerSnapshot()

virtual void flutter::SnapshotController::MakeImpellerSnapshot ( sk_sp< DisplayList >  display_list, DlISize  picture_size, std::function< void(const std::shared_ptr< impeller::Texture > &)>  callback, SnapshotPixelFormat  pixel_format  )

pure virtual

Implemented in flutter::SnapshotControllerImpeller, and flutter::SnapshotControllerSkia.

MakeImpellerSnapshotSync()

virtual std::shared_ptr< impeller::Texture > flutter::SnapshotController::MakeImpellerSnapshotSync ( sk_sp< DisplayList >  display_list, DlISize  picture_size, SnapshotPixelFormat  pixel_format  )

pure virtual

Implemented in flutter::SnapshotControllerImpeller, and flutter::SnapshotControllerSkia.

MakeImpellerTextureImage()

virtual std::shared_ptr< impeller::Texture > flutter::SnapshotController::MakeImpellerTextureImage ( sk_sp< SkImage >  image, SnapshotPixelFormat  pixel_format  )

pure virtual

Implemented in flutter::SnapshotControllerImpeller, and flutter::SnapshotControllerSkia.

MakeRenderContextCurrent()

virtual bool flutter::SnapshotController::MakeRenderContextCurrent ( )

pure virtual

Implemented in flutter::SnapshotControllerImpeller, and flutter::SnapshotControllerSkia.

MakeSkiaSnapshot()

virtual void flutter::SnapshotController::MakeSkiaSnapshot ( sk_sp< DisplayList >  display_list, DlISize  picture_size, std::function< void(const sk_sp< SkImage > &)>  callback, SnapshotPixelFormat  pixel_format  )

pure virtual

Implemented in flutter::SnapshotControllerImpeller, and flutter::SnapshotControllerSkia.

MakeSkiaSnapshotSync()

virtual sk_sp< SkImage > flutter::SnapshotController::MakeSkiaSnapshotSync ( sk_sp< DisplayList >  display_list, DlISize  picture_size, SnapshotPixelFormat  pixel_format  )

pure virtual

Implemented in flutter::SnapshotControllerImpeller, and flutter::SnapshotControllerSkia.

MakeSkiaTextureImage()

virtual sk_sp< SkImage > flutter::SnapshotController::MakeSkiaTextureImage ( sk_sp< SkImage >  image, SnapshotPixelFormat  pixel_format  )

pure virtual

Creates a texture-backed DlImage from the provided SkImage.

This is primarily used by decodeImageFromPixelsSync to upload pixels to the GPU synchronously.

Implemented in flutter::SnapshotControllerImpeller, and flutter::SnapshotControllerSkia.

---

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

• shell/common/snapshot_controller.h
• shell/common/snapshot_controller.cc