#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 DlISize &frame_size, const DlMatrix &surface_transformation)

	EmbedderExternalView (const DlISize &frame_size, const DlMatrix &surface_transformation, ViewIdentifier view_identifier, std::unique_ptr< EmbeddedViewParams > params)

	~EmbedderExternalView ()

bool	IsRootView () const

bool	HasPlatformView () const

bool	HasEngineRenderedContents ()

ViewIdentifier	GetViewIdentifier () const

const EmbeddedViewParams *	GetEmbeddedViewParams () const

RenderTargetDescriptor	CreateRenderTargetDescriptor () const

DlCanvas *	GetCanvas ()

DlISize	GetRenderSurfaceSize () const

bool	Render (const EmbedderRenderTarget &render_target, bool clear_surface=true)

const DlRegion &	GetDlRegion () const

Detailed Description

Definition at line 19 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 74 of file embedder_external_view.h.

◆ PlatformViewID

using flutter::EmbedderExternalView::PlatformViewID = int64_t

Definition at line 21 of file embedder_external_view.h.

◆ ViewIdentifierSet

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

Definition at line 70 of file embedder_external_view.h.

Constructor & Destructor Documentation

◆ EmbedderExternalView() [1/2]

flutter::EmbedderExternalView::EmbedderExternalView	(	const DlISize &	frame_size,
		const DlMatrix &	surface_transformation
	)

Definition at line 27 of file embedder_external_view.cc.

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

flutter::EmbedderExternalView::EmbedderExternalView

EmbedderExternalView(const DlISize &frame_size, const DlMatrix &surface_transformation)

Definition embedder_external_view.cc:27

◆ EmbedderExternalView() [2/2]

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

Definition at line 32 of file embedder_external_view.cc.

    : render_surface_size_(
          TransformedSurfaceSize(frame_size, surface_transformation)),
      surface_transformation_(surface_transformation),
      view_identifier_(view_identifier),
      embedded_view_params_(std::move(params)),
      slice_(std::make_unique<DisplayListEmbedderViewSlice>(
          DlRect::MakeSize(frame_size))) {}

◆ ~EmbedderExternalView()

flutter::EmbedderExternalView::~EmbedderExternalView ( )

default

Member Function Documentation

◆ CreateRenderTargetDescriptor()

EmbedderExternalView::RenderTargetDescriptor flutter::EmbedderExternalView::CreateRenderTargetDescriptor ( ) const

Definition at line 48 of file embedder_external_view.cc.

                                                         {
  return RenderTargetDescriptor(render_surface_size_);
}

◆ GetCanvas()

DlCanvas * flutter::EmbedderExternalView::GetCanvas ( )

Definition at line 52 of file embedder_external_view.cc.

                                          {
  return slice_->canvas();
}

◆ GetDlRegion()

const DlRegion & flutter::EmbedderExternalView::GetDlRegion ( ) const

Definition at line 68 of file embedder_external_view.cc.

                                                        {
  return slice_->getRegion();
}

◆ GetEmbeddedViewParams()

const EmbeddedViewParams * flutter::EmbedderExternalView::GetEmbeddedViewParams ( ) const

Definition at line 89 of file embedder_external_view.cc.

                                                                            {
  return embedded_view_params_.get();
}

◆ GetRenderSurfaceSize()

DlISize flutter::EmbedderExternalView::GetRenderSurfaceSize ( ) const

Definition at line 56 of file embedder_external_view.cc.

                                                         {
  return render_surface_size_;
}

◆ GetViewIdentifier()

EmbedderExternalView::ViewIdentifier flutter::EmbedderExternalView::GetViewIdentifier ( ) const

Definition at line 84 of file embedder_external_view.cc.

          {
  return view_identifier_;
}

◆ HasEngineRenderedContents()

bool flutter::EmbedderExternalView::HasEngineRenderedContents ( )

Definition at line 72 of file embedder_external_view.cc.

                                                     {
  if (has_engine_rendered_contents_.has_value()) {
    return has_engine_rendered_contents_.value();
  }
  TryEndRecording();
  DlOpSpy dl_op_spy;
  slice_->dispatch(dl_op_spy);
  has_engine_rendered_contents_ = dl_op_spy.did_draw() && !slice_->is_empty();
  // NOLINTNEXTLINE(bugprone-unchecked-optional-access)
  return has_engine_rendered_contents_.value();
}

References flutter::DlOpSpy::did_draw().

Referenced by Render().

◆ HasPlatformView()

