#include <diff_context.h>

Classes
class	AutoSubtreeRestore

class	Statistics

Public Types
using	FilterBoundsAdjustment = std::function< DlRect(DlRect)>

Public Member Functions
	DiffContext (DlISize frame_size, PaintRegionMap &this_frame_paint_region_map, const PaintRegionMap &last_frame_paint_region_map, bool has_raster_cache, bool impeller_enabled)

void	BeginSubtree ()

void	EndSubtree ()

void	PushTransform (const DlMatrix &transform)

bool	PushCullRect (const DlRect &clip)

void	PushFilterBoundsAdjustment (const FilterBoundsAdjustment &filter)

void	WillPaintWithIntegralTransform ()

const DlMatrix &	GetMatrix () const

DlRect	GetCullRect () const

void	MarkSubtreeDirty (const PaintRegion &previous_paint_region=PaintRegion())

void	MarkSubtreeDirty (const DlRect &previous_paint_region)

bool	IsSubtreeDirty () const

void	MarkSubtreeHasTextureLayer ()

void	AddLayerBounds (const DlRect &rect)

void	AddExistingPaintRegion (const PaintRegion &region)

void	AddReadbackRegion (const DlIRect &paint_rect, const DlIRect &readback_rect)

PaintRegion	CurrentSubtreeRegion () const

Damage	ComputeDamage (const DlIRect &additional_damage, int horizontal_clip_alignment=0, int vertical_clip_alignment=0) const

void	AddDamage (const PaintRegion &damage)

void	SetLayerPaintRegion (const Layer *layer, const PaintRegion &region)

PaintRegion	GetOldLayerPaintRegion (const Layer *layer) const

bool	has_raster_cache () const

bool	impeller_enabled () const

Statistics &	statistics ()

DlRect	MapRect (const DlRect &rect)

Detailed Description

Definition at line 41 of file diff_context.h.

Member Typedef Documentation

◆ FilterBoundsAdjustment

using flutter::DiffContext::FilterBoundsAdjustment = std::function<DlRect(DlRect)>

Definition at line 78 of file diff_context.h.

Constructor & Destructor Documentation

◆ DiffContext()

flutter::DiffContext::DiffContext	(	DlISize	frame_size,
		PaintRegionMap &	this_frame_paint_region_map,
		const PaintRegionMap &	last_frame_paint_region_map,
		bool	has_raster_cache,
		bool	impeller_enabled
	)

explicit

Definition at line 12 of file diff_context.cc.

    : rects_(std::make_shared<std::vector<DlRect>>()),
      frame_size_(frame_size),
      this_frame_paint_region_map_(this_frame_paint_region_map),
      last_frame_paint_region_map_(last_frame_paint_region_map),
      has_raster_cache_(has_raster_cache),
      impeller_enabled_(impeller_enabled) {}

Member Function Documentation

◆ AddDamage()

void flutter::DiffContext::AddDamage ( const PaintRegion & damage )

Definition at line 230 of file diff_context.cc.

                                                     {
  FML_DCHECK(damage.is_valid());
  for (const auto& r : damage) {
    damage_ = damage_.Union(r);
  }
}

References FML_DCHECK, flutter::PaintRegion::is_valid(), and impeller::TRect< T >::Union().

Referenced by AddLayerBounds(), flutter::ContainerLayer::DiffChildren(), MarkSubtreeDirty(), and MarkSubtreeDirty().

◆ AddExistingPaintRegion()

void flutter::DiffContext::AddExistingPaintRegion ( const PaintRegion & region )

Definition at line 202 of file diff_context.cc.

                                                                  {
  // Adding paint region for retained layer implies that current subtree is not
  // dirty, so we know, for example, that the inherited transforms must match
  FML_DCHECK(!IsSubtreeDirty());
  if (region.is_valid()) {
    rects_->insert(rects_->end(), region.begin(), region.end());
  }
}

References flutter::PaintRegion::begin(), flutter::PaintRegion::end(), FML_DCHECK, flutter::PaintRegion::is_valid(), and IsSubtreeDirty().

