A RasterCache implementation that simulates the act of rendering a Layer or DisplayList without the overhead of rasterization or pixel storage. This implementation is used only for testing proper usage of the RasterCache in layer unit tests. More...

#include <mock_raster_cache.h>

Inheritance diagram for flutter::testing::MockRasterCache:

Public Member Functions
	MockRasterCache (size_t access_threshold=3, size_t picture_and_display_list_cache_limit_per_frame=RasterCacheUtil::kDefaultPictureAndDisplayListCacheLimitPerFrame)

void	AddMockLayer (int width, int height)

void	AddMockPicture (int width, int height)

Public Member Functions inherited from flutter::RasterCache
std::unique_ptr< RasterCacheResult >	Rasterize (const RasterCache::Context &context, sk_sp< const DlRTree > rtree, const std::function< void(DlCanvas )> &draw_function, const std::function< void(DlCanvas , const DlRect &rect)> &draw_checkerboard) const

	RasterCache (size_t access_threshold=3, size_t picture_and_display_list_cache_limit_per_frame=RasterCacheUtil::kDefaultPictureAndDisplayListCacheLimitPerFrame)

virtual	~RasterCache ()=default

bool	Draw (const RasterCacheKeyID &id, DlCanvas &canvas, const DlPaint *paint, bool preserve_rtree=false) const

bool	HasEntry (const RasterCacheKeyID &id, const SkMatrix &) const

void	BeginFrame ()

void	EvictUnusedCacheEntries ()

void	EndFrame ()

void	Clear ()

const RasterCacheMetrics &	picture_metrics () const

const RasterCacheMetrics &	layer_metrics () const

size_t	GetCachedEntriesCount () const

size_t	GetLayerCachedEntriesCount () const

size_t	GetPictureCachedEntriesCount () const

size_t	EstimatePictureCacheByteSize () const
	Estimate how much memory is used by picture raster cache entries in bytes.

size_t	EstimateLayerCacheByteSize () const
	Estimate how much memory is used by layer raster cache entries in bytes.

size_t	access_threshold () const
	Return the number of frames that a picture must be prepared before it will be cached. If the number is 0, then no picture will ever be cached.

bool	GenerateNewCacheInThisFrame () const

CacheInfo	MarkSeen (const RasterCacheKeyID &id, const SkMatrix &matrix, bool visible) const
	The entry whose RasterCacheKey is generated by RasterCacheKeyID and matrix is marked as encountered by the current frame. The entry will be created if it does not exist. Optionally the entry will be marked as visible in the current frame if the caller determines that it intersects the cull rect. The access_count of the entry will be increased if it is visible, or if it was ever visible.

int	GetAccessCount (const RasterCacheKeyID &id, const SkMatrix &matrix) const

bool	UpdateCacheEntry (const RasterCacheKeyID &id, const Context &raster_cache_context, const std::function< void(DlCanvas *)> &render_function, sk_sp< const DlRTree > rtree=nullptr) const

Detailed Description

A RasterCache implementation that simulates the act of rendering a Layer or DisplayList without the overhead of rasterization or pixel storage. This implementation is used only for testing proper usage of the RasterCache in layer unit tests.

Definition at line 55 of file mock_raster_cache.h.

Constructor & Destructor Documentation

◆ MockRasterCache()

flutter::testing::MockRasterCache::MockRasterCache	(	size_t	access_threshold = `3`,
		size_t	picture_and_display_list_cache_limit_per_frame = `RasterCacheUtil::kDefaultPictureAndDisplayListCacheLimitPerFrame`
	)

inlineexplicit

Definition at line 57 of file mock_raster_cache.h.

      : RasterCache(access_threshold,
                    picture_and_display_list_cache_limit_per_frame) {
    preroll_state_stack_.set_preroll_delegate(DlMatrix());
    paint_state_stack_.set_delegate(&builder_);
  }

References flutter::LayerStateStack::set_delegate(), and flutter::LayerStateStack::set_preroll_delegate().

Member Function Documentation

◆ AddMockLayer()

void flutter::testing::MockRasterCache::AddMockLayer	(	int	width,
		int	height
	)

