flutter::testing::DlSurfaceInstanceImpeller Class Reference

#include <dl_test_surface_instance_impeller.h>

Inheritance diagram for flutter::testing::DlSurfaceInstanceImpeller:

Public Member Functions
	DlSurfaceInstanceImpeller (std::shared_ptr< impeller::Context > context, std::shared_ptr< impeller::Surface > surface)
	DlSurfaceInstanceImpeller (std::shared_ptr< impeller::Context > context, std::shared_ptr< impeller::RenderTarget > surface)
virtual	~DlSurfaceInstanceImpeller ()
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.
Public Member Functions inherited from flutter::testing::DlSurfaceInstance
virtual	~DlSurfaceInstance ()=default
DlISize	GetSize () const
	The size of the underlying surface.
virtual sk_sp< SkSurface >	sk_surface ()

Detailed Description

Definition at line 20 of file dl_test_surface_instance_impeller.h.

Constructor & Destructor Documentation

DlSurfaceInstanceImpeller() [1/2]

flutter::testing::DlSurfaceInstanceImpeller::DlSurfaceInstanceImpeller ( std::shared_ptr< impeller::Context >  context, std::shared_ptr< impeller::Surface >  surface  )

explicit

Definition at line 51 of file dl_test_surface_instance_impeller.cc.

    : context_(std::move(context)),
      surface_(std::move(surface)),
      aiks_context_(context_, typographer_context_) {}

References surface.

DlSurfaceInstanceImpeller() [2/2]

flutter::testing::DlSurfaceInstanceImpeller::DlSurfaceInstanceImpeller ( std::shared_ptr< impeller::Context >  context, std::shared_ptr< impeller::RenderTarget >  surface  )

explicit

Definition at line 58 of file dl_test_surface_instance_impeller.cc.

    : context_(std::move(context)),
      target_holder_(std::move(target)),
      aiks_context_(context_, typographer_context_) {}

~DlSurfaceInstanceImpeller()

flutter::testing::DlSurfaceInstanceImpeller::~DlSurfaceInstanceImpeller ( )

virtualdefault

Member Function Documentation

Clear()

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

overridevirtual

Clear the entire surface to the indicated color.

Implements flutter::testing::DlSurfaceInstance.

Definition at line 78 of file dl_test_surface_instance_impeller.cc.

                                                          {
  if (!builder_.IsEmpty()) {
    // Use the Build method to clear whatever is in the builder as it is
    // now irrelevant and ignore the returned DisplayList as it would be
    // useless to try to render it before a surface clear.
    std::ignore = builder_.Build();
  }
  builder_.Clear(color);
  DoRenderDisplayList(builder_.Build());
}

References flutter::DisplayListBuilder::Build(), flutter::DlCanvas::Clear(), and flutter::DisplayListBuilder::IsEmpty().

FlushSubmitCpuSync()

void flutter::testing::DlSurfaceInstanceImpeller::FlushSubmitCpuSync ( )

overridevirtual

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

Implements flutter::testing::DlSurfaceInstance.

Definition at line 99 of file dl_test_surface_instance_impeller.cc.

                                                   {
  Flush();
  if (!context_->FinishQueue()) {
    FML_LOG(ERROR) << "Impeller backend did not implement FinishQueue";
    FML_UNREACHABLE();
  }
}

References FML_LOG, and FML_UNREACHABLE.

GetCanvas()

DlCanvas * flutter::testing::DlSurfaceInstanceImpeller::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 89 of file dl_test_surface_instance_impeller.cc.

                                               {
  return &builder_;
}

height()

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

overridevirtual

The height of the underlying surface.

Implements flutter::testing::DlSurfaceInstance.

Definition at line 164 of file dl_test_surface_instance_impeller.cc.

                                            {
  return GetRenderTarget().GetRenderTargetSize().height;
}

References impeller::RenderTarget::GetRenderTargetSize(), and impeller::TSize< T >::height.

RenderDisplayList()

void flutter::testing::DlSurfaceInstanceImpeller::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 93 of file dl_test_surface_instance_impeller.cc.

                                            {
  Flush();
  DoRenderDisplayList(display_list);
}

SnapshotToFile()

bool flutter::testing::DlSurfaceInstanceImpeller::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 156 of file dl_test_surface_instance_impeller.cc.

                                                                        {
  return false;
}

SnapshotToImage()

sk_sp< DlImage > flutter::testing::DlSurfaceInstanceImpeller::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 133 of file dl_test_surface_instance_impeller.cc.

                                                                {
  auto texture = GetRenderTarget().GetRenderTargetTexture();
  // temp_image will not be a snapshot, so we must make a copy of it to
  // satisfy the demands of the "SnapshotToImage" API.
  auto temp_image = impeller::DlImageImpeller::Make(texture);
 
  // Make a temporary "image surface" into which we can copy our current
  // texture so that we can return a stable snapshot DlImage from the copy.
  auto image_surface = DlSurfaceProviderImpeller::MakeOffscreenSurface(
      context_, temp_image->width(), temp_image->height(),
      DlSurfaceProvider::PixelFormat::kN32Premul);
 
  // Copy the temp_image made from our texture into the image surface.
  image_surface->GetCanvas()->DrawImage(temp_image, DlPoint(0, 0),
                                        DlImageSampling::kNearestNeighbor);
  image_surface->FlushSubmitCpuSync();
 
  // Return an image based on the temporary, but stable, image_surface's
  // texture.
  return impeller::DlImageImpeller::Make(
      image_surface->GetRenderTarget().GetRenderTargetTexture());
}

References impeller::RenderTarget::GetRenderTargetTexture(), flutter::kNearestNeighbor, impeller::DlImageImpeller::Make(), flutter::testing::DlSurfaceProviderImpeller::MakeOffscreenSurface(), and texture.

SnapshotToPixelData()

std::unique_ptr< DlPixelData > flutter::testing::DlSurfaceInstanceImpeller::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 124 of file dl_test_surface_instance_impeller.cc.

          {
  std::unique_ptr<impeller::testing::Screenshot> snapshot =
      snapshotter_.MakeScreenshot(aiks_context_,
                                  GetRenderTarget().GetRenderTargetTexture());
  return snapshot ? std::make_unique<DlImpellerPixelData>(std::move(snapshot))
                  : nullptr;
}

References impeller::testing::MetalScreenshotter::MakeScreenshot().

width()

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

overridevirtual

The width of the underlying surface.

Implements flutter::testing::DlSurfaceInstance.

Definition at line 160 of file dl_test_surface_instance_impeller.cc.

                                           {
  return GetRenderTarget().GetRenderTargetSize().width;
}

References impeller::RenderTarget::GetRenderTargetSize(), and impeller::TSize< T >::width.

---

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

• display_list/testing/impeller/dl_test_surface_instance_impeller.h
• display_list/testing/impeller/dl_test_surface_instance_impeller.cc