#include <scene_builder.h>

Inheritance diagram for flutter::SceneBuilder:

Public Member Functions
	~SceneBuilder () override

void	pushTransformHandle (Dart_Handle layer_handle, Dart_Handle matrix4_handle, const fml::RefPtr< EngineLayer > &old_layer)

void	pushTransform (Dart_Handle layer_handle, tonic::Float64List &matrix4, const fml::RefPtr< EngineLayer > &old_layer)

void	pushOffset (Dart_Handle layer_handle, double dx, double dy, const fml::RefPtr< EngineLayer > &old_layer)

void	pushClipRect (Dart_Handle layer_handle, double left, double right, double top, double bottom, int clip_behavior, const fml::RefPtr< EngineLayer > &old_layer)

void	pushClipRRect (Dart_Handle layer_handle, const RRect &rrect, int clip_behavior, const fml::RefPtr< EngineLayer > &old_layer)

void	pushClipRSuperellipse (Dart_Handle layer_handle, const RSuperellipse *rse, int clip_behavior, const fml::RefPtr< EngineLayer > &old_layer)

void	pushClipPath (Dart_Handle layer_handle, const CanvasPath *path, int clip_behavior, const fml::RefPtr< EngineLayer > &old_layer)

void	pushOpacity (Dart_Handle layer_handle, int alpha, double dx, double dy, const fml::RefPtr< EngineLayer > &old_layer)

void	pushColorFilter (Dart_Handle layer_handle, const ColorFilter *color_filter, const fml::RefPtr< EngineLayer > &old_layer)

void	pushImageFilter (Dart_Handle layer_handle, const ImageFilter *image_filter, double dx, double dy, const fml::RefPtr< EngineLayer > &old_layer)

void	pushBackdropFilter (Dart_Handle layer_handle, ImageFilter *filter, int blend_mode, Dart_Handle backdrop_id, const fml::RefPtr< EngineLayer > &old_layer)

void	pushShaderMask (Dart_Handle layer_handle, Shader *shader, double mask_rect_left, double mask_rect_right, double mask_rect_top, double mask_rect_bottom, int blend_mode, int filter_quality_index, const fml::RefPtr< EngineLayer > &old_layer)

void	addRetained (const fml::RefPtr< EngineLayer > &retained_layer)

void	pop ()

void	addPerformanceOverlay (uint64_t enabled_options, double left, double right, double top, double bottom)

void	addPicture (double dx, double dy, Picture *picture, int hints)

void	addTexture (double dx, double dy, double width, double height, int64_t texture_id, bool freeze, int filter_quality)

void	addPlatformView (double dx, double dy, double width, double height, int64_t view_id)

void	build (Dart_Handle scene_handle)

const std::vector< std::shared_ptr< ContainerLayer > > &	layer_stack ()

Public Member Functions inherited from flutter::RefCountedDartWrappable< SceneBuilder >
virtual void	RetainDartWrappableReference () const override

virtual void	ReleaseDartWrappableReference () const override

Public Member Functions inherited from fml::RefCountedThreadSafe< T >
void	Release () const

Public Member Functions inherited from fml::internal::RefCountedThreadSafeBase
void	AddRef () const

bool	HasOneRef () const

void	AssertHasOneRef () const

Public Member Functions inherited from tonic::DartWrappable
	DartWrappable ()

virtual const DartWrapperInfo &	GetDartWrapperInfo () const =0

Dart_Handle	CreateDartWrapper (DartState *dart_state)

void	AssociateWithDartWrapper (Dart_Handle wrappable)

void	ClearDartWrapper ()

Dart_WeakPersistentHandle	dart_wrapper () const

Static Public Member Functions
static void	Create (Dart_Handle wrapper)

Additional Inherited Members
Public Types inherited from tonic::DartWrappable
enum	DartNativeFields { kPeerIndex , kNumberOfNativeFields }

Protected Member Functions inherited from fml::RefCountedThreadSafe< T >
	RefCountedThreadSafe ()

	~RefCountedThreadSafe ()

