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)
bool	OpenPlaygroundHere (const Playground::SinglePassCallback &callback)
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
absl::StatusOr< 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
IRect	GetWindowBounds () const
fml::Status	SetCapabilities (const std::shared_ptr< Capabilities > &capabilities)
bool	WillRenderSomething () const
	Returns true if OpenPlaygroundHere will actually render anything. More...
RuntimeStageBackend	GetRuntimeStageBackend () const
bool	IsGoldenTest ()

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)
bool	PlatformSupportsWideGamutTests () const
void	EnsureContextIsUnique ()
bool	EnsureContextSupportsWideGamut ()
void	EnsureContextSupportsAntialiasLines ()

Detailed Description

Definition at line 27 of file golden_playground_test.h.

Member Typedef Documentation

AiksDlPlaygroundCallback

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

Definition at line 33 of file golden_playground_test.h.

AiksPlaygroundCallback

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

Definition at line 30 of file golden_playground_test.h.

Constructor & Destructor Documentation

GoldenPlaygroundTest()

impeller::GoldenPlaygroundTest::GoldenPlaygroundTest ( )

default

Definition at line 157 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 360 of file golden_playground_test_mac.cc.

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

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

CreateTextureForFixture()

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

Definition at line 347 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(), and GetContext().

Referenced by CreateDlImageForFixture().

EnsureContextIsUnique()

void impeller::GoldenPlaygroundTest::EnsureContextIsUnique ( )

inlineprotected

Definition at line 117 of file golden_playground_test.h.

{}

EnsureContextSupportsAntialiasLines()

void impeller::GoldenPlaygroundTest::EnsureContextSupportsAntialiasLines ( )

inlineprotected

Definition at line 125 of file golden_playground_test.h.

{}

EnsureContextSupportsWideGamut()

bool impeller::GoldenPlaygroundTest::EnsureContextSupportsWideGamut ( )

inlineprotected

Definition at line 121 of file golden_playground_test.h.

{ return true; }

GetBackend()

PlaygroundBackend impeller::GoldenPlaygroundTest::GetBackend

(

)

const

Definition at line 265 of file golden_playground_test_mac.cc.

                                                         {
  return GetParam();
}

GetContentScale()

Point impeller::GoldenPlaygroundTest::GetContentScale

(

)

const

Definition at line 414 of file golden_playground_test_mac.cc.

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

GetContext()

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

(

)

const

Definition at line 378 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().

GetRuntimeStageBackend()

RuntimeStageBackend impeller::GoldenPlaygroundTest::GetRuntimeStageBackend

(

)

const

Definition at line 452 of file golden_playground_test_mac.cc.

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

GetSecondsElapsed()

Scalar impeller::GoldenPlaygroundTest::GetSecondsElapsed

(

)

const

Definition at line 418 of file golden_playground_test_mac.cc.

                                                     {
  return 0.0f;
}

GetWindowBounds()

IRect impeller::GoldenPlaygroundTest::GetWindowBounds

(

)

const

Definition at line 426 of file golden_playground_test_mac.cc.

                                                  {
  return IRect::MakeSize(pimpl_->window_size);
}

References impeller::TRect< T >::MakeSize().

GetWindowSize()

ISize impeller::GoldenPlaygroundTest::GetWindowSize

(

)

const

Definition at line 422 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 341 of file golden_playground_test_mac.cc.

                                                              {
  return false;
}

IsGoldenTest()

bool impeller::GoldenPlaygroundTest::IsGoldenTest ( )

inline

Definition at line 107 of file golden_playground_test.h.

{ return true; }

MakeContext()

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

(

)

const

On Metal we create a context for each test.

Definition at line 385 of file golden_playground_test_mac.cc.

                                                               {
  if (GetParam() == PlaygroundBackend::kMetal ||
      GetParam() == PlaygroundBackend::kMetalSDF) {
    /// 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 if (GetParam() == PlaygroundBackend::kOpenGLES ||
             GetParam() == PlaygroundBackend::kOpenGLESSDF) {
    FML_CHECK(!pimpl_->test_opengl_playground)
        << "We don't support creating multiple contexts for one test";
    bool use_sdfs = (GetParam() == PlaygroundBackend::kOpenGLESSDF);
    pimpl_->test_opengl_playground = MakeOpenGLESPlayground(use_sdfs);
    pimpl_->screenshotter = std::make_unique<testing::VulkanScreenshotter>(
        pimpl_->test_opengl_playground);
    return pimpl_->test_opengl_playground->GetContext();
  } else {
    FML_CHECK(false);
    return nullptr;
  }
}

References GetContext(), impeller::kMetal, impeller::kMetalSDF, impeller::kOpenGLES, impeller::kOpenGLESSDF, and impeller::kVulkan.

MakeScreenshot()

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

(

const sk_sp< flutter::DisplayList > &

list

)

Definition at line 439 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()

absl::StatusOr< RuntimeStage::Map > impeller::GoldenPlaygroundTest::OpenAssetAsRuntimeStage

(

const char *

asset_name

)

const

Definition at line 368 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 absl::NotFoundError("Asset not found or empty.");
  }
  return RuntimeStage::DecodeRuntimeStages(fixture);
}

References impeller::RuntimeStage::DecodeRuntimeStages().

OpenPlaygroundHere() [1/5]

bool impeller::GoldenPlaygroundTest::OpenPlaygroundHere

(

AiksPlaygroundCallback

callback

)

OpenPlaygroundHere() [2/5]

bool impeller::GoldenPlaygroundTest::OpenPlaygroundHere

