flutter::Picture Class Reference

#include <picture.h>

Inheritance diagram for flutter::Picture:

Public Member Functions
	~Picture () override
sk_sp< DisplayList >	display_list () const
Dart_Handle	toImage (uint32_t width, uint32_t height, Dart_Handle raw_image_callback)
void	toImageSync (uint32_t width, uint32_t height, int32_t target_format, Dart_Handle raw_image_handle)
void	dispose ()
size_t	GetAllocationSize () const
Public Member Functions inherited from flutter::RefCountedDartWrappable< Picture >
virtual void	RetainDartWrappableReference () const override
virtual void	ReleaseDartWrappableReference () const override
Public Member Functions inherited from fml::RefCountedThreadSafe< T >
void	Release () const
Public Member Functions inherited from fml::internal::RefCountedThreadSafeBase
void	AddRef () const
bool	HasOneRef () const
void	AssertHasOneRef () const
Public Member Functions inherited from tonic::DartWrappable
	DartWrappable ()
virtual const DartWrapperInfo &	GetDartWrapperInfo () const =0
Dart_Handle	CreateDartWrapper (DartState *dart_state)
void	AssociateWithDartWrapper (Dart_Handle wrappable)
void	ClearDartWrapper ()
Dart_WeakPersistentHandle	dart_wrapper () const

Static Public Member Functions
static void	CreateAndAssociateWithDartWrapper (Dart_Handle dart_handle, sk_sp< DisplayList > display_list)
static void	RasterizeToImageSync (sk_sp< DisplayList > display_list, uint32_t width, uint32_t height, SnapshotPixelFormat target_format, Dart_Handle raw_image_handle)
static Dart_Handle	RasterizeToImage (const sk_sp< DisplayList > &display_list, uint32_t width, uint32_t height, Dart_Handle raw_image_callback)
static Dart_Handle	RasterizeLayerTreeToImage (std::unique_ptr< LayerTree > layer_tree, Dart_Handle raw_image_callback)
static Dart_Handle	DoRasterizeToImage (const sk_sp< DisplayList > &display_list, std::unique_ptr< LayerTree > layer_tree, uint32_t width, uint32_t height, Dart_Handle raw_image_callback)

Additional Inherited Members
Public Types inherited from tonic::DartWrappable
enum	DartNativeFields {   kPeerIndex ,   kNumberOfNativeFields }
Protected Member Functions inherited from fml::RefCountedThreadSafe< T >
	RefCountedThreadSafe ()
	~RefCountedThreadSafe ()
Protected Member Functions inherited from fml::internal::RefCountedThreadSafeBase
	RefCountedThreadSafeBase ()
	~RefCountedThreadSafeBase ()
bool	Release () const
void	Adopt ()
Protected Member Functions inherited from tonic::DartWrappable
virtual	~DartWrappable ()
Static Protected Member Functions inherited from tonic::DartWrappable
static Dart_PersistentHandle	GetTypeForWrapper (tonic::DartState *dart_state, const tonic::DartWrapperInfo &wrapper_info)

Detailed Description

Definition at line 18 of file picture.h.

Constructor & Destructor Documentation

~Picture()

flutter::Picture::~Picture ( )

overridedefault

Member Function Documentation

CreateAndAssociateWithDartWrapper()

void flutter::Picture::CreateAndAssociateWithDartWrapper ( Dart_Handle  dart_handle, sk_sp< DisplayList >  display_list  )

static

Definition at line 29 of file picture.cc.

                                     {
  FML_DCHECK(display_list->isUIThreadSafe());
  auto canvas_picture = fml::MakeRefCounted<Picture>(std::move(display_list));
  canvas_picture->AssociateWithDartWrapper(dart_handle);
}

References display_list(), and FML_DCHECK.

Referenced by flutter::PictureRecorder::endRecording().

display_list()

sk_sp< DisplayList > flutter::Picture::display_list ( ) const

inline

Definition at line 28 of file picture.h.

{ return display_list_; }

Referenced by flutter::SceneBuilder::addPicture(), CreateAndAssociateWithDartWrapper(), DoRasterizeToImage(), flutter::Canvas::drawPicture(), RasterizeToImage(), RasterizeToImageSync(), and flutter::testing::TEST_F().

dispose()

void flutter::Picture::dispose

(

)

Definition at line 129 of file picture.cc.

                      {
  display_list_.reset();
  ClearDartWrapper();
}

References tonic::DartWrappable::ClearDartWrapper().

