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)
RuntimeStageBackend	GetRuntimeStageBackend () const
void	SetEnableWriteGolden (bool write_golden)
	Sets a particular test to either write a golden or not.
bool	IsPlaygroundEnabled () 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.

Static Public Member Functions
static bool	SaveScreenshot (std::unique_ptr< testing::Screenshot > screenshot, const std::string &postfix="")

Protected Member Functions
void	SetWindowSize (ISize size)
bool	RenderingSupportsMSAA () const
	Returns true if the rendering path supports MSAA rendering.
SampleCount	GetDefaultSampleCount () const
	Returns the default sample count of the rendering path.
void	EnsureContextIsUnique ()
bool	EnsureContextSupportsWideGamut ()

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 159 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 342 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 329 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().

EnsureContextIsUnique()

void impeller::GoldenPlaygroundTest::EnsureContextIsUnique ( )

inlineprotected

Definition at line 130 of file golden_playground_test.h.

{}

EnsureContextSupportsWideGamut()

bool impeller::GoldenPlaygroundTest::EnsureContextSupportsWideGamut ( )

inlineprotected

Definition at line 136 of file golden_playground_test.h.

{ return true; }

GetBackend()

PlaygroundBackend impeller::GoldenPlaygroundTest::GetBackend

(

)

const

Definition at line 253 of file golden_playground_test_mac.cc.

                                                         {
  return GetParam();
}

GetContentScale()

Point impeller::GoldenPlaygroundTest::GetContentScale

(

)

const

Definition at line 398 of file golden_playground_test_mac.cc.

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

GetContext()

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

(

)

const

Definition at line 360 of file golden_playground_test_mac.cc.

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

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

GetDefaultSampleCount()

SampleCount impeller::GoldenPlaygroundTest::GetDefaultSampleCount ( ) const

inlineprotected

Returns the default sample count of the rendering path.

In the case of goldens, all tests are rendered to a non-MSAA backend.

Definition at line 126 of file golden_playground_test.h.

{ return SampleCount::kCount1; }

References impeller::kCount1.

GetRuntimeStageBackend()

RuntimeStageBackend impeller::GoldenPlaygroundTest::GetRuntimeStageBackend

(

)

const

Definition at line 436 of file golden_playground_test_mac.cc.

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

GetSecondsElapsed()

Scalar impeller::GoldenPlaygroundTest::GetSecondsElapsed

(

)

const

Definition at line 402 of file golden_playground_test_mac.cc.

                                                     {
  return 0.0f;
}

GetWindowBounds()

IRect impeller::GoldenPlaygroundTest::GetWindowBounds

(

)

const

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

                                                {
  return pimpl_->window_size;
}

InitializePipelineDescriptorForRendering()

bool impeller::GoldenPlaygroundTest::InitializePipelineDescriptorForRendering

(

PipelineDescriptor &

desc

)

const

Initializes the provided |PipelineDescriptor| with appropriate default values to match the conditions under which a pipeline will be rendered.

Definition at line 447 of file golden_playground_test_mac.cc.

                                    {
  // Match the golden harness render target: single-sampled, no depth/stencil.
  // `ClearStencilAttachments` also resets the stencil pixel format on the
  // pipeline, which Metal validation requires to match the target's lack of a
  // stencil texture; `SetStencilAttachmentDescriptors(nullopt)` alone leaves
  // the format set and trips that validation.
  desc.SetSampleCount(SampleCount::kCount1);
  desc.ClearStencilAttachments();
  desc.ClearDepthAttachment();
  return true;
}

References impeller::PipelineDescriptor::ClearDepthAttachment(), impeller::PipelineDescriptor::ClearStencilAttachments(), impeller::kCount1, and impeller::PipelineDescriptor::SetSampleCount().

IsPlaygroundEnabled()

bool impeller::GoldenPlaygroundTest::IsPlaygroundEnabled ( ) const

inline

Definition at line 108 of file golden_playground_test.h.

{ return false; }

MakeContext()

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

(

)

const

On Metal we create a context for each test.

Definition at line 367 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::VulkanGoldenScreenshotter>(
            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::VulkanGoldenScreenshotter>(
            pimpl_->test_opengl_playground);
    return pimpl_->test_opengl_playground->GetContext();
  } else {
    FML_CHECK(false);
    return nullptr;
  }
}

References FML_CHECK, 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 423 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 350 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(), and flutter::testing::OpenFixtureAsMapping().

OpenPlaygroundHere() [1/5]

bool impeller::GoldenPlaygroundTest::OpenPlaygroundHere

(

AiksPlaygroundCallback

callback

)

OpenPlaygroundHere() [2/5]

bool impeller::GoldenPlaygroundTest::OpenPlaygroundHere

(

const AiksDlPlaygroundCallback &

callback

)

Definition at line 257 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/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 282 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 callback, command_buffer, context, impeller::RenderTargetAllocator::CreateOffscreen(), GetContext(), impeller::RenderTarget::GetRenderTargetTexture(), i, 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 277 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().

RenderingSupportsMSAA()

bool impeller::GoldenPlaygroundTest::RenderingSupportsMSAA ( ) const

inlineprotected

Returns true if the rendering path supports MSAA rendering.

In the case of goldens, all tests are rendered to a non-MSAA backend.

Definition at line 121 of file golden_playground_test.h.

{ return false; }

SaveScreenshot()

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

static

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

SetCapabilities()

fml::Status impeller::GoldenPlaygroundTest::SetCapabilities

(

const std::shared_ptr< Capabilities > &

capabilities

)

Definition at line 418 of file golden_playground_test_mac.cc.

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

SetEnableWriteGolden()

void impeller::GoldenPlaygroundTest::SetEnableWriteGolden

(

bool

write_golden

)

Sets a particular test to either write a golden or not.

For purposes of the GoldenPlayground test harness, we don't maintain a flag for this status, all tests are assumed to be golden tests and passing false here means we should just skip this test entirely (enforced in the implementation with a GTEST_SKIP).

Definition at line 440 of file golden_playground_test_mac.cc.

                                                                 {
  if (!write_golden) {
    // If we don't write a golden, we really don't have anything to do.
    GTEST_SKIP() << "Test does not want a golden image written";
  }
}

SetTypographerContext()

void impeller::GoldenPlaygroundTest::SetTypographerContext

(

std::shared_ptr< TypographerContext >

typographer_context

)

Definition at line 165 of file golden_playground_test_mac.cc.

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

SetUp()

void impeller::GoldenPlaygroundTest::SetUp

(

)

Definition at line 189 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;
  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::MetalGoldenScreenshotter>(switches);
      break;
    case PlaygroundBackend::kVulkan: {
      if (switches.enable_wide_gamut) {
        GTEST_SKIP() << "Vulkan doesn't support wide gamut golden tests.";
      }
      const std::unique_ptr<PlaygroundImpl>& playground =
          GetSharedVulkanPlayground(/*enable_validations=*/true);
      pimpl_->screenshotter =
          std::make_unique<testing::VulkanGoldenScreenshotter>(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.";
      }
      const std::unique_ptr<PlaygroundImpl>& playground =
          GetSharedOpenGLESPlayground(switches.flags.use_sdfs);
      ::glfwMakeContextCurrent(
          reinterpret_cast<GLFWwindow*>(playground->GetWindowHandle()));
      pimpl_->screenshotter =
          std::make_unique<testing::VulkanGoldenScreenshotter>(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::PlaygroundSwitches::enable_wide_gamut, impeller::PlaygroundSwitches::flags, GetContext(), flutter::testing::GetTestingAssetsPath(), 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 170 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().

---

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