flutter::EmbedderExternalView Class Reference

#include <embedder_external_view.h>

Classes
struct	RenderTargetDescriptor
struct	ViewIdentifier

Public Types
using	PlatformViewID = int64_t
using	ViewIdentifierSet = std::unordered_set< ViewIdentifier, ViewIdentifier::Hash, ViewIdentifier::Equal >
using	PendingViews = std::unordered_map< ViewIdentifier, std::unique_ptr< EmbedderExternalView >, ViewIdentifier::Hash, ViewIdentifier::Equal >

Public Member Functions
	EmbedderExternalView (const SkISize &frame_size, const SkMatrix &surface_transformation)
	EmbedderExternalView (const SkISize &frame_size, const SkMatrix &surface_transformation, ViewIdentifier view_identifier, std::unique_ptr< EmbeddedViewParams > params)
	~EmbedderExternalView ()
bool	IsRootView () const
bool	HasPlatformView () const
bool	HasEngineRenderedContents () const
ViewIdentifier	GetViewIdentifier () const
const EmbeddedViewParams *	GetEmbeddedViewParams () const
RenderTargetDescriptor	CreateRenderTargetDescriptor () const
SkCanvas *	GetCanvas () const
SkISize	GetRenderSurfaceSize () const
bool	Render (const EmbedderRenderTarget &render_target)

Detailed Description

Definition at line 21 of file embedder_external_view.h.

Member Typedef Documentation

PendingViews

using flutter::EmbedderExternalView::PendingViews = std::unordered_map<ViewIdentifier, std::unique_ptr<EmbedderExternalView>, ViewIdentifier::Hash, ViewIdentifier::Equal>

Definition at line 84 of file embedder_external_view.h.

PlatformViewID

using flutter::EmbedderExternalView::PlatformViewID = int64_t

Definition at line 23 of file embedder_external_view.h.

ViewIdentifierSet

using flutter::EmbedderExternalView::ViewIdentifierSet = std::unordered_set<ViewIdentifier, ViewIdentifier::Hash, ViewIdentifier::Equal>

Definition at line 79 of file embedder_external_view.h.

Constructor & Destructor Documentation

EmbedderExternalView() [1/2]

flutter::EmbedderExternalView::EmbedderExternalView	(	const SkISize &	frame_size,
		const SkMatrix &	surface_transformation
	)

Definition at line 18 of file embedder_external_view.cc.

    : EmbedderExternalView(frame_size, surface_transformation, {}, nullptr) {}

EmbedderExternalView() [2/2]

flutter::EmbedderExternalView::EmbedderExternalView	(	const SkISize &	frame_size,
		const SkMatrix &	surface_transformation,
		ViewIdentifier	view_identifier,
		std::unique_ptr< EmbeddedViewParams >	params
	)

Definition at line 23 of file embedder_external_view.cc.

References ~EmbedderExternalView().

    : render_surface_size_(
          TransformedSurfaceSize(frame_size, surface_transformation)),
      surface_transformation_(surface_transformation),
      view_identifier_(view_identifier),
      embedded_view_params_(std::move(params)),
      recorder_(std::make_unique<SkPictureRecorder>()),
      canvas_spy_(std::make_unique<CanvasSpy>(
          recorder_->beginRecording(frame_size.width(), frame_size.height()))) {
}

~EmbedderExternalView()

flutter::EmbedderExternalView::~EmbedderExternalView ( )

default

Referenced by EmbedderExternalView().

Member Function Documentation

CreateRenderTargetDescriptor()

EmbedderExternalView::RenderTargetDescriptor flutter::EmbedderExternalView::CreateRenderTargetDescriptor

(

)

const

Definition at line 41 of file embedder_external_view.cc.

                                                         {
  return {view_identifier_, render_surface_size_};
}

GetCanvas()

SkCanvas * flutter::EmbedderExternalView::GetCanvas

(

)

const

Definition at line 45 of file embedder_external_view.cc.

                                                {
  return canvas_spy_->GetSpyingCanvas();
}

GetEmbeddedViewParams()

const EmbeddedViewParams * flutter::EmbedderExternalView::GetEmbeddedViewParams

(

)

const

Definition at line 70 of file embedder_external_view.cc.

                                                                            {
  return embedded_view_params_.get();
}

GetRenderSurfaceSize()

SkISize flutter::EmbedderExternalView::GetRenderSurfaceSize

(

)

const

Definition at line 49 of file embedder_external_view.cc.

                                                         {
  return render_surface_size_;
}

GetViewIdentifier()

EmbedderExternalView::ViewIdentifier flutter::EmbedderExternalView::GetViewIdentifier

(

)

const

Definition at line 65 of file embedder_external_view.cc.

          {
  return view_identifier_;
}

HasEngineRenderedContents()

bool flutter::EmbedderExternalView::HasEngineRenderedContents

(

)

const

Definition at line 61 of file embedder_external_view.cc.

Referenced by Render().

                                                           {
  return canvas_spy_->DidDrawIntoCanvas();
}

HasPlatformView()

bool flutter::EmbedderExternalView::HasPlatformView

(

)

const

Definition at line 57 of file embedder_external_view.cc.

References flutter::EmbedderExternalView::ViewIdentifier::platform_view_id.

Referenced by IsRootView().

                                                 {
  return view_identifier_.platform_view_id.has_value();
}

IsRootView()

bool flutter::EmbedderExternalView::IsRootView

(

)

const

Definition at line 53 of file embedder_external_view.cc.

References HasPlatformView().

                                            {
  return !HasPlatformView();
}

Render()

bool flutter::EmbedderExternalView::Render

(

const EmbedderRenderTarget &

render_target

)

Definition at line 74 of file embedder_external_view.cc.

References FML_DCHECK, flutter::EmbedderRenderTarget::GetRenderSurface(), HasEngineRenderedContents(), surface, and TRACE_EVENT0.

                                                                           {
  TRACE_EVENT0("flutter", "EmbedderExternalView::Render");

  FML_DCHECK(HasEngineRenderedContents())
      << "Unnecessarily asked to render into a render target when there was "
         "nothing to render.";

  auto picture = recorder_->finishRecordingAsPicture();
  if (!picture) {
    return false;
  }

  auto surface = render_target.GetRenderSurface();
  if (!surface) {
    return false;
  }

  FML_DCHECK(SkISize::Make(surface->width(), surface->height()) ==
             render_surface_size_);

  auto canvas = surface->getCanvas();
  if (!canvas) {
    return false;
  }

  canvas->setMatrix(surface_transformation_);
  canvas->clear(SK_ColorTRANSPARENT);
  canvas->drawPicture(picture);
  canvas->flush();

  return true;
}

---

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

• shell/platform/embedder/embedder_external_view.h
• shell/platform/embedder/embedder_external_view.cc