(

const AiksDlPlaygroundCallback &

callback

)

Definition at line 269 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 impeller::DisplayListToTexture(), GetContext(), SaveScreenshot(), impeller::TPoint< T >::x, and impeller::TPoint< T >::y.

OpenPlaygroundHere() [3/5]

bool impeller::GoldenPlaygroundTest::OpenPlaygroundHere

(

const Playground::SinglePassCallback &

callback

)

Renders callback into an offscreen render pass and saves the result as a golden image. The render target is single-sampled, uses the context's default color format, and has no depth or stencil attachment, so a pipeline built from PipelineBuilder<>::MakeDefaultPipelineDescriptor must be reduced to match by calling SetSampleCount(kCount1), ClearStencilAttachments(), and ClearDepthAttachment() on it. Calling only SetStencilAttachmentDescriptors(nullopt) leaves the stencil pixel format set and trips Metal's render pipeline validation.

Definition at line 294 of file golden_playground_test_mac.cc.

                                                  {
  AiksContext renderer(GetContext(), typographer_context_);
  std::shared_ptr<Context> context = GetContext();
  Point content_scale =
      pimpl_->screenshotter->GetPlayground().GetContentScale();
  ISize size(std::round(pimpl_->window_size.width * content_scale.x),
             std::round(pimpl_->window_size.height * content_scale.y));
 
  std::unique_ptr<testing::Screenshot> screenshot;
  // Render twice so the second pass observes warmed pipeline and resource
  // caches, matching the display list path above.
  for (int i = 0; i < 2; ++i) {
    RenderTargetAllocator render_target_allocator(
        context->GetResourceAllocator());
    RenderTarget render_target = render_target_allocator.CreateOffscreen(
        *context, size, /*mip_count=*/1, "Golden Render Pass",
        RenderTarget::kDefaultColorAttachmentConfig,
        /*stencil_attachment_config=*/std::nullopt);
    if (!render_target.IsValid()) {
      return false;
    }
    std::shared_ptr<CommandBuffer> command_buffer =
        context->CreateCommandBuffer();
    if (!command_buffer) {
      return false;
    }
    std::shared_ptr<RenderPass> render_pass =
        command_buffer->CreateRenderPass(render_target);
    if (!render_pass) {
      return false;
    }
    if (!callback(*render_pass)) {
      return false;
    }
    if (!render_pass->EncodeCommands()) {
      return false;
    }
    if (!context->GetCommandQueue()->Submit({command_buffer}).ok()) {
      return false;
    }
    screenshot = pimpl_->screenshotter->MakeScreenshot(
        renderer, render_target.GetRenderTargetTexture());
  }
  return SaveScreenshot(std::move(screenshot));
}

References command_buffer, context, impeller::RenderTargetAllocator::CreateOffscreen(), GetContext(), impeller::RenderTarget::GetRenderTargetTexture(), impeller::RenderTarget::IsValid(), impeller::RenderTarget::kDefaultColorAttachmentConfig, render_pass, SaveScreenshot(), impeller::TPoint< T >::x, and impeller::TPoint< T >::y.

OpenPlaygroundHere() [4/5]

bool impeller::GoldenPlaygroundTest::OpenPlaygroundHere

(

const sk_sp< flutter::DisplayList > &

list

)

Definition at line 289 of file golden_playground_test_mac.cc.

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

References OpenPlaygroundHere().

OpenPlaygroundHere() [5/5]

bool impeller::GoldenPlaygroundTest::OpenPlaygroundHere

(

Picture

picture

)

Referenced by OpenPlaygroundHere().

PlatformSupportsWideGamutTests()

bool impeller::GoldenPlaygroundTest::PlatformSupportsWideGamutTests ( ) const

protected

Definition at line 187 of file golden_playground_test_mac.cc.

                                                                {
  return DoesSupportWideGamutTests() && GetParam() == PlaygroundBackend::kMetal;
}

References impeller::kMetal.

SaveScreenshot()

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

static

Definition at line 131 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(), 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 434 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 163 of file golden_playground_test_mac.cc.

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

SetUp()

void impeller::GoldenPlaygroundTest::SetUp

(

)

Definition at line 191 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::kMetalSDF:
      switches.flags.use_sdfs = true;
      [[fallthrough]];
    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::kOpenGLESSDF:
      switches.flags.use_sdfs = true;
      [[fallthrough]];
    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.";
      }
      const std::unique_ptr<PlaygroundImpl>& playground =
          GetSharedOpenGLESPlayground(switches.flags.use_sdfs);
      ::glfwMakeContextCurrent(
          reinterpret_cast<GLFWwindow*>(playground->GetWindowHandle()));
      pimpl_->screenshotter =
          std::make_unique<testing::VulkanScreenshotter>(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::PlaygroundSwitches::enable_wide_gamut, impeller::PlaygroundSwitches::flags, GetContext(), impeller::testing::GoldenDigest::Instance(), impeller::kMetal, impeller::kMetalSDF, impeller::kOpenGLES, impeller::kOpenGLESSDF, impeller::kSkipTests, impeller::kVulkan, and impeller::Flags::use_sdfs.

SetWindowSize()

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

protected

Definition at line 80 of file golden_playground_test_stub.cc.

{}

TearDown()

void impeller::GoldenPlaygroundTest::TearDown

(

)

Definition at line 168 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 context, and GetContext().

WillRenderSomething()

bool impeller::GoldenPlaygroundTest::WillRenderSomething ( ) const

inline

Returns true if OpenPlaygroundHere will actually render anything.

Definition at line 103 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