Referenced by flutter::ContainerLayer::DiffChildren().

◆ AddLayerBounds()

void flutter::DiffContext::AddLayerBounds ( const DlRect & rect )

Definition at line 172 of file diff_context.cc.

                                                   {
  // During painting we cull based on non-overriden transform and then
  // override the transform right before paint. Do the same thing here to get
  // identical paint rect.
  auto transformed_rect = ApplyFilterBoundsAdjustment(MapRect(rect));
  if (transformed_rect.IntersectsWithRect(
          state_.matrix_clip.GetDeviceCullCoverage())) {
    if (state_.integral_transform) {
      DisplayListMatrixClipState temp_state = state_.matrix_clip;
      MakeTransformIntegral(temp_state);
      temp_state.mapRect(rect, &transformed_rect);
      transformed_rect = ApplyFilterBoundsAdjustment(transformed_rect);
    }
    rects_->push_back(transformed_rect);
    if (IsSubtreeDirty()) {
      AddDamage(transformed_rect);
    }
  }
}

References AddDamage(), IsSubtreeDirty(), MapRect(), and flutter::DisplayListMatrixClipState::mapRect().

Referenced by flutter::BackdropFilterLayer::Diff(), flutter::DisplayListLayer::Diff(), flutter::PerformanceOverlayLayer::Diff(), flutter::TextureLayer::Diff(), and flutter::testing::MockLayer::Diff().

◆ AddReadbackRegion()

void flutter::DiffContext::AddReadbackRegion	(	const DlIRect &	paint_rect,
		const DlIRect &	readback_rect
	)

Definition at line 211 of file diff_context.cc.

                                                                  {
  Readback readback;
  readback.paint_rect = paint_rect;
  readback.readback_rect = readback_rect;
  readback.position = rects_->size();
  // Push empty rect as a placeholder for position in current subtree
  rects_->push_back(DlRect());
  readbacks_.push_back(readback);
}

Referenced by flutter::BackdropFilterLayer::Diff().

◆ BeginSubtree()

void flutter::DiffContext::BeginSubtree ( )

Definition at line 24 of file diff_context.cc.

                               {
  state_stack_.push_back(state_);
 
  bool had_integral_transform = state_.integral_transform;
  state_.rect_index = rects_->size();
  state_.has_filter_bounds_adjustment = false;
  state_.has_texture = false;
  state_.integral_transform = false;
 
  if (had_integral_transform) {
    MakeTransformIntegral(state_.matrix_clip);
  }
}

Referenced by flutter::DiffContext::AutoSubtreeRestore::AutoSubtreeRestore().

◆ ComputeDamage()

Damage flutter::DiffContext::ComputeDamage	(	const DlIRect &	additional_damage,
		int	horizontal_clip_alignment = `0`,
		int	vertical_clip_alignment = `0`
	)		const

Definition at line 104 of file diff_context.cc.

                                                                     {
  DlRect buffer_damage = DlRect::Make(accumulated_buffer_damage).Union(damage_);
  DlRect frame_damage(damage_);
 
  for (const auto& r : readbacks_) {
    DlRect paint_rect = DlRect::Make(r.paint_rect);
    DlRect readback_rect = DlRect::Make(r.readback_rect);
    // Changes either in readback or paint rect require repainting both readback
    // and paint rect.
    if (paint_rect.IntersectsWithRect(frame_damage) ||
        readback_rect.IntersectsWithRect(frame_damage)) {
      frame_damage = frame_damage.Union(readback_rect).Union(paint_rect);
      buffer_damage = buffer_damage.Union(readback_rect).Union(paint_rect);
    }
  }
 
  DlIRect frame_clip = DlIRect::MakeSize(frame_size_);
 
  Damage res;
  res.buffer_damage =
      DlIRect::RoundOut(buffer_damage).IntersectionOrEmpty(frame_clip);
  res.frame_damage =
      DlIRect::RoundOut(frame_damage).IntersectionOrEmpty(frame_clip);
 
  if (horizontal_clip_alignment > 1 || vertical_clip_alignment > 1) {
    AlignRect(res.buffer_damage, horizontal_clip_alignment,
              vertical_clip_alignment);
    AlignRect(res.frame_damage, horizontal_clip_alignment,
              vertical_clip_alignment);
  }
  return res;
}