bool flutter::EmbedderExternalView::HasPlatformView ( ) const

Definition at line 64 of file embedder_external_view.cc.

                                                 {
  return view_identifier_.platform_view_id.has_value();
}

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

Referenced by IsRootView().

◆ IsRootView()

bool flutter::EmbedderExternalView::IsRootView ( ) const

Definition at line 60 of file embedder_external_view.cc.

                                            {
  return !HasPlatformView();
}

References HasPlatformView().

◆ Render()

bool flutter::EmbedderExternalView::Render	(	const EmbedderRenderTarget &	render_target,
		bool	clear_surface = `true`
	)

Definition at line 114 of file embedder_external_view.cc.

                                                      {
  TRACE_EVENT0("flutter", "EmbedderExternalView::Render");
  TryEndRecording();
  FML_DCHECK(HasEngineRenderedContents())
      << "Unnecessarily asked to render into a render target when there was "
         "nothing to render.";
 
#ifdef IMPELLER_SUPPORTS_RENDERING
  auto* impeller_target = render_target.GetImpellerRenderTarget();
  if (impeller_target) {
    auto aiks_context = render_target.GetAiksContext();
 
    auto dl_builder = DisplayListBuilder();
    dl_builder.SetTransform(surface_transformation_);
    slice_->render_into(&dl_builder);
    auto display_list = dl_builder.Build();
 
    auto cull_rect =
        impeller::Rect::MakeSize(impeller_target->GetRenderTargetSize());
 
    return impeller::RenderToTarget(aiks_context->GetContentContext(),  //
                                    *impeller_target,                   //
                                    display_list,                       //
                                    cull_rect,                          //
                                    /*reset_host_buffer=*/true,         //
                                    /*is_onscreen=*/false               //
    );
  }
#endif  // IMPELLER_SUPPORTS_RENDERING
 
#if SLIMPELLER
  FML_LOG(FATAL) << "Impeller opt-out unavailable.";
  return false;
#else   // SLIMPELLER
  auto skia_surface = render_target.GetSkiaSurface();
  if (!skia_surface) {
    return false;
  }
 
  auto [ok, invalidate_api_state] = render_target.MaybeMakeCurrent();
 
  if (invalidate_api_state) {
    InvalidateApiState(*skia_surface);
  }
  if (!ok) {
    FML_LOG(ERROR) << "Could not make the surface current.";
    return false;
  }
 
  // Clear the current render target (most likely EGLSurface) at the
  // end of this scope.
  fml::ScopedCleanupClosure clear_current_surface([&]() {
    auto [ok, invalidate_api_state] = render_target.MaybeClearCurrent();
    if (invalidate_api_state) {
      InvalidateApiState(*skia_surface);
    }
    if (!ok) {
      FML_LOG(ERROR) << "Could not clear the current surface.";
    }
  });
 
  FML_DCHECK(render_target.GetRenderTargetSize() == render_surface_size_);
 
  auto canvas = skia_surface->getCanvas();
  if (!canvas) {
    return false;
  }
  DlSkCanvasAdapter dl_canvas(canvas);
  int restore_count = dl_canvas.GetSaveCount();
  dl_canvas.SetTransform(surface_transformation_);
  if (clear_surface) {
    dl_canvas.Clear(DlColor::kTransparent());
  }
  slice_->render_into(&dl_canvas);
  dl_canvas.RestoreToCount(restore_count);
  dl_canvas.Flush();
#endif  //  !SLIMPELLER
 
  return true;
}

References flutter::DlCanvas::Clear(), flutter::DlSkCanvasAdapter::Flush(), FML_DCHECK, FML_LOG, flutter::EmbedderRenderTarget::GetAiksContext(), flutter::EmbedderRenderTarget::GetImpellerRenderTarget(), flutter::EmbedderRenderTarget::GetRenderTargetSize(), flutter::DlSkCanvasAdapter::GetSaveCount(), flutter::EmbedderRenderTarget::GetSkiaSurface(), HasEngineRenderedContents(), flutter::InvalidateApiState(), flutter::DlColor::kTransparent(), impeller::TRect< Scalar >::MakeSize(), flutter::EmbedderRenderTarget::MaybeClearCurrent(), flutter::EmbedderRenderTarget::MaybeMakeCurrent(), impeller::RenderToTarget(), flutter::DlSkCanvasAdapter::RestoreToCount(), flutter::DlSkCanvasAdapter::SetTransform(), and TRACE_EVENT0.

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

Classes

Public Types

Public Member Functions