flutter::testing::DlSurfaceInstanceSkiaBase Class Reference

#include <dl_test_surface_instance_skia.h>

Inheritance diagram for flutter::testing::DlSurfaceInstanceSkiaBase:

Public Member Functions
void	Clear (const DlColor &color) override
	Clear the entire surface to the indicated color.
DlCanvas *	GetCanvas () override
void	RenderDisplayList (const sk_sp< DisplayList > &display_list) override
void	FlushSubmitCpuSync () override
std::unique_ptr< DlPixelData >	SnapshotToPixelData () const override
sk_sp< DlImage >	SnapshotToImage () const override
bool	SnapshotToFile (std::string &filename) const override
	Store a snapshot of this Surface to the file indicated by the filename.
int	width () const override
	The width of the underlying surface.
int	height () const override
	The height of the underlying surface.
sk_sp< SkSurface >	sk_surface () override
Public Member Functions inherited from flutter::testing::DlSurfaceInstance
virtual	~DlSurfaceInstance ()=default
DlISize	GetSize () const
	The size of the underlying surface.

Protected Member Functions
	DlSurfaceInstanceSkiaBase ()
virtual	~DlSurfaceInstanceSkiaBase ()
virtual sk_sp< SkSurface >	GetSurface () const =0

Detailed Description

Definition at line 13 of file dl_test_surface_instance_skia.h.

Constructor & Destructor Documentation

DlSurfaceInstanceSkiaBase()

flutter::testing::DlSurfaceInstanceSkiaBase::DlSurfaceInstanceSkiaBase ( )

explicitprotected

Definition at line 99 of file dl_test_surface_instance_skia.cc.

{}

~DlSurfaceInstanceSkiaBase()

flutter::testing::DlSurfaceInstanceSkiaBase::~DlSurfaceInstanceSkiaBase ( )

protectedvirtualdefault

Member Function Documentation

Clear()

void flutter::testing::DlSurfaceInstanceSkiaBase::Clear ( const DlColor &  color )

overridevirtual

Clear the entire surface to the indicated color.

Implements flutter::testing::DlSurfaceInstance.

Definition at line 108 of file dl_test_surface_instance_skia.cc.

                                                          {
  GetCanvas()->Clear(color);
}

References flutter::DlCanvas::Clear(), and GetCanvas().

FlushSubmitCpuSync()

void flutter::testing::DlSurfaceInstanceSkiaBase::FlushSubmitCpuSync ( )

overridevirtual

Ensure that all outstanding calls executed on the DlCanvas instance are rendered to the surface.

Implements flutter::testing::DlSurfaceInstance.

Definition at line 125 of file dl_test_surface_instance_skia.cc.

                                                   {
  auto surface = GetSurface();
  if (!surface) {
    return;
  }
  if (GrDirectContext* dContext =
          GrAsDirectContext(surface->recordingContext())) {
    dContext->flushAndSubmit(surface.get(), GrSyncCpu::kYes);
  }
  adapter_.canvas()->restoreToCount(0);
  adapter_.canvas()->save();
}

References flutter::DlSkCanvasAdapter::canvas(), GetSurface(), and surface.

GetCanvas()

DlCanvas * flutter::testing::DlSurfaceInstanceSkiaBase::GetCanvas ( )

overridevirtual

Return a DlCanvas instance that renders to this surface. Note that actual execution of the rendering calls are not guaranteed until the FlushSubmitCpuSync method is called. The DlCanvas will also be reset by the operations of the sync method so transform and clip state will not be carried over to subsequent calls.

Rendering to this canvas does not necessarily render the commands immediately in all backends, some backends accumulate the commands into a DisplayList and only flush that DisplayList when the FlushSubmitCpuSync is called. Tests should strongly prefer using RenderDisplayList instead of multiple calls on this canvas object.

Implements flutter::testing::DlSurfaceInstance.

Definition at line 112 of file dl_test_surface_instance_skia.cc.

                                               {
  if (adapter_.canvas() == nullptr) {
    adapter_.set_canvas(GetSurface()->getCanvas());
    adapter_.canvas()->save();
  }
  return &adapter_;
}

References flutter::DlSkCanvasAdapter::canvas(), GetSurface(), and flutter::DlSkCanvasAdapter::set_canvas().

Referenced by Clear(), and RenderDisplayList().

GetSurface()

