flutter::testing::LayerTestBase< BaseT > Class Template Reference

#include <layer_test.h>

Inheritance diagram for flutter::testing::LayerTestBase< BaseT >:

Public Member Functions
	LayerTestBase ()
void	use_null_raster_cache ()
	Use no raster cache in the preroll_context() and paint_context() structures.
void	use_mock_raster_cache ()
	Use a mock raster cache in the preroll_context() and paint_context() structures.
void	use_skia_raster_cache ()
	Use a normal raster cache in the preroll_context() and paint_context() structures.
std::vector< RasterCacheItem * > &	cacheable_items ()
std::shared_ptr< TextureRegistry >	texture_registry ()
RasterCache *	raster_cache ()
PrerollContext *	preroll_context ()
PaintContext &	paint_context ()
PaintContext &	display_list_paint_context ()
sk_sp< DisplayList >	display_list ()
void	reset_display_list ()
Public Member Functions inherited from flutter::testing::CanvasTestBase< BaseT >
	CanvasTestBase ()=default
sk_sp< SkColorSpace >	mock_color_space ()

Detailed Description

template<typename BaseT>
class flutter::testing::LayerTestBase< BaseT >

Definition at line 37 of file layer_test.h.

Constructor & Destructor Documentation

LayerTestBase()

template<typename BaseT >

flutter::testing::LayerTestBase< BaseT >::LayerTestBase ( )

inline

Definition at line 43 of file layer_test.h.

      : texture_registry_(std::make_shared<TextureRegistry>()),
        preroll_context_{
            // clang-format off
            .raster_cache                  = nullptr,
            .gr_context                    = nullptr,
            .view_embedder                 = nullptr,
            .state_stack                   = preroll_state_stack_,
            .dst_color_space               = TestT::mock_color_space(),
            .surface_needs_readback        = false,
            .raster_time                   = raster_time_,
            .ui_time                       = ui_time_,
            .texture_registry              = texture_registry_,
            .has_platform_view             = false,
            .raster_cached_entries         = &cacheable_items_,
            // clang-format on
        },
        display_list_builder_(k_dl_bounds_),
        display_list_paint_context_{
            // clang-format off
            .state_stack                   = display_list_state_stack_,
            .canvas                        = &display_list_builder_,
            .gr_context                    = nullptr,
            .view_embedder                 = nullptr,
            .raster_time                   = raster_time_,
            .ui_time                       = ui_time_,
            .texture_registry              = texture_registry_,
            .raster_cache                  = nullptr,
            // clang-format on
        } {
    use_null_raster_cache();
    preroll_state_stack_.set_preroll_delegate(kGiantRect, DlMatrix());
    display_list_state_stack_.set_delegate(&display_list_builder_);
  }

References flutter::kGiantRect, flutter::LayerStateStack::set_delegate(), flutter::LayerStateStack::set_preroll_delegate(), and flutter::testing::LayerTestBase< BaseT >::use_null_raster_cache().

Member Function Documentation

cacheable_items()

template<typename BaseT >

std::vector< RasterCacheItem * > & flutter::testing::LayerTestBase< BaseT >::cacheable_items ( )

inline

Definition at line 127 of file layer_test.h.

{ return cacheable_items_; }

display_list()

template<typename BaseT >

sk_sp< DisplayList > flutter::testing::LayerTestBase< BaseT >::display_list ( )

inline

Definition at line 139 of file layer_test.h.

                                    {
    if (display_list_ == nullptr) {
      display_list_ = display_list_builder_.Build();
    }
    return display_list_;
  }

References flutter::DisplayListBuilder::Build().

Referenced by flutter::testing::DiffContextTest::CreateDisplayListLayer().

display_list_paint_context()

template<typename BaseT >

PaintContext & flutter::testing::LayerTestBase< BaseT >::display_list_paint_context ( )

inline

Definition at line 135 of file layer_test.h.

                                             {
    return display_list_paint_context_;
  }

paint_context()

template<typename BaseT >

PaintContext & flutter::testing::LayerTestBase< BaseT >::paint_context ( )

inline

Definition at line 134 of file layer_test.h.

{ return display_list_paint_context_; }

preroll_context()

template<typename BaseT >

PrerollContext * flutter::testing::LayerTestBase< BaseT >::preroll_context ( )

inline

Definition at line 133 of file layer_test.h.

{ return &preroll_context_; }

raster_cache()

template<typename BaseT >

RasterCache * flutter::testing::LayerTestBase< BaseT >::raster_cache ( )

inline

Definition at line 132 of file layer_test.h.

{ return raster_cache_.get(); }

reset_display_list()

template<typename BaseT >

void flutter::testing::LayerTestBase< BaseT >::reset_display_list ( )

inline

Definition at line 146 of file layer_test.h.

                            {
    display_list_ = nullptr;
    // Build() will leave the builder in a state to start recording a new DL
    display_list_builder_.Build();
    // Make sure we are starting from a fresh state stack
    FML_DCHECK(display_list_state_stack_.is_empty());
  }

References flutter::DisplayListBuilder::Build(), FML_DCHECK, and flutter::LayerStateStack::is_empty().

texture_registry()

template<typename BaseT >

std::shared_ptr< TextureRegistry > flutter::testing::LayerTestBase< BaseT >::texture_registry ( )

inline

Definition at line 129 of file layer_test.h.

                                                    {
    return texture_registry_;
  }

use_mock_raster_cache()

template<typename BaseT >

void flutter::testing::LayerTestBase< BaseT >::use_mock_raster_cache ( )

inline

Use a mock raster cache in the preroll_context() and paint_context() structures.

This method must be called before using the preroll_context() and paint_context() structures in calls to the Layer::Preroll() and Layer::Paint() methods. The mock raster cache behaves like a normal raster cache with respect to decisions about when layers and pictures should be cached, but it does not incur the overhead of rendering the layers or caching the resulting pixels.

See also

use_null_raster_cache()

use_skia_raster_cache()

Definition at line 105 of file layer_test.h.

                               {
    set_raster_cache_(std::make_unique<MockRasterCache>());
  }

use_null_raster_cache()

template<typename BaseT >

void flutter::testing::LayerTestBase< BaseT >::use_null_raster_cache ( )

inline

Use no raster cache in the preroll_context() and paint_context() structures.

This method must be called before using the preroll_context() and paint_context() structures in calls to the Layer::Preroll() and Layer::Paint() methods. This is the default mode of operation.

See also

use_mock_raster_cache()

use_skia_raster_cache()

Definition at line 89 of file layer_test.h.

{ set_raster_cache_(nullptr); }

Referenced by flutter::testing::LayerTestBase< BaseT >::LayerTestBase().

use_skia_raster_cache()

template<typename BaseT >

void flutter::testing::LayerTestBase< BaseT >::use_skia_raster_cache ( )

inline

Use a normal raster cache in the preroll_context() and paint_context() structures.

This method must be called before using the preroll_context() and paint_context() structures in calls to the Layer::Preroll() and Layer::Paint() methods. The Skia raster cache will behave identically to the raster cache typically used when handling a frame on a device including rendering the contents of pictures and layers to an SkImage, but using a software rather than a hardware renderer.

See also

use_null_raster_cache()

use_mock_raster_cache()

Definition at line 123 of file layer_test.h.

                               {
    set_raster_cache_(std::make_unique<RasterCache>());
  }

---

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

• flow/testing/layer_test.h