References flutter::Damage::buffer_damage, flutter::Damage::frame_damage, impeller::TRect< T >::IntersectionOrEmpty(), impeller::TRect< T >::IntersectsWithRect(), impeller::TRect< Scalar >::Make(), impeller::TRect< T >::MakeSize(), impeller::TRect< T >::RoundOut(), and impeller::TRect< T >::Union().

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

◆ CurrentSubtreeRegion()

PaintRegion flutter::DiffContext::CurrentSubtreeRegion ( ) const

Definition at line 222 of file diff_context.cc.

                                                    {
  bool has_readback = std::any_of(
      readbacks_.begin(), readbacks_.end(),
      [&](const Readback& r) { return r.position >= state_.rect_index; });
  return PaintRegion(rects_, state_.rect_index, rects_->size(), has_readback,
                     state_.has_texture);
}

Referenced by flutter::BackdropFilterLayer::Diff(), flutter::ClipShapeLayer< T >::Diff(), flutter::ColorFilterLayer::Diff(), flutter::ContainerLayer::Diff(), flutter::DisplayListLayer::Diff(), flutter::ImageFilterLayer::Diff(), flutter::OpacityLayer::Diff(), flutter::PerformanceOverlayLayer::Diff(), flutter::ShaderMaskLayer::Diff(), flutter::TextureLayer::Diff(), flutter::TransformLayer::Diff(), and flutter::testing::MockLayer::Diff().

◆ EndSubtree()

void flutter::DiffContext::EndSubtree ( )

Definition at line 38 of file diff_context.cc.

                             {
  FML_DCHECK(!state_stack_.empty());
  if (state_.has_filter_bounds_adjustment) {
    filter_bounds_adjustment_stack_.pop_back();
  }
  state_ = state_stack_.back();
  state_stack_.pop_back();
}

References FML_DCHECK.

Referenced by flutter::DiffContext::AutoSubtreeRestore::~AutoSubtreeRestore().

◆ GetCullRect()

DlRect flutter::DiffContext::GetCullRect ( ) const

Definition at line 154 of file diff_context.cc.

                                      {
  return state_.matrix_clip.GetLocalCullCoverage();
}

Referenced by flutter::BackdropFilterLayer::Diff().

◆ GetMatrix()

const DlMatrix & flutter::DiffContext::GetMatrix ( ) const

Definition at line 150 of file diff_context.cc.

                                             {
  return state_.matrix_clip.matrix();
}

Referenced by flutter::BackdropFilterLayer::Diff(), and flutter::ImageFilterLayer::Diff().

◆ GetOldLayerPaintRegion()

PaintRegion flutter::DiffContext::GetOldLayerPaintRegion ( const Layer * layer ) const

Definition at line 246 of file diff_context.cc.

                                                                        {
  auto i = last_frame_paint_region_map_.find(layer->unique_id());
  if (i != last_frame_paint_region_map_.end()) {
    return i->second;
  } else {
    // This is valid when Layer::PreservePaintRegion is called for retained
    // layer with zero sized parent clip (these layers are not diffed)
    return PaintRegion();
  }
}

References i, and flutter::Layer::unique_id().

Referenced by flutter::BackdropFilterLayer::Diff(), flutter::ClipShapeLayer< T >::Diff(), flutter::ColorFilterLayer::Diff(), flutter::ImageFilterLayer::Diff(), flutter::OpacityLayer::Diff(), flutter::PerformanceOverlayLayer::Diff(), flutter::ShaderMaskLayer::Diff(), flutter::TextureLayer::Diff(), flutter::TransformLayer::Diff(), flutter::ContainerLayer::DiffChildren(), and flutter::Layer::PreservePaintRegion().

◆ has_raster_cache()