virtual sk_sp< SkSurface > flutter::testing::DlSurfaceInstanceSkiaBase::GetSurface ( ) const

protectedpure virtual

Implemented in flutter::testing::DlSurfaceInstanceSkia, and flutter::testing::DlMetalSurfaceInstance.

Referenced by FlushSubmitCpuSync(), GetCanvas(), height(), sk_surface(), and width().

height()

int flutter::testing::DlSurfaceInstanceSkiaBase::height ( ) const

overridevirtual

The height of the underlying surface.

Implements flutter::testing::DlSurfaceInstance.

Definition at line 167 of file dl_test_surface_instance_skia.cc.

                                            {
  return GetSurface()->height();
}

References GetSurface().

RenderDisplayList()

void flutter::testing::DlSurfaceInstanceSkiaBase::RenderDisplayList ( const sk_sp< DisplayList > &  display_list )

overridevirtual

Render the indicated DisplayList to the surface. Note that the commands may be enqueued by this call and will be rendered at some time in the future, but the caller must call FlushSubmitCpuSync to be sure they are done being rendered.

In some cases this may be faster than using: GetCanvas().DrawDisplayList(display_list);

Implements flutter::testing::DlSurfaceInstance.

Definition at line 120 of file dl_test_surface_instance_skia.cc.

                                            {
  GetCanvas()->DrawDisplayList(display_list);
}

References flutter::DlCanvas::DrawDisplayList(), and GetCanvas().

sk_surface()

sk_sp< SkSurface > flutter::testing::DlSurfaceInstanceSkiaBase::sk_surface ( )

inlineoverridevirtual

Return a pointer to an underlying SkSurface if the image instance has one. THIS METHOD IS DEPRECATED AND ONLY USED IN DL_RENDERING_UNITTESTS.

Reimplemented from flutter::testing::DlSurfaceInstance.

Definition at line 43 of file dl_test_surface_instance_skia.h.

{ return GetSurface(); }

References GetSurface().

SnapshotToFile()

bool flutter::testing::DlSurfaceInstanceSkiaBase::SnapshotToFile ( std::string &  filename ) const

overridevirtual

Store a snapshot of this Surface to the file indicated by the filename.

Implements flutter::testing::DlSurfaceInstance.

Definition at line 138 of file dl_test_surface_instance_skia.cc.

                                                                        {
  sk_sp<SkImage> raster = GetRasterImage();
  if (!raster) {
    return false;
  }
  sk_sp<SkData> data = SkPngEncoder::Encode(nullptr, raster.get(), {});
  if (!data) {
    return false;
  }
  fml::NonOwnedMapping mapping(static_cast<const uint8_t*>(data->data()),
                               data->size());
  return WriteAtomically(OpenFixturesDirectory(), filename.c_str(), mapping);
}

References flutter::data, and flutter::testing::OpenFixturesDirectory().

SnapshotToImage()

sk_sp< DlImage > flutter::testing::DlSurfaceInstanceSkiaBase::SnapshotToImage ( ) const

overridevirtual

Return the current contents of the surface as a DlImage compatible with the DlCanvas that it provides.

Implements flutter::testing::DlSurfaceInstance.

Definition at line 159 of file dl_test_surface_instance_skia.cc.

                                                                {
  return DlImageSkia::Make(GetRasterImage());
}

References flutter::DlImageSkia::Make().

SnapshotToPixelData()

std::unique_ptr< DlPixelData > flutter::testing::DlSurfaceInstanceSkiaBase::SnapshotToPixelData ( ) const

overridevirtual

Read back the current contents of the surface and return it as a DlPixelData structure.

Implements flutter::testing::DlSurfaceInstance.

Definition at line 152 of file dl_test_surface_instance_skia.cc.

          {
  sk_sp<SkImage> raster = GetRasterImage();
 
  return raster ? DlSkiaPixelData::MakeFromRasterImage(raster) : nullptr;
}

width()

int flutter::testing::DlSurfaceInstanceSkiaBase::width ( ) const

overridevirtual

The width of the underlying surface.

Implements flutter::testing::DlSurfaceInstance.

Definition at line 163 of file dl_test_surface_instance_skia.cc.

                                           {
  return GetSurface()->width();
}

References GetSurface().

---

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

• display_list/testing/skia/dl_test_surface_instance_skia.h
• display_list/testing/skia/dl_test_surface_instance_skia.cc