flutter::PlatformViewLayer Class Reference

Represents a platform view layer, including all mutations. More...

#include <platform_view_layer.h>

Inheritance diagram for flutter::PlatformViewLayer:

Public Member Functions
	PlatformViewLayer (const DlPoint &offset, const DlSize &size, int64_t view_id)
void	Preroll (PrerollContext *context) override
void	Paint (PaintContext &context) const override
	PlatformViewLayer (const FlutterLayer *_Nonnull layer)
	PlatformViewLayer (FlutterPlatformViewIdentifier identifier, const std::vector< FlutterPlatformViewMutation > &mutations, FlutterPoint offset, FlutterSize size)
FlutterPlatformViewIdentifier	identifier () const
const std::vector< FlutterPlatformViewMutation > &	mutations () const
FlutterPoint	offset () const
FlutterSize	size () const
Public Member Functions inherited from flutter::Layer
	Layer ()
virtual	~Layer ()
void	AssignOldLayer (Layer *old_layer)
virtual bool	IsReplacing (DiffContext *context, const Layer *old_layer) const
virtual void	Diff (DiffContext *context, const Layer *old_layer)
virtual void	PreservePaintRegion (DiffContext *context)
virtual void	PaintChildren (PaintContext &context) const
bool	subtree_has_platform_view () const
void	set_subtree_has_platform_view (bool value)
const DlRect &	paint_bounds () const
void	set_paint_bounds (const DlRect &paint_bounds)
bool	is_empty () const
bool	needs_painting (PaintContext &context) const
uint64_t	original_layer_id () const
uint64_t	unique_id () const
virtual RasterCacheKeyID	caching_key_id () const
virtual const ContainerLayer *	as_container_layer () const
virtual const DisplayListLayer *	as_display_list_layer () const
virtual const TextureLayer *	as_texture_layer () const
virtual const PerformanceOverlayLayer *	as_performance_overlay_layer () const
virtual const testing::MockLayer *	as_mock_layer () const

Additional Inherited Members
Static Public Attributes inherited from flutter::Layer
static constexpr int	kSaveLayerRenderFlags
static constexpr int	kRasterCacheRenderFlags

Detailed Description

Represents a platform view layer, including all mutations.

Definition at line 13 of file platform_view_layer.h.

Constructor & Destructor Documentation

PlatformViewLayer() [1/3]

flutter::PlatformViewLayer::PlatformViewLayer	(	const DlPoint &	offset,
		const DlSize &	size,
		int64_t	view_id
	)

Definition at line 11 of file platform_view_layer.cc.

    : offset_(offset), size_(size), view_id_(view_id) {}

PlatformViewLayer() [2/3]

flutter::PlatformViewLayer::PlatformViewLayer ( const FlutterLayer *_Nonnull  layer )

explicit

Creates platform view from provided FlutterLayer, which must be of type kFlutterLayerContentTypePlatformView.

PlatformViewLayer() [3/3]

flutter::PlatformViewLayer::PlatformViewLayer	(	FlutterPlatformViewIdentifier	identifier,
		const std::vector< FlutterPlatformViewMutation > &	mutations,
		FlutterPoint	offset,
		FlutterSize	size
	)

Definition at line 26 of file FlutterMutatorView.mm.

    : identifier_(identifier), mutations_(mutations), offset_(offset), size_(size) {}

Member Function Documentation

identifier()

FlutterPlatformViewIdentifier flutter::PlatformViewLayer::identifier ( ) const

inline

Definition at line 27 of file FlutterMutatorView.h.

{ return identifier_; }

mutations()

const std::vector< FlutterPlatformViewMutation > & flutter::PlatformViewLayer::mutations ( ) const

inline

Definition at line 28 of file FlutterMutatorView.h.

{ return mutations_; }

offset()

FlutterPoint flutter::PlatformViewLayer::offset ( ) const

inline

Definition at line 29 of file FlutterMutatorView.h.

{ return offset_; }

Paint()

void flutter::PlatformViewLayer::Paint ( PaintContext &  context ) const

overridevirtual

Implements flutter::Layer.

Definition at line 36 of file platform_view_layer.cc.

                                                         {
  if (context.view_embedder == nullptr) {
    FML_DLOG(ERROR) << "Trying to embed a platform view but the PaintContext "
                       "does not support embedding";
    return;
  }
  DlCanvas* canvas = context.view_embedder->CompositeEmbeddedView(view_id_);
  context.canvas = canvas;
  context.state_stack.set_delegate(canvas);
  context.rendering_above_platform_view = true;
}

References flutter::PaintContext::canvas, flutter::ExternalViewEmbedder::CompositeEmbeddedView(), FML_DLOG, flutter::PaintContext::rendering_above_platform_view, flutter::LayerStateStack::set_delegate(), flutter::PaintContext::state_stack, and flutter::PaintContext::view_embedder.

Preroll()

void flutter::PlatformViewLayer::Preroll ( PrerollContext *  context )

overridevirtual

Implements flutter::Layer.

Definition at line 16 of file platform_view_layer.cc.

                                                       {
  set_paint_bounds(DlRect::MakeOriginSize(offset_, size_));
 
  if (context->view_embedder == nullptr) {
    FML_DLOG(ERROR) << "Trying to embed a platform view but the PrerollContext "
                       "does not support embedding";
    return;
  }
  context->has_platform_view = true;
  set_subtree_has_platform_view(true);
  MutatorsStack mutators;
  context->state_stack.fill(&mutators);
  std::unique_ptr<EmbeddedViewParams> params =
      std::make_unique<EmbeddedViewParams>(context->state_stack.matrix(), size_,
                                           mutators);
  context->view_embedder->PrerollCompositeEmbeddedView(view_id_,
                                                       std::move(params));
  context->view_embedder->PushVisitedPlatformView(view_id_);
}

References flutter::LayerStateStack::fill(), FML_DLOG, flutter::PrerollContext::has_platform_view, impeller::TRect< Scalar >::MakeOriginSize(), flutter::LayerStateStack::matrix(), params, flutter::ExternalViewEmbedder::PrerollCompositeEmbeddedView(), flutter::ExternalViewEmbedder::PushVisitedPlatformView(), flutter::Layer::set_paint_bounds(), flutter::Layer::set_subtree_has_platform_view(), flutter::PrerollContext::state_stack, and flutter::PrerollContext::view_embedder.

size()

FlutterSize flutter::PlatformViewLayer::size ( ) const

inline

Definition at line 30 of file FlutterMutatorView.h.

{ return size_; }

---

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

• flow/layers/platform_view_layer.h
• shell/platform/darwin/macos/framework/Source/FlutterMutatorView.h
• flow/layers/platform_view_layer.cc
• shell/platform/darwin/macos/framework/Source/FlutterMutatorView.mm