impeller::GoldenPlaygroundTest Class Reference

#include <golden_playground_test.h>

Inheritance diagram for impeller::GoldenPlaygroundTest:

Classes
struct	GoldenPlaygroundTestImpl

Public Types
using	AiksPlaygroundCallback = std::function< std::optional< Picture >(AiksContext &renderer)>
using	AiksDlPlaygroundCallback = std::function< sk_sp< flutter::DisplayList >()>

Public Member Functions
	GoldenPlaygroundTest ()
	~GoldenPlaygroundTest () override
void	SetUp ()
void	TearDown ()
PlaygroundBackend	GetBackend () const
void	SetTypographerContext (std::shared_ptr< TypographerContext > typographer_context)
bool	OpenPlaygroundHere (Picture picture)
bool	OpenPlaygroundHere (AiksPlaygroundCallback callback)
bool	OpenPlaygroundHere (const AiksDlPlaygroundCallback &callback)
bool	OpenPlaygroundHere (const sk_sp< flutter::DisplayList > &list)
std::unique_ptr< testing::Screenshot >	MakeScreenshot (const sk_sp< flutter::DisplayList > &list)
std::shared_ptr< Texture >	CreateTextureForFixture (const char *fixture_name, bool enable_mipmapping=false) const
sk_sp< flutter::DlImage >	CreateDlImageForFixture (const char *fixture_name, bool enable_mipmapping=false) const
RuntimeStage::Map	OpenAssetAsRuntimeStage (const char *asset_name) const
std::shared_ptr< Context >	GetContext () const
std::shared_ptr< Context >	MakeContext () const
Point	GetContentScale () const
Scalar	GetSecondsElapsed () const
ISize	GetWindowSize () const
fml::Status	SetCapabilities (const std::shared_ptr< Capabilities > &capabilities)
bool	WillRenderSomething () const
	Returns true if OpenPlaygroundHere will actually render anything.

Static Public Member Functions
static bool	SaveScreenshot (std::unique_ptr< testing::Screenshot > screenshot, const std::string &postfix="")
static bool	ImGuiBegin (const char *name, bool *p_open, ImGuiWindowFlags flags)

Protected Member Functions
void	SetWindowSize (ISize size)

Detailed Description

Definition at line 26 of file golden_playground_test.h.

Member Typedef Documentation

AiksDlPlaygroundCallback

using impeller::GoldenPlaygroundTest::AiksDlPlaygroundCallback = std::function<sk_sp<flutter::DisplayList>()>

Definition at line 32 of file golden_playground_test.h.

AiksPlaygroundCallback

using impeller::GoldenPlaygroundTest::AiksPlaygroundCallback = std::function<std::optional<Picture>(AiksContext& renderer)>

Definition at line 29 of file golden_playground_test.h.

Constructor & Destructor Documentation

GoldenPlaygroundTest()

impeller::GoldenPlaygroundTest::GoldenPlaygroundTest ( )

default

Definition at line 122 of file golden_playground_test_mac.cc.

    : typographer_context_(TypographerContextSkia::Make()),
      pimpl_(new GoldenPlaygroundTest::GoldenPlaygroundTestImpl()) {}

~GoldenPlaygroundTest()

impeller::GoldenPlaygroundTest::~GoldenPlaygroundTest ( )

overridedefault

Member Function Documentation

CreateDlImageForFixture()

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

Definition at line 269 of file golden_playground_test_mac.cc.

                                  {
  std::shared_ptr<Texture> texture =
      CreateTextureForFixture(fixture_name, enable_mipmapping);
  return DlImageImpeller::Make(texture);
}

References CreateTextureForFixture(), impeller::DlImageImpeller::Make(), and texture.

CreateTextureForFixture()

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

Definition at line 256 of file golden_playground_test_mac.cc.

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

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

Referenced by CreateDlImageForFixture().

GetBackend()

PlaygroundBackend impeller::GoldenPlaygroundTest::GetBackend

(

)

const

Definition at line 221 of file golden_playground_test_mac.cc.

                                                         {
  return GetParam();
}

GetContentScale()

