#include <dl_playground.h>

Inheritance diagram for impeller::DlPlayground:

Public Types
using	DisplayListPlaygroundCallback = std::function< sk_sp< flutter::DisplayList >()>

Public Types inherited from impeller::Playground
using	SinglePassCallback = std::function< bool(RenderPass &pass)>

using	RenderCallback = std::function< bool(RenderTarget &render_target)>

using	GLProcAddressResolver = std::function< void (const char proc_name)>

using	VKProcAddressResolver = std::function< void (void instance, const char *proc_name)>

Public Member Functions
	DlPlayground ()

	~DlPlayground ()

bool	OpenPlaygroundHere (flutter::DisplayListBuilder &builder)

bool	OpenPlaygroundHere (sk_sp< flutter::DisplayList > list)

bool	OpenPlaygroundHere (DisplayListPlaygroundCallback callback)

std::unique_ptr< testing::Screenshot >	MakeScreenshot (const sk_sp< flutter::DisplayList > &list)

SkFont	CreateTestFontOfSize (Scalar scalar)

SkFont	CreateTestFont ()

sk_sp< flutter::DlImage >	CreateDlImageForFixture (const char *fixture_name, bool enable_mipmapping=false) const

Public Member Functions inherited from impeller::PlaygroundTest
	PlaygroundTest ()

virtual	~PlaygroundTest ()

void	SetUp () override

void	TearDown () override

PlaygroundBackend	GetBackend () const

std::unique_ptr< fml::Mapping >	OpenAssetAsMapping (std::string asset_name) const override

absl::StatusOr< RuntimeStage::Map >	OpenAssetAsRuntimeStage (const char *asset_name) const

std::string	GetWindowTitle () const override

testing::GoldenDigestManager *	GetGoldenDigestManager () const override

Public Member Functions inherited from impeller::Playground
	Playground (PlaygroundBackend backend, const PlaygroundSwitches &switches)

virtual	~Playground ()

bool	IsPlaygroundEnabled () const

Point	GetCursorPosition () const

ISize	GetWindowSize () const

IRect	GetWindowBounds () const

Point	GetContentScale () const

Scalar	GetSecondsElapsed () const
	Get the amount of time elapsed from the start of the playground's execution.

std::shared_ptr< Context >	GetContext () const

std::shared_ptr< Context >	MakeContext () const

ContentContext &	GetContentContext () const

std::shared_ptr< TypographerContext >	GetTypographerContext () const

bool	ShouldWriteGoldenImage ()
	Whether this instance will write a golden image of the output from \|OpenPlaygroundHere\|.

void	SetEnableWriteGolden (bool write_golden)
	Sets a particular test to either write a golden or not, false by default.

bool	OpenPlaygroundHere (const RenderCallback &render_callback)

bool	OpenPlaygroundHere (const SinglePassCallback &pass_callback)

std::shared_ptr< Texture >	CreateTextureForFixture (const char *fixture_name, bool enable_mipmapping=false) const

std::shared_ptr< Texture >	CreateTextureCubeForFixture (std::array< const char *, 6 > fixture_names) const

fml::Status	SetCapabilities (const std::shared_ptr< Capabilities > &capabilities)

GLProcAddressResolver	CreateGLProcAddressResolver () const

VKProcAddressResolver	CreateVKProcAddressResolver () const

void	SetGPUDisabled (bool disabled) const
	Mark the GPU as unavilable.

RuntimeStageBackend	GetRuntimeStageBackend () const

bool	InitializePipelineDescriptorForRendering (PipelineDescriptor &desc) const
	Initializes the provided \|PipelineDescriptor\| with appropriate default values to match the conditions under which a pipeline will be rendered.

Additional Inherited Members
Static Public Member Functions inherited from impeller::PlaygroundTest
static void	SetupTestEnvironment ()

Static Public Member Functions inherited from impeller::Playground
static void	OnTearDownTestEnvironment ()

static bool	ShouldOpenNewPlaygrounds ()

static std::shared_ptr< CompressedImage >	LoadFixtureImageCompressed (std::shared_ptr< fml::Mapping > mapping)

static std::optional< DecompressedImage >	DecodeImageRGBA (const std::shared_ptr< CompressedImage > &compressed)

static std::shared_ptr< Texture >	CreateTextureForMapping (const std::shared_ptr< Context > &context, std::shared_ptr< fml::Mapping > mapping, bool enable_mipmapping=false)

static bool	SupportsBackend (PlaygroundBackend backend)

Protected Member Functions inherited from impeller::PlaygroundTest
virtual bool	IsGoldenTestSuite () const
	This method is overridden on a test suite basis and establishes whether a given set of tests is intended to generate goldens.

Protected Member Functions inherited from impeller::Playground
void	TearDownContextData ()

virtual void	EnsureContextIsUnique ()
	Make sure that when the context is later created that it will not be shared with any other playgrounds.

bool	PlatformSupportsWideGamutTests () const
	Returns true if the platform can support wide gamuts.

bool	RenderingSupportsMSAA () const
	Returns true if the rendering path supports MSAA rendering.

SampleCount	GetDefaultSampleCount () const
	Returns the default sample count of the rendering path.

virtual bool	EnsureContextSupportsWideGamut ()
	Make sure that when the context is later created that it will support wide gamuts if the platform supports it. Returns whether the platform supports wide gamut.

const PlaygroundSwitches &	GetSwitches () const
	Return an unmodifiable reference to the current switches. The switches might change at the start of a test as it has a brief opportunity to call any of the Ensure* methods that define the environment it expects, but should be stable by the time any subsequent methods that might perform work are called.

