flutter::DiffContext Class Reference

#include <diff_context.h>

Classes
class	AutoSubtreeRestore
class	Statistics

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

Public Member Functions
	DiffContext (SkISize 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 SkMatrix &transform)
void	PushTransform (const SkM44 &transform)
bool	PushCullRect (const SkRect &clip)
void	PushFilterBoundsAdjustment (const FilterBoundsAdjustment &filter)
void	WillPaintWithIntegralTransform ()
SkMatrix	GetTransform3x3 () const
SkRect	GetCullRect () const
void	MarkSubtreeDirty (const PaintRegion &previous_paint_region=PaintRegion())
void	MarkSubtreeDirty (const SkRect &previous_paint_region)
bool	IsSubtreeDirty () const
void	MarkSubtreeHasTextureLayer ()
void	AddLayerBounds (const SkRect &rect)
void	AddExistingPaintRegion (const PaintRegion &region)
void	AddReadbackRegion (const SkIRect &paint_rect, const SkIRect &readback_rect)
PaintRegion	CurrentSubtreeRegion () const
Damage	ComputeDamage (const SkIRect &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 ()
SkRect	MapRect (const SkRect &rect)

Detailed Description

Definition at line 44 of file diff_context.h.

Member Typedef Documentation

FilterBoundsAdjustment

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

Definition at line 82 of file diff_context.h.

Constructor & Destructor Documentation

DiffContext()

flutter::DiffContext::DiffContext ( SkISize  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<SkRect>>()),
      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 244 of file diff_context.cc.

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

AddExistingPaintRegion()

void flutter::DiffContext::AddExistingPaintRegion

(

const PaintRegion &

region

)

Definition at line 216 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());
  }
}

AddLayerBounds()

void flutter::DiffContext::AddLayerBounds

(

const SkRect &

rect

)

Definition at line 187 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.intersects(state_.matrix_clip.device_cull_rect())) {
    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);
    }
  }
}

AddReadbackRegion()

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

Definition at line 225 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(SkRect::MakeEmpty());
  readbacks_.push_back(readback);
}

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);
  }
}

ComputeDamage()

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

Definition at line 116 of file diff_context.cc.

                                                                     {
  SkRect buffer_damage = SkRect::Make(accumulated_buffer_damage);
  buffer_damage.join(damage_);
  SkRect frame_damage(damage_);
 
  for (const auto& r : readbacks_) {
    SkRect paint_rect = SkRect::Make(r.paint_rect);
    SkRect readback_rect = SkRect::Make(r.readback_rect);
    // Changes either in readback or paint rect require repainting both readback
    // and paint rect.
    if (paint_rect.intersects(frame_damage) ||
        readback_rect.intersects(frame_damage)) {
      frame_damage.join(readback_rect);
      frame_damage.join(paint_rect);
      buffer_damage.join(readback_rect);
      buffer_damage.join(paint_rect);
    }
  }
 
  Damage res;
  buffer_damage.roundOut(&res.buffer_damage);
  frame_damage.roundOut(&res.frame_damage);
 
  SkIRect frame_clip = SkIRect::MakeSize(frame_size_);
  res.buffer_damage.intersect(frame_clip);
  res.frame_damage.intersect(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;
}

CurrentSubtreeRegion()

PaintRegion flutter::DiffContext::CurrentSubtreeRegion

(

)

const

Definition at line 236 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);
}

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();
}

GetCullRect()

SkRect flutter::DiffContext::GetCullRect

(

)

const

Definition at line 169 of file diff_context.cc.

                                      {
  return state_.matrix_clip.local_cull_rect();
}

GetOldLayerPaintRegion()

PaintRegion flutter::DiffContext::GetOldLayerPaintRegion

(

const Layer *

layer

)

const

Definition at line 260 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();
  }
}

GetTransform3x3()

SkMatrix flutter::DiffContext::GetTransform3x3

(

)

const

Definition at line 165 of file diff_context.cc.

                                            {
  return state_.matrix_clip.matrix_3x3();
}

has_raster_cache()

bool flutter::DiffContext::has_raster_cache ( ) const

inline

Definition at line 167 of file diff_context.h.

{ return has_raster_cache_; }

impeller_enabled()

bool flutter::DiffContext::impeller_enabled ( ) const

inline

Definition at line 169 of file diff_context.h.

{ return impeller_enabled_; }

IsSubtreeDirty()

bool flutter::DiffContext::IsSubtreeDirty ( ) const

inline

Definition at line 108 of file diff_context.h.

{ return state_.dirty; }

MapRect()

SkRect flutter::DiffContext::MapRect

(

const SkRect &

rect

)

Definition at line 154 of file diff_context.cc.

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

MarkSubtreeDirty() [1/2]

void flutter::DiffContext::MarkSubtreeDirty

(

const PaintRegion &

previous_paint_region = PaintRegion()

)

Definition at line 173 of file diff_context.cc.

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

MarkSubtreeDirty() [2/2]

void flutter::DiffContext::MarkSubtreeDirty

(

const SkRect &

previous_paint_region

)

Definition at line 181 of file diff_context.cc.

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

MarkSubtreeHasTextureLayer()

void flutter::DiffContext::MarkSubtreeHasTextureLayer

(

)

Definition at line 206 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;
}

PushCullRect()

bool flutter::DiffContext::PushCullRect

(

const SkRect &

clip

)

Definition at line 160 of file diff_context.cc.

                                                 {
  state_.matrix_clip.clipRect(clip, DlCanvas::ClipOp::kIntersect, false);
  return !state_.matrix_clip.device_cull_rect().isEmpty();
}

PushFilterBoundsAdjustment()

void flutter::DiffContext::PushFilterBoundsAdjustment

(

const FilterBoundsAdjustment &

filter

)

Definition at line 76 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);
}

PushTransform() [1/2]

void flutter::DiffContext::PushTransform

(

const SkM44 &

transform

)

Definition at line 53 of file diff_context.cc.

                                                      {
  state_.matrix_clip.transform(transform);
}

PushTransform() [2/2]

void flutter::DiffContext::PushTransform

(

const SkMatrix &

transform

)

Definition at line 49 of file diff_context.cc.

                                                         {
  state_.matrix_clip.transform(transform);
}

SetLayerPaintRegion()

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

Definition at line 255 of file diff_context.cc.

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

statistics()

Statistics & flutter::DiffContext::statistics ( )

inline

Definition at line 203 of file diff_context.h.

{ return statistics_; }

WillPaintWithIntegralTransform()

void flutter::DiffContext::WillPaintWithIntegralTransform ( )

inline

Definition at line 89 of file diff_context.h.

{ state_.integral_transform = true; }

---

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

• flow/diff_context.h
• flow/diff_context.cc