Point impeller::GoldenPlaygroundTest::GetContentScale

(

)

const

Definition at line 313 of file golden_playground_test_mac.cc.

                                                  {
  return pimpl_->screenshotter->GetPlayground().GetContentScale();
}

GetContext()

std::shared_ptr< Context > impeller::GoldenPlaygroundTest::GetContext

(

)

const

Definition at line 287 of file golden_playground_test_mac.cc.

                                                              {
  if (!pimpl_->screenshotter) {
    return nullptr;
  }
  return pimpl_->screenshotter->GetPlayground().GetContext();
}

Referenced by CreateTextureForFixture(), MakeContext(), MakeScreenshot(), OpenPlaygroundHere(), SetUp(), and TearDown().

GetSecondsElapsed()

Scalar impeller::GoldenPlaygroundTest::GetSecondsElapsed

(

)

const

Definition at line 317 of file golden_playground_test_mac.cc.

                                                     {
  return 0.0f;
}

GetWindowSize()

ISize impeller::GoldenPlaygroundTest::GetWindowSize

(

)

const

Definition at line 321 of file golden_playground_test_mac.cc.

                                                {
  return pimpl_->window_size;
}

ImGuiBegin()

bool impeller::GoldenPlaygroundTest::ImGuiBegin ( const char *  name, bool *  p_open, ImGuiWindowFlags  flags  )

static

Definition at line 250 of file golden_playground_test_mac.cc.

                                                              {
  return false;
}

MakeContext()

std::shared_ptr< Context > impeller::GoldenPlaygroundTest::MakeContext

(

)

const

On Metal we create a context for each test.

On OpenGL we create a context for each test.

Definition at line 294 of file golden_playground_test_mac.cc.

                                                               {
  if (GetParam() == PlaygroundBackend::kMetal) {
    /// On Metal we create a context for each test.
    return GetContext();
  } else if (GetParam() == PlaygroundBackend::kVulkan) {
    bool enable_vulkan_validations = true;
    FML_CHECK(!pimpl_->test_vulkan_playground)
        << "We don't support creating multiple contexts for one test";
    pimpl_->test_vulkan_playground =
        MakeVulkanPlayground(enable_vulkan_validations);
    pimpl_->screenshotter = std::make_unique<testing::VulkanScreenshotter>(
        pimpl_->test_vulkan_playground);
    return pimpl_->test_vulkan_playground->GetContext();
  } else {
    /// On OpenGL we create a context for each test.
    return GetContext();
  }
}

References FML_CHECK, GetContext(), impeller::kMetal, and impeller::kVulkan.

MakeScreenshot()

std::unique_ptr< testing::Screenshot > impeller::GoldenPlaygroundTest::MakeScreenshot

(

const sk_sp< flutter::DisplayList > &

list

)

Definition at line 334 of file golden_playground_test_mac.cc.

                                           {
  AiksContext renderer(GetContext(), typographer_context_);
  Point content_scale =
      pimpl_->screenshotter->GetPlayground().GetContentScale();
 
  ISize physical_window_size(
      std::round(pimpl_->window_size.width * content_scale.x),
      std::round(pimpl_->window_size.height * content_scale.y));
  return pimpl_->screenshotter->MakeScreenshot(
      renderer, DisplayListToTexture(list, physical_window_size, renderer));
}

References impeller::DisplayListToTexture(), GetContext(), impeller::TPoint< T >::x, and impeller::TPoint< T >::y.

OpenAssetAsRuntimeStage()

RuntimeStage::Map impeller::GoldenPlaygroundTest::OpenAssetAsRuntimeStage

(

const char *

asset_name

)

const

Definition at line 277 of file golden_playground_test_mac.cc.

                                  {
  const std::shared_ptr<fml::Mapping> fixture =
      flutter::testing::OpenFixtureAsMapping(asset_name);
  if (!fixture || fixture->GetSize() == 0) {
    return {};
  }
  return RuntimeStage::DecodeRuntimeStages(fixture);
}

References impeller::RuntimeStage::DecodeRuntimeStages(), and flutter::testing::OpenFixtureAsMapping().

OpenPlaygroundHere() [1/4]