void	SetTypographerContext (std::shared_ptr< TypographerContext > typographer_context)

void	SetWindowSize (ISize size)

Detailed Description

Definition at line 16 of file dl_playground.h.

Member Typedef Documentation

◆ DisplayListPlaygroundCallback

using impeller::DlPlayground::DisplayListPlaygroundCallback = std::function<sk_sp<flutter::DisplayList>()>

Definition at line 18 of file dl_playground.h.

Constructor & Destructor Documentation

◆ DlPlayground()

impeller::DlPlayground::DlPlayground ( )

default

◆ ~DlPlayground()

impeller::DlPlayground::~DlPlayground ( )

default

Member Function Documentation

◆ CreateDlImageForFixture()

sk_sp< flutter::DlImage > impeller::DlPlayground::CreateDlImageForFixture	(	const char *	fixture_name,
		bool	enable_mipmapping = `false`
	)		const

Definition at line 77 of file dl_playground.cc.

                                  {
  std::shared_ptr<fml::Mapping> mapping =
      flutter::testing::OpenFixtureAsMapping(fixture_name);
  std::shared_ptr<Texture> texture = Playground::CreateTextureForMapping(
      GetContext(), mapping, enable_mipmapping);
  if (texture) {
    texture->SetLabel(fixture_name);
  }
  return DlImageImpeller::Make(texture);
}

References impeller::Playground::CreateTextureForMapping(), impeller::Playground::GetContext(), impeller::DlImageImpeller::Make(), flutter::testing::OpenFixtureAsMapping(), and texture.

◆ CreateTestFont()

SkFont impeller::DlPlayground::CreateTestFont ( )

Definition at line 73 of file dl_playground.cc.

                                    {
  return CreateTestFontOfSize(50);
}

References CreateTestFontOfSize().

◆ CreateTestFontOfSize()

SkFont impeller::DlPlayground::CreateTestFontOfSize ( Scalar scalar )

Definition at line 65 of file dl_playground.cc.

                                                       {
  static constexpr const char* kTestFontFixture = "Roboto-Regular.ttf";
  auto mapping = flutter::testing::OpenFixtureAsSkData(kTestFontFixture);
  FML_CHECK(mapping);
  sk_sp<SkFontMgr> font_mgr = txt::GetDefaultFontManager();
  return SkFont{font_mgr->makeFromData(mapping), scalar};
}

References FML_CHECK, txt::GetDefaultFontManager(), and flutter::testing::OpenFixtureAsSkData().

Referenced by CreateTestFont().

◆ MakeScreenshot()

std::unique_ptr< testing::Screenshot > impeller::DlPlayground::MakeScreenshot ( const sk_sp< flutter::DisplayList > & list )

Definition at line 52 of file dl_playground.cc.

                                           {
  std::shared_ptr<Context> context = GetContext();
  AiksContext renderer(context, GetTypographerContext());
  Point content_scale = GetContentScale();
 
  ISize physical_window_size(
      std::round(GetWindowSize().width * content_scale.x),
      std::round(GetWindowSize().height * content_scale.y));
  return testing::Screenshotter::MakeScreenshot(
      context, DisplayListToTexture(list, physical_window_size, renderer));
}

References context, impeller::DisplayListToTexture(), impeller::Playground::GetContentScale(), impeller::Playground::GetContext(), impeller::Playground::GetTypographerContext(), impeller::Playground::GetWindowSize(), height, impeller::testing::Screenshotter::MakeScreenshot(), width, impeller::TPoint< T >::x, and impeller::TPoint< T >::y.

◆ OpenPlaygroundHere() [1/3]

bool impeller::DlPlayground::OpenPlaygroundHere ( DisplayListPlaygroundCallback callback )

Definition at line 33 of file dl_playground.cc.

                                                                            {
  AiksContext context(GetContext(), TypographerContextSkia::Make());
  if (!context.IsValid()) {
    return false;
  }
  return Playground::OpenPlaygroundHere(
      [&context, &callback](RenderTarget& render_target) -> bool {
        return RenderToTarget(
            context.GetContentContext(),  //
            render_target,                //
            callback(),                   //
            Rect::MakeWH(render_target.GetRenderTargetSize().width,
                         render_target.GetRenderTargetSize().height),  //
            /*reset_host_buffer=*/true,                                //
            /*is_onscreen=*/false                                      //
        );
      });
}

References callback, context, impeller::Playground::GetContext(), impeller::RenderTarget::GetRenderTargetSize(), impeller::TSize< T >::height, impeller::TypographerContextSkia::Make(), impeller::TRect< Scalar >::MakeWH(), impeller::Playground::OpenPlaygroundHere(), impeller::RenderToTarget(), and impeller::TSize< T >::width.

◆ OpenPlaygroundHere() [2/3]

bool impeller::DlPlayground::OpenPlaygroundHere ( flutter::DisplayListBuilder & builder )

Definition at line 25 of file dl_playground.cc.

                                                                        {
  return OpenPlaygroundHere(builder.Build());
}

References flutter::DisplayListBuilder::Build(), and OpenPlaygroundHere().

Referenced by OpenPlaygroundHere(), and OpenPlaygroundHere().

◆ OpenPlaygroundHere() [3/3]

bool impeller::DlPlayground::OpenPlaygroundHere ( sk_sp< flutter::DisplayList > list )

Definition at line 29 of file dl_playground.cc.

                                                                    {
  return OpenPlaygroundHere([&list]() { return list; });
}

References OpenPlaygroundHere().

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

impeller/display_list/dl_playground.h
impeller/display_list/dl_playground.cc

Public Types

Public Member Functions

Additional Inherited Members