Protected Member Functions inherited from fml::internal::RefCountedThreadSafeBase
	RefCountedThreadSafeBase ()

	~RefCountedThreadSafeBase ()

bool	Release () const

void	Adopt ()

Protected Member Functions inherited from tonic::DartWrappable
virtual	~DartWrappable ()

Static Protected Member Functions inherited from tonic::DartWrappable
static Dart_PersistentHandle	GetTypeForWrapper (tonic::DartState *dart_state, const tonic::DartWrapperInfo &wrapper_info)

Detailed Description

Definition at line 26 of file scene_builder.h.

Constructor & Destructor Documentation

◆ ~SceneBuilder()

flutter::SceneBuilder::~SceneBuilder ( )

overridedefault

Member Function Documentation

◆ addPerformanceOverlay()

void flutter::SceneBuilder::addPerformanceOverlay	(	uint64_t	enabled_options,
		double	left,
		double	right,
		double	top,
		double	bottom
	)

Definition at line 281 of file scene_builder.cc.

                                                        {
  DlRect rect = DlRect::MakeLTRB(SafeNarrow(left), SafeNarrow(top),
                                 SafeNarrow(right), SafeNarrow(bottom));
  auto layer =
      std::make_unique<flutter::PerformanceOverlayLayer>(enabled_options);
  layer->set_paint_bounds(rect);
  AddLayer(std::move(layer));
}

References impeller::TRect< Scalar >::MakeLTRB(), and flutter::SafeNarrow().

◆ addPicture()

void flutter::SceneBuilder::addPicture	(	double	dx,
		double	dy,
		Picture *	picture,
		int	hints
	)

Definition at line 236 of file scene_builder.cc.

                                         {
  if (!picture) {
    // Picture::dispose was called and it has been collected.
    return;
  }
 
  // Explicitly check for display_list, since the picture object might have
  // been disposed but not collected yet, but the display list is null.
  if (picture->display_list()) {
    auto layer = std::make_unique<flutter::DisplayListLayer>(
        DlPoint(SafeNarrow(dx), SafeNarrow(dy)), picture->display_list(),
        !!(hints & 1), !!(hints & 2));
    AddLayer(std::move(layer));
  }
}

References flutter::Picture::display_list(), and flutter::SafeNarrow().

◆ addPlatformView()

void flutter::SceneBuilder::addPlatformView	(	double	dx,
		double	dy,
		double	width,
		double	height,
		int64_t	view_id
	)

Definition at line 270 of file scene_builder.cc.

                                                    {
  auto layer = std::make_unique<flutter::PlatformViewLayer>(
      DlPoint(SafeNarrow(dx), SafeNarrow(dy)),
      DlSize(SafeNarrow(width), SafeNarrow(height)), view_id);
  AddLayer(std::move(layer));
}

References height, flutter::SafeNarrow(), view_id, and width.

◆ addRetained()

void flutter::SceneBuilder::addRetained ( const fml::RefPtr< EngineLayer > & retained_layer )

Definition at line 228 of file scene_builder.cc.

                                                                           {
  AddLayer(retained_layer->Layer());
}

◆ addTexture()

void flutter::SceneBuilder::addTexture	(	double	dx,
		double	dy,
		double	width,
		double	height,
		int64_t	texture_id,
		bool	freeze,
		int	filter_quality
	)

Definition at line 255 of file scene_builder.cc.

                                                        {
  auto sampling = ImageFilter::SamplingFromIndex(filter_quality_index);
  auto layer = std::make_unique<flutter::TextureLayer>(
      DlPoint(SafeNarrow(dx), SafeNarrow(dy)),
      DlSize(SafeNarrow(width), SafeNarrow(height)), texture_id, freeze,
      sampling);
  AddLayer(std::move(layer));
}

References height, flutter::SafeNarrow(), flutter::ImageFilter::SamplingFromIndex(), texture_id, and width.

◆ build()

void flutter::SceneBuilder::build ( Dart_Handle scene_handle )

Definition at line 294 of file scene_builder.cc.

                                                 {
  FML_DCHECK(layer_stack_.size() >= 1);
 
  Scene::create(scene_handle, std::move(layer_stack_[0]));
  layer_stack_.clear();
  ClearDartWrapper();  // may delete this object.
}