DoRasterizeToImage()

Dart_Handle flutter::Picture::DoRasterizeToImage ( const sk_sp< DisplayList > &  display_list, std::unique_ptr< LayerTree >  layer_tree, uint32_t  width, uint32_t  height, Dart_Handle  raw_image_callback  )

static

Definition at line 159 of file picture.cc.

                                                                        {
  // Either display_list or layer_tree should be provided.
  FML_DCHECK((display_list == nullptr) != (layer_tree == nullptr));
 
  if (Dart_IsNull(raw_image_callback) || !Dart_IsClosure(raw_image_callback)) {
    return tonic::ToDart("Image callback was invalid");
  }
 
  if (width == 0 || height == 0) {
    return tonic::ToDart("Image dimensions for scene were invalid.");
  }
 
  auto* dart_state = UIDartState::Current();
  auto image_callback = std::make_unique<tonic::DartPersistentValue>(
      dart_state, raw_image_callback);
  auto unref_queue = dart_state->GetSkiaUnrefQueue();
  auto ui_task_runner = dart_state->GetTaskRunners().GetUITaskRunner();
  auto raster_task_runner = dart_state->GetTaskRunners().GetRasterTaskRunner();
  auto snapshot_delegate = dart_state->GetSnapshotDelegate();
 
  // We can't create an image on this task runner because we don't have a
  // graphics context. Even if we did, it would be slow anyway. Also, this
  // thread owns the sole reference to the layer tree. So we do it in the
  // raster thread.
 
  auto ui_task =
      // The static leak checker gets confused by the use of fml::MakeCopyable.
      // NOLINTNEXTLINE(clang-analyzer-cplusplus.NewDeleteLeaks)
      fml::MakeCopyable([image_callback = std::move(image_callback),
                         unref_queue](sk_sp<DlImage> image) mutable {
        auto dart_state = image_callback->dart_state().lock();
        if (!dart_state) {
          // The root isolate could have died in the meantime.
          return;
        }
        tonic::DartState::Scope scope(dart_state);
 
        if (!image) {
          tonic::DartInvoke(image_callback->Get(), {Dart_Null()});
          return;
        }
 
        if (!image->isUIThreadSafe()) {
          // All images with impeller textures should already be safe.
          FML_DCHECK(image->impeller_texture() == nullptr);
          image =
              DlImageGPU::Make({image->skia_image(), std::move(unref_queue)});
        }
 
        auto dart_image = CanvasImage::Create();
        dart_image->set_image(image);
        auto* raw_dart_image = tonic::ToDart(dart_image);
 
        // All done!
        tonic::DartInvoke(image_callback->Get(), {raw_dart_image});
 
        // image_callback is associated with the Dart isolate and must be
        // deleted on the UI thread.
        image_callback.reset();
        // NOLINTNEXTLINE(clang-analyzer-cplusplus.NewDeleteLeaks)
      });
 
  // Kick things off on the raster rask runner.
  fml::TaskRunner::RunNowOrPostTask(
      raster_task_runner,
      fml::MakeCopyable([ui_task_runner, snapshot_delegate, display_list, width,
                         height, ui_task,
                         layer_tree = std::move(layer_tree)]() mutable {
        auto picture_bounds = DlISize(width, height);
        sk_sp<DisplayList> snapshot_display_list = display_list;
        if (layer_tree) {
          FML_DCHECK(picture_bounds == layer_tree->frame_size());
          snapshot_display_list =
              layer_tree->Flatten(DlRect::MakeWH(width, height),
                                  snapshot_delegate->GetTextureRegistry(),
                                  snapshot_delegate->GetGrContext());
        }
        snapshot_delegate->MakeRasterSnapshot(
            snapshot_display_list, picture_bounds,
            [ui_task_runner, ui_task](const sk_sp<DlImage>& image) {
              fml::TaskRunner::RunNowOrPostTask(
                  ui_task_runner, [ui_task, image]() { ui_task(image); });
            },
            SnapshotPixelFormat::kDontCare);
      }));
 
  return Dart_Null();
  // NOLINTNEXTLINE(clang-analyzer-cplusplus.NewDeleteLeaks)
}

References flutter::CanvasImage::Create(), flutter::UIDartState::Current(), tonic::DartInvoke(), display_list(), FML_DCHECK, height, image, flutter::kDontCare, flutter::DlImageGPU::Make(), fml::MakeCopyable(), impeller::TRect< Scalar >::MakeWH(), fml::TaskRunner::RunNowOrPostTask(), tonic::ToDart(), and width.