Definition at line 20 of file mock_raster_cache.cc.

                                                        {
  SkMatrix ctm = SkMatrix::I();
  DlPath path = DlPath::MakeRectLTRB(100, 100, 100 + width, 100 + height);
  int layer_cached_threshold = 1;
  MockCacheableLayer layer =
      MockCacheableLayer(path, DlPaint(), layer_cached_threshold);
  layer.Preroll(&preroll_context_);
  layer.raster_cache_item()->TryToPrepareRasterCache(paint_context_);
  RasterCache::Context r_context = {
      // clang-format off
      .gr_context         = preroll_context_.gr_context,
      .dst_color_space    = preroll_context_.dst_color_space,
      .matrix             = ctm,
      .logical_rect       = ToSkRect(layer.paint_bounds()),
      // clang-format on
  };
  UpdateCacheEntry(
      RasterCacheKeyID(layer.unique_id(), RasterCacheKeyType::kLayer),
      r_context, [&](DlCanvas* canvas) {
        SkRect cache_rect = RasterCacheUtil::GetDeviceBounds(
            r_context.logical_rect, r_context.matrix);
        return std::make_unique<MockRasterCacheResult>(cache_rect);
      });
}

References flutter::PrerollContext::dst_color_space, flutter::PrerollContext::gr_context, flutter::RasterCache::Context::gr_context, height, flutter::kLayer, flutter::DlPath::MakeRectLTRB(), flutter::Layer::paint_bounds(), flutter::path, flutter::testing::MockCacheableLayer::Preroll(), flutter::testing::MockCacheableLayer::raster_cache_item(), flutter::ToSkRect(), flutter::LayerRasterCacheItem::TryToPrepareRasterCache(), flutter::Layer::unique_id(), flutter::RasterCache::UpdateCacheEntry(), and width.

Referenced by flutter::TEST(), and flutter::TEST().

◆ AddMockPicture()

void flutter::testing::MockRasterCache::AddMockPicture	(	int	width,
		int	height
	)

Definition at line 45 of file mock_raster_cache.cc.

                                                          {
  FML_DCHECK(access_threshold() > 0);
  SkMatrix ctm = SkMatrix::I();
  DisplayListBuilder builder(DlRect::MakeLTRB(0, 0, 200 + width, 200 + height));
  builder.DrawPath(DlPath::MakeRectXYWH(100, 100, width, height), DlPaint());
  sk_sp<DisplayList> display_list = builder.Build();
 
  FixedRefreshRateStopwatch raster_time;
  FixedRefreshRateStopwatch ui_time;
  LayerStateStack state_stack;
  PaintContextHolder holder =
      GetSamplePaintContextHolder(state_stack, this, &raster_time, &ui_time);
  holder.paint_context.dst_color_space = color_space_;
 
  DisplayListRasterCacheItem display_list_item(display_list, SkPoint(), true,
                                               false);
  for (size_t i = 0; i < access_threshold(); i++) {
    AutoCache(&display_list_item, &preroll_context_, ToDlMatrix(ctm));
  }
  RasterCache::Context r_context = {
      // clang-format off
      .gr_context         = preroll_context_.gr_context,
      .dst_color_space    = preroll_context_.dst_color_space,
      .matrix             = ctm,
      .logical_rect       = ToSkRect(display_list->GetBounds()),
      // clang-format on
  };
  UpdateCacheEntry(RasterCacheKeyID(display_list->unique_id(),
                                    RasterCacheKeyType::kDisplayList),
                   r_context, [&](DlCanvas* canvas) {
                     SkRect cache_rect = RasterCacheUtil::GetDeviceBounds(
                         r_context.logical_rect, r_context.matrix);
                     return std::make_unique<MockRasterCacheResult>(cache_rect);
                   });
}

References flutter::RasterCache::access_threshold(), flutter::DisplayListBuilder::Build(), flutter::DisplayListBuilder::DrawPath(), flutter::PrerollContext::dst_color_space, flutter::PaintContext::dst_color_space, FML_DCHECK, flutter::testing::GetSamplePaintContextHolder(), flutter::PrerollContext::gr_context, flutter::RasterCache::Context::gr_context, height, i, flutter::kDisplayList, impeller::TRect< Scalar >::MakeLTRB(), flutter::DlPath::MakeRectXYWH(), flutter::testing::PaintContextHolder::paint_context, flutter::ToDlMatrix(), flutter::ToSkRect(), flutter::RasterCache::UpdateCacheEntry(), and width.