References tonic::DartWrappable::ClearDartWrapper(), flutter::Scene::create(), and FML_DCHECK.

◆ Create()

static void flutter::SceneBuilder::Create ( Dart_Handle wrapper )

inlinestatic

Definition at line 31 of file scene_builder.h.

                                          {
    UIDartState::ThrowIfUIOperationsProhibited();
    auto res = fml::MakeRefCounted<SceneBuilder>();
    res->AssociateWithDartWrapper(wrapper);
  }

References flutter::UIDartState::ThrowIfUIOperationsProhibited().

◆ layer_stack()

const std::vector< std::shared_ptr< ContainerLayer > > & flutter::SceneBuilder::layer_stack ( )

inline

Definition at line 127 of file scene_builder.h.

                                                                {
    return layer_stack_;
  }

Referenced by flutter::TEST_F(), flutter::testing::TEST_F(), and flutter::testing::TEST_F().

◆ pop()

void flutter::SceneBuilder::pop ( )

Definition at line 232 of file scene_builder.cc.

                       {
  PopLayer();
}

◆ pushBackdropFilter()

void flutter::SceneBuilder::pushBackdropFilter	(	Dart_Handle	layer_handle,
		ImageFilter *	filter,
		int	blend_mode,
		Dart_Handle	backdrop_id,
		const fml::RefPtr< EngineLayer > &	old_layer
	)

Definition at line 181 of file scene_builder.cc.

                                             {
  std::optional<int64_t> converted_backdrop_id;
  if (Dart_IsInteger(backdrop_id)) {
    int64_t out;
    Dart_IntegerToInt64(backdrop_id, &out);
    converted_backdrop_id = out;
  }
 
  auto layer = std::make_shared<flutter::BackdropFilterLayer>(
      filter->filter(DlTileMode::kMirror), static_cast<DlBlendMode>(blend_mode),
      converted_backdrop_id);
  PushLayer(layer);
  EngineLayer::MakeRetained(layer_handle, layer);
 
  if (old_layer && old_layer->Layer()) {
    layer->AssignOldLayer(old_layer->Layer().get());
  }
}

References flutter::ImageFilter::filter(), fml::RefPtr< T >::get(), flutter::kMirror, and flutter::EngineLayer::MakeRetained().

◆ pushClipPath()

void flutter::SceneBuilder::pushClipPath	(	Dart_Handle	layer_handle,
		const CanvasPath *	path,
		int	clip_behavior,
		const fml::RefPtr< EngineLayer > &	old_layer
	)

Definition at line 120 of file scene_builder.cc.

                                                                         {
  flutter::Clip flutter_clip_behavior =
      static_cast<flutter::Clip>(clip_behavior);
  FML_DCHECK(flutter_clip_behavior != flutter::Clip::kNone);
  auto layer = std::make_shared<flutter::ClipPathLayer>(
      path->path(), static_cast<flutter::Clip>(flutter_clip_behavior));
  PushLayer(layer);
  EngineLayer::MakeRetained(layer_handle, layer);
 
  if (old_layer && old_layer->Layer()) {
    layer->AssignOldLayer(old_layer->Layer().get());
  }
}

References FML_DCHECK, fml::RefPtr< T >::get(), flutter::kNone, flutter::EngineLayer::MakeRetained(), and flutter::path.

◆ pushClipRect()

void flutter::SceneBuilder::pushClipRect	(	Dart_Handle	layer_handle,
		double	left,
		double	right,
		double	top,
		double	bottom,
		int	clip_behavior,
		const fml::RefPtr< EngineLayer > &	old_layer
	)

Definition at line 72 of file scene_builder.cc.

                                                                         {
  DlRect clip_rect = DlRect::MakeLTRB(SafeNarrow(left), SafeNarrow(top),
                                      SafeNarrow(right), SafeNarrow(bottom));
  auto layer = std::make_shared<flutter::ClipRectLayer>(
      clip_rect, static_cast<flutter::Clip>(clip_behavior));
  PushLayer(layer);
  EngineLayer::MakeRetained(layer_handle, layer);
 
  if (old_layer && old_layer->Layer()) {
    layer->AssignOldLayer(old_layer->Layer().get());
  }
}