bool flutter::DiffContext::has_raster_cache ( ) const

inline

Definition at line 163 of file diff_context.h.

163{ return has_raster_cache_; }

Referenced by flutter::ClipShapeLayer< T >::Diff(), flutter::ColorFilterLayer::Diff(), flutter::DisplayListLayer::Diff(), flutter::ImageFilterLayer::Diff(), flutter::OpacityLayer::Diff(), and flutter::ShaderMaskLayer::Diff().

◆ impeller_enabled()

bool flutter::DiffContext::impeller_enabled ( ) const

inline

Definition at line 165 of file diff_context.h.

165{ return impeller_enabled_; }

◆ IsSubtreeDirty()

bool flutter::DiffContext::IsSubtreeDirty ( ) const

inline

Definition at line 104 of file diff_context.h.

104{ return state_.dirty; }

Referenced by AddExistingPaintRegion(), AddLayerBounds(), flutter::BackdropFilterLayer::Diff(), flutter::ClipShapeLayer< T >::Diff(), flutter::ColorFilterLayer::Diff(), flutter::DisplayListLayer::Diff(), flutter::ImageFilterLayer::Diff(), flutter::OpacityLayer::Diff(), flutter::PerformanceOverlayLayer::Diff(), flutter::ShaderMaskLayer::Diff(), flutter::TextureLayer::Diff(), flutter::TransformLayer::Diff(), flutter::ContainerLayer::DiffChildren(), MarkSubtreeDirty(), and MarkSubtreeDirty().

◆ MapRect()

DlRect flutter::DiffContext::MapRect ( const DlRect & rect )

Definition at line 139 of file diff_context.cc.

                                              {
  DlRect mapped_rect(rect);
  state_.matrix_clip.mapRect(&mapped_rect);
  return mapped_rect;
}

Referenced by AddLayerBounds(), and flutter::BackdropFilterLayer::Diff().

◆ MarkSubtreeDirty() [1/2]

void flutter::DiffContext::MarkSubtreeDirty ( const DlRect & previous_paint_region )

Definition at line 166 of file diff_context.cc.

                                                                      {
  FML_DCHECK(!IsSubtreeDirty());
  AddDamage(previous_paint_region);
  state_.dirty = true;
}

References AddDamage(), FML_DCHECK, and IsSubtreeDirty().

◆ MarkSubtreeDirty() [2/2]

void flutter::DiffContext::MarkSubtreeDirty ( const PaintRegion & previous_paint_region = PaintRegion() )

Definition at line 158 of file diff_context.cc.

                                                                           {
  FML_DCHECK(!IsSubtreeDirty());
  if (previous_paint_region.is_valid()) {
    AddDamage(previous_paint_region);
  }
  state_.dirty = true;
}

References AddDamage(), FML_DCHECK, flutter::PaintRegion::is_valid(), and IsSubtreeDirty().

Referenced by flutter::BackdropFilterLayer::Diff(), flutter::ClipShapeLayer< T >::Diff(), flutter::ColorFilterLayer::Diff(), flutter::ImageFilterLayer::Diff(), flutter::OpacityLayer::Diff(), flutter::PerformanceOverlayLayer::Diff(), flutter::ShaderMaskLayer::Diff(), flutter::TextureLayer::Diff(), flutter::TransformLayer::Diff(), and flutter::ContainerLayer::DiffChildren().

◆ MarkSubtreeHasTextureLayer()

void flutter::DiffContext::MarkSubtreeHasTextureLayer ( )

Definition at line 192 of file diff_context.cc.

                                             {
  // Set the has_texture flag on current state and all parent states. That
  // way we'll know that we can't skip diff for retained layers because
  // they contain a TextureLayer.
  for (auto& state : state_stack_) {
    state.has_texture = true;
  }
  state_.has_texture = true;
}

Referenced by flutter::TextureLayer::Diff().

◆ PushCullRect()

bool flutter::DiffContext::PushCullRect ( const DlRect & clip )