bool impeller::GoldenPlaygroundTest::OpenPlaygroundHere

(

AiksPlaygroundCallback

callback

)

OpenPlaygroundHere() [2/4]

bool impeller::GoldenPlaygroundTest::OpenPlaygroundHere

(

const AiksDlPlaygroundCallback &

callback

)

Definition at line 225 of file golden_playground_test_mac.cc.

                                              {
  AiksContext renderer(GetContext(), typographer_context_);
 
  std::unique_ptr<testing::Screenshot> screenshot;
  Point content_scale =
      pimpl_->screenshotter->GetPlayground().GetContentScale();
 
  ISize physical_window_size(
      std::round(pimpl_->window_size.width * content_scale.x),
      std::round(pimpl_->window_size.height * content_scale.y));
  for (int i = 0; i < 2; ++i) {
    auto display_list = callback();
    auto texture =
        DisplayListToTexture(display_list, physical_window_size, renderer);
    screenshot = pimpl_->screenshotter->MakeScreenshot(renderer, texture);
  }
  return SaveScreenshot(std::move(screenshot));
}

References callback, impeller::DisplayListToTexture(), GetContext(), i, SaveScreenshot(), texture, impeller::TPoint< T >::x, and impeller::TPoint< T >::y.

OpenPlaygroundHere() [3/4]

bool impeller::GoldenPlaygroundTest::OpenPlaygroundHere

(

const sk_sp< flutter::DisplayList > &

list

)

Definition at line 245 of file golden_playground_test_mac.cc.

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

References OpenPlaygroundHere().

OpenPlaygroundHere() [4/4]

bool impeller::GoldenPlaygroundTest::OpenPlaygroundHere

(

Picture

picture

)

Referenced by OpenPlaygroundHere().

SaveScreenshot()

bool impeller::GoldenPlaygroundTest::SaveScreenshot ( std::unique_ptr< testing::Screenshot >  screenshot, const std::string &  postfix = ""  )

static

Definition at line 96 of file golden_playground_test_mac.cc.

                              {
  if (!screenshot || !screenshot->GetBytes()) {
    FML_LOG(ERROR) << "Failed to collect screenshot for test " << GetTestName();
    return false;
  }
  std::string test_name = GetTestName();
  std::string filename = GetGoldenFilename(postfix);
  testing::GoldenDigest::Instance()->AddImage(
      test_name, filename, screenshot->GetWidth(), screenshot->GetHeight());
  if (!screenshot->WriteToPNG(
          testing::WorkingDirectory::Instance()->GetFilenamePath(filename))) {
    FML_LOG(ERROR) << "Failed to write screenshot to " << filename;
    return false;
  }
  return true;
}

References impeller::testing::GoldenDigest::AddImage(), FML_LOG, impeller::testing::WorkingDirectory::GetFilenamePath(), impeller::testing::GoldenDigest::Instance(), and impeller::testing::WorkingDirectory::Instance().

Referenced by OpenPlaygroundHere().

SetCapabilities()

fml::Status impeller::GoldenPlaygroundTest::SetCapabilities

(

const std::shared_ptr< Capabilities > &

capabilities

)

Definition at line 329 of file golden_playground_test_mac.cc.

                                                     {
  return pimpl_->screenshotter->GetPlayground().SetCapabilities(capabilities);
}

SetTypographerContext()

void impeller::GoldenPlaygroundTest::SetTypographerContext

(

std::shared_ptr< TypographerContext >

typographer_context

)

Definition at line 128 of file golden_playground_test_mac.cc.

                                                           {
  typographer_context_ = std::move(typographer_context);
};

SetUp()

void impeller::GoldenPlaygroundTest::SetUp

(

)