References fml::RefPtr< T >::get(), impeller::TRect< Scalar >::MakeLTRB(), flutter::EngineLayer::MakeRetained(), and flutter::SafeNarrow().

◆ pushClipRRect()

void flutter::SceneBuilder::pushClipRRect	(	Dart_Handle	layer_handle,
		const RRect &	rrect,
		int	clip_behavior,
		const fml::RefPtr< EngineLayer > &	old_layer
	)

Definition at line 91 of file scene_builder.cc.

                                                                          {
  auto layer = std::make_shared<flutter::ClipRRectLayer>(
      rrect.rrect, static_cast<flutter::Clip>(clip_behavior));
  PushLayer(layer);
  EngineLayer::MakeRetained(layer_handle, layer);
 
  if (old_layer && old_layer->Layer()) {
    layer->AssignOldLayer(old_layer->Layer().get());
  }
}

References fml::RefPtr< T >::get(), flutter::EngineLayer::MakeRetained(), and flutter::RRect::rrect.

◆ pushClipRSuperellipse()

void flutter::SceneBuilder::pushClipRSuperellipse	(	Dart_Handle	layer_handle,
		const RSuperellipse *	rse,
		int	clip_behavior,
		const fml::RefPtr< EngineLayer > &	old_layer
	)

Definition at line 105 of file scene_builder.cc.

                                             {
  auto layer = std::make_shared<flutter::ClipRSuperellipseLayer>(
      rse->rsuperellipse(), static_cast<flutter::Clip>(clip_behavior));
  PushLayer(layer);
  EngineLayer::MakeRetained(layer_handle, layer);
 
  if (old_layer && old_layer->Layer()) {
    layer->AssignOldLayer(old_layer->Layer().get());
  }
}

References fml::RefPtr< T >::get(), flutter::EngineLayer::MakeRetained(), and flutter::RSuperellipse::rsuperellipse().

◆ pushColorFilter()

void flutter::SceneBuilder::pushColorFilter	(	Dart_Handle	layer_handle,
		const ColorFilter *	color_filter,
		const fml::RefPtr< EngineLayer > &	old_layer
	)

Definition at line 152 of file scene_builder.cc.

                                                                            {
  auto layer =
      std::make_shared<flutter::ColorFilterLayer>(color_filter->filter());
  PushLayer(layer);
  EngineLayer::MakeRetained(layer_handle, layer);
 
  if (old_layer && old_layer->Layer()) {
    layer->AssignOldLayer(old_layer->Layer().get());
  }
}

References flutter::ColorFilter::filter(), fml::RefPtr< T >::get(), and flutter::EngineLayer::MakeRetained().

◆ pushImageFilter()

void flutter::SceneBuilder::pushImageFilter	(	Dart_Handle	layer_handle,
		const ImageFilter *	image_filter,
		double	dx,
		double	dy,
		const fml::RefPtr< EngineLayer > &	old_layer
	)

Definition at line 165 of file scene_builder.cc.

                                                                            {
  auto layer = std::make_shared<flutter::ImageFilterLayer>(
      image_filter->filter(DlTileMode::kDecal),
      DlPoint(SafeNarrow(dx), SafeNarrow(dy)));
  PushLayer(layer);
  EngineLayer::MakeRetained(layer_handle, layer);
 
  if (old_layer && old_layer->Layer()) {
    layer->AssignOldLayer(old_layer->Layer().get());
  }
}

References flutter::ImageFilter::filter(), fml::RefPtr< T >::get(), flutter::kDecal, flutter::EngineLayer::MakeRetained(), and flutter::SafeNarrow().

◆ pushOffset()

void flutter::SceneBuilder::pushOffset	(	Dart_Handle	layer_handle,
		double	dx,
		double	dy,
		const fml::RefPtr< EngineLayer > &	old_layer
	)