Definition at line 145 of file diff_context.cc.

                                                 {
  state_.matrix_clip.clipRect(clip, DlClipOp::kIntersect, false);
  return !state_.matrix_clip.is_cull_rect_empty();
}

References flutter::kIntersect.

Referenced by flutter::FrameDamage::ComputeClipRect(), flutter::ClipShapeLayer< T >::Diff(), and flutter::testing::DiffContextTest::DiffLayerTree().

◆ PushFilterBoundsAdjustment()

void flutter::DiffContext::PushFilterBoundsAdjustment ( const FilterBoundsAdjustment & filter )

Definition at line 64 of file diff_context.cc.

                                          {
  FML_DCHECK(state_.has_filter_bounds_adjustment == false);
  state_.has_filter_bounds_adjustment = true;
  filter_bounds_adjustment_stack_.push_back(filter);
}

References FML_DCHECK.

Referenced by flutter::ImageFilterLayer::Diff().

◆ PushTransform()

void flutter::DiffContext::PushTransform ( const DlMatrix & transform )

Definition at line 49 of file diff_context.cc.

                                                         {
  state_.matrix_clip.transform(transform);
}

References transform.

Referenced by flutter::DisplayListLayer::Diff(), flutter::ImageFilterLayer::Diff(), flutter::OpacityLayer::Diff(), and flutter::TransformLayer::Diff().

◆ SetLayerPaintRegion()

void flutter::DiffContext::SetLayerPaintRegion	(	const Layer *	layer,
		const PaintRegion &	region
	)

Definition at line 241 of file diff_context.cc.

                                                                 {
  this_frame_paint_region_map_[layer->unique_id()] = region;
}

References flutter::Layer::unique_id().

Referenced by flutter::BackdropFilterLayer::Diff(), flutter::ClipShapeLayer< T >::Diff(), flutter::ColorFilterLayer::Diff(), flutter::ContainerLayer::Diff(), flutter::DisplayListLayer::Diff(), flutter::ImageFilterLayer::Diff(), flutter::OpacityLayer::Diff(), flutter::PerformanceOverlayLayer::Diff(), flutter::ShaderMaskLayer::Diff(), flutter::TextureLayer::Diff(), flutter::TransformLayer::Diff(), flutter::testing::MockLayer::Diff(), and flutter::Layer::PreservePaintRegion().

◆ statistics()

Statistics & flutter::DiffContext::statistics ( )

inline

Definition at line 199 of file diff_context.h.

199{ return statistics_; }

Referenced by flutter::DisplayListLayer::IsReplacing().

◆ WillPaintWithIntegralTransform()

void flutter::DiffContext::WillPaintWithIntegralTransform ( )

inline

Definition at line 85 of file diff_context.h.

85{ state_.integral_transform = true; }

Referenced by flutter::ClipShapeLayer< T >::Diff(), flutter::ColorFilterLayer::Diff(), flutter::DisplayListLayer::Diff(), flutter::ImageFilterLayer::Diff(), flutter::OpacityLayer::Diff(), and flutter::ShaderMaskLayer::Diff().

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

flow/diff_context.h
flow/diff_context.cc

Classes

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ FilterBoundsAdjustment

Constructor & Destructor Documentation

◆ DiffContext()

Member Function Documentation

◆ AddDamage()

◆ AddExistingPaintRegion()

◆ AddLayerBounds()

◆ AddReadbackRegion()

◆ BeginSubtree()

◆ ComputeDamage()

◆ CurrentSubtreeRegion()

◆ EndSubtree()

◆ GetCullRect()

◆ GetMatrix()

◆ GetOldLayerPaintRegion()

◆ has_raster_cache()

◆ impeller_enabled()

◆ IsSubtreeDirty()

◆ MapRect()

◆ MarkSubtreeDirty() [1/2]

◆ MarkSubtreeDirty() [2/2]

◆ MarkSubtreeHasTextureLayer()

◆ PushCullRect()

◆ PushFilterBoundsAdjustment()

◆ PushTransform()

◆ SetLayerPaintRegion()

◆ statistics()

◆ WillPaintWithIntegralTransform()