Referenced by RasterizeLayerTreeToImage(), and RasterizeToImage().

GetAllocationSize()

size_t flutter::Picture::GetAllocationSize

(

)

const

Definition at line 134 of file picture.cc.

                                        {
  if (display_list_) {
    return display_list_->bytes() + sizeof(Picture);
  } else {
    return sizeof(Picture);
  }
}

RasterizeLayerTreeToImage()

Dart_Handle flutter::Picture::RasterizeLayerTreeToImage ( std::unique_ptr< LayerTree >  layer_tree, Dart_Handle  raw_image_callback  )

static

Definition at line 150 of file picture.cc.

                                    {
  FML_DCHECK(layer_tree != nullptr);
  auto frame_size = layer_tree->frame_size();
  return DoRasterizeToImage(nullptr, std::move(layer_tree), frame_size.width,
                            frame_size.height, raw_image_callback);
}

References DoRasterizeToImage(), and FML_DCHECK.

Referenced by flutter::Scene::toImage().

RasterizeToImage()

Dart_Handle flutter::Picture::RasterizeToImage ( const sk_sp< DisplayList > &  display_list, uint32_t  width, uint32_t  height, Dart_Handle  raw_image_callback  )

static

Definition at line 142 of file picture.cc.

                                                                      {
  return DoRasterizeToImage(display_list, nullptr, width, height,
                            raw_image_callback);
}

References display_list(), DoRasterizeToImage(), height, and width.

Referenced by toImage().

RasterizeToImageSync()

void flutter::Picture::RasterizeToImageSync ( sk_sp< DisplayList >  display_list, uint32_t  width, uint32_t  height, SnapshotPixelFormat  target_format, Dart_Handle  raw_image_handle  )

static

Definition at line 107 of file picture.cc.

                                                                 {
  auto* dart_state = UIDartState::Current();
  if (!dart_state) {
    return;
  }
  auto unref_queue = dart_state->GetSkiaUnrefQueue();
  auto snapshot_delegate = dart_state->GetSnapshotDelegate();
  auto raster_task_runner = dart_state->GetTaskRunners().GetRasterTaskRunner();
 
  auto image = CanvasImage::Create();
  auto dl_image = CreateDeferredImage(
      dart_state->IsImpellerEnabled(), std::move(display_list), width, height,
      target_format, std::move(snapshot_delegate),
      std::move(raster_task_runner), unref_queue);
  image->set_image(dl_image);
  image->AssociateWithDartWrapper(raw_image_handle);
}

References flutter::CanvasImage::Create(), flutter::CreateDeferredImage(), flutter::UIDartState::Current(), display_list(), height, image, and width.

Referenced by toImageSync().

toImage()

Dart_Handle flutter::Picture::toImage	(	uint32_t	width,
		uint32_t	height,
		Dart_Handle	raw_image_callback
	)

Definition at line 42 of file picture.cc.

                                                             {
  if (!display_list_) {
    return tonic::ToDart("Picture is null");
  }
  return RasterizeToImage(display_list_, width, height, raw_image_callback);
}

References height, RasterizeToImage(), tonic::ToDart(), and width.

toImageSync()

void flutter::Picture::toImageSync	(	uint32_t	width,
		uint32_t	height,
		int32_t	target_format,
		Dart_Handle	raw_image_handle
	)

Definition at line 51 of file picture.cc.

                                                        {
  FML_DCHECK(display_list_);
  SnapshotPixelFormat snapshot_pixel_format;
  // This must be kept in sync with painting.dart.
  switch (target_format) {
    case 0:
      snapshot_pixel_format = SnapshotPixelFormat::kDontCare;
      break;
    case 1:
      snapshot_pixel_format = SnapshotPixelFormat::kRGBA32Float;
      break;
    case 2:
      snapshot_pixel_format = SnapshotPixelFormat::kR32Float;
      break;
    default:
      FML_DCHECK(false) << "unknown target format: " << target_format;
      snapshot_pixel_format = SnapshotPixelFormat::kDontCare;
      break;
  }
  RasterizeToImageSync(display_list_, width, height, snapshot_pixel_format,
                       raw_image_handle);
}

References FML_DCHECK, height, flutter::kDontCare, flutter::kR32Float, flutter::kRGBA32Float, RasterizeToImageSync(), and width.

---

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

• lib/ui/painting/picture.h
• lib/ui/painting/picture.cc