Definition at line 58 of file scene_builder.cc.

                                                                       {
  DlMatrix matrix = DlMatrix::MakeTranslation({SafeNarrow(dx), SafeNarrow(dy)});
  auto layer = std::make_shared<flutter::TransformLayer>(matrix);
  PushLayer(layer);
  EngineLayer::MakeRetained(layer_handle, layer);
 
  if (old_layer && old_layer->Layer()) {
    layer->AssignOldLayer(old_layer->Layer().get());
  }
}

References fml::RefPtr< T >::get(), flutter::EngineLayer::MakeRetained(), impeller::Matrix::MakeTranslation(), and flutter::SafeNarrow().

◆ pushOpacity()

void flutter::SceneBuilder::pushOpacity	(	Dart_Handle	layer_handle,
		int	alpha,
		double	dx,
		double	dy,
		const fml::RefPtr< EngineLayer > &	old_layer
	)

Definition at line 137 of file scene_builder.cc.

                                                                        {
  auto layer = std::make_shared<flutter::OpacityLayer>(
      alpha, DlPoint(SafeNarrow(dx), SafeNarrow(dy)));
  PushLayer(layer);
  EngineLayer::MakeRetained(layer_handle, layer);
 
  if (old_layer && old_layer->Layer()) {
    layer->AssignOldLayer(old_layer->Layer().get());
  }
}

References fml::RefPtr< T >::get(), flutter::EngineLayer::MakeRetained(), and flutter::SafeNarrow().

◆ pushShaderMask()

void flutter::SceneBuilder::pushShaderMask	(	Dart_Handle	layer_handle,
		Shader *	shader,
		double	mask_rect_left,
		double	mask_rect_right,
		double	mask_rect_top,
		double	mask_rect_bottom,
		int	blend_mode,
		int	filter_quality_index,
		const fml::RefPtr< EngineLayer > &	old_layer
	)

Definition at line 205 of file scene_builder.cc.

                                                                           {
  DlRect rect = DlRect::MakeLTRB(
      SafeNarrow(mask_rect_left), SafeNarrow(mask_rect_top),
      SafeNarrow(mask_rect_right), SafeNarrow(mask_rect_bottom));
  auto sampling = ImageFilter::SamplingFromIndex(filter_quality_index);
  auto layer = std::make_shared<flutter::ShaderMaskLayer>(
      shader->shader(sampling), rect, static_cast<DlBlendMode>(blend_mode));
  PushLayer(layer);
  EngineLayer::MakeRetained(layer_handle, layer);
 
  if (old_layer && old_layer->Layer()) {
    layer->AssignOldLayer(old_layer->Layer().get());
  }
}

References fml::RefPtr< T >::get(), impeller::TRect< Scalar >::MakeLTRB(), flutter::EngineLayer::MakeRetained(), flutter::SafeNarrow(), flutter::ImageFilter::SamplingFromIndex(), and flutter::Shader::shader().

◆ pushTransform()

void flutter::SceneBuilder::pushTransform	(	Dart_Handle	layer_handle,
		tonic::Float64List &	matrix4,
		const fml::RefPtr< EngineLayer > &	old_layer
	)

Definition at line 43 of file scene_builder.cc.

                                                                          {
  DlMatrix matrix = ToDlMatrix(matrix4);
  auto layer = std::make_shared<flutter::TransformLayer>(matrix);
  PushLayer(layer);
  // matrix4 has to be released before we can return another Dart object
  matrix4.Release();
  EngineLayer::MakeRetained(layer_handle, layer);
 
  if (old_layer && old_layer->Layer()) {
    layer->AssignOldLayer(old_layer->Layer().get());
  }
}

References fml::RefPtr< T >::get(), flutter::EngineLayer::MakeRetained(), and flutter::ToDlMatrix().

Referenced by pushTransformHandle().

◆ pushTransformHandle()

void flutter::SceneBuilder::pushTransformHandle	(	Dart_Handle	layer_handle,
		Dart_Handle	matrix4_handle,
		const fml::RefPtr< EngineLayer > &	old_layer
	)