Definition at line 152 of file golden_playground_test_mac.cc.

                                 {
  std::filesystem::path testing_assets_path =
      flutter::testing::GetTestingAssetsPath();
  std::filesystem::path target_path = testing_assets_path.parent_path()
                                          .parent_path()
                                          .parent_path()
                                          .parent_path();
  std::filesystem::path icd_path = target_path / "vk_swiftshader_icd.json";
  setenv("VK_ICD_FILENAMES", icd_path.c_str(), 1);
 
  std::string test_name = GetTestName();
  PlaygroundSwitches switches;
  switches.enable_wide_gamut =
      test_name.find("WideGamut_") != std::string::npos;
  switches.flags.antialiased_lines =
      test_name.find("ExperimentAntialiasLines_") != std::string::npos;
  switch (GetParam()) {
    case PlaygroundBackend::kMetal:
      if (!DoesSupportWideGamutTests()) {
        GTEST_SKIP()
            << "This metal device doesn't support wide gamut golden tests.";
      }
      pimpl_->screenshotter =
          std::make_unique<testing::MetalScreenshotter>(switches);
      break;
    case PlaygroundBackend::kVulkan: {
      if (switches.enable_wide_gamut) {
        GTEST_SKIP() << "Vulkan doesn't support wide gamut golden tests.";
      }
      if (switches.flags.antialiased_lines) {
        GTEST_SKIP()
            << "Vulkan doesn't support antialiased lines golden tests.";
      }
      const std::unique_ptr<PlaygroundImpl>& playground =
          GetSharedVulkanPlayground(/*enable_validations=*/true);
      pimpl_->screenshotter =
          std::make_unique<testing::VulkanScreenshotter>(playground);
      break;
    }
    case PlaygroundBackend::kOpenGLES: {
      if (switches.enable_wide_gamut) {
        GTEST_SKIP() << "OpenGLES doesn't support wide gamut golden tests.";
      }
      if (switches.flags.antialiased_lines) {
        GTEST_SKIP()
            << "OpenGLES doesn't support antialiased lines golden tests.";
      }
      FML_CHECK(::glfwInit() == GLFW_TRUE);
      PlaygroundSwitches playground_switches;
      playground_switches.use_angle = true;
      pimpl_->test_opengl_playground = PlaygroundImpl::Create(
          PlaygroundBackend::kOpenGLES, playground_switches);
      pimpl_->screenshotter = std::make_unique<testing::VulkanScreenshotter>(
          pimpl_->test_opengl_playground);
      break;
    }
  }
 
  if (std::find(kSkipTests.begin(), kSkipTests.end(), test_name) !=
      kSkipTests.end()) {
    GTEST_SKIP()
        << "GoldenPlaygroundTest doesn't support interactive playground tests "
           "yet.";
  }
 
  testing::GoldenDigest::Instance()->AddDimension(
      "gpu_string", GetContext()->DescribeGpuModel());
}

References impeller::testing::GoldenDigest::AddDimension(), impeller::Flags::antialiased_lines, impeller::PlaygroundImpl::Create(), impeller::PlaygroundSwitches::enable_wide_gamut, impeller::PlaygroundSwitches::flags, FML_CHECK, GetContext(), flutter::testing::GetTestingAssetsPath(), GLFW_TRUE, impeller::testing::GoldenDigest::Instance(), impeller::kMetal, impeller::kOpenGLES, impeller::kSkipTests, impeller::kVulkan, and impeller::PlaygroundSwitches::use_angle.

SetWindowSize()

void impeller::GoldenPlaygroundTest::SetWindowSize ( ISize  size )

protected

Definition at line 71 of file golden_playground_test_stub.cc.

{}

TearDown()

void impeller::GoldenPlaygroundTest::TearDown

(

)

Definition at line 133 of file golden_playground_test_mac.cc.

                                    {
  ASSERT_FALSE(dlopen("/usr/local/lib/libMoltenVK.dylib", RTLD_NOLOAD));
 
  auto context = GetContext();
  if (context) {
    context->DisposeThreadLocalCachedResources();
  }
}

References GetContext().

WillRenderSomething()

bool impeller::GoldenPlaygroundTest::WillRenderSomething ( ) const

inline

Returns true if OpenPlaygroundHere will actually render anything.

Definition at line 89 of file golden_playground_test.h.

{ return true; }

---

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

• impeller/golden_tests/golden_playground_test.h
• impeller/golden_tests/golden_playground_test_mac.cc
• impeller/golden_tests/golden_playground_test_stub.cc