#include <playground_test.h>

Inheritance diagram for impeller::PlaygroundTest:

Public Member Functions
	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.

Static Public Member Functions
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
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)

Additional Inherited Members
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)>

Detailed Description

Definition at line 23 of file playground_test.h.

Constructor & Destructor Documentation

◆ PlaygroundTest()

impeller::PlaygroundTest::PlaygroundTest ( )

Definition at line 20 of file playground_test.cc.

    : Playground(GetParam(),
                 PlaygroundSwitches{flutter::testing::GetArgsForProcess()}) {
  ImpellerValidationErrorsSetCallback(
      [](const char* message, const char* file, int line) -> bool {
        // GTEST_MESSAGE_AT_ can only be used in a function that returns void.
        // Hence the goofy lambda. The failure message and location will still
        // be correct however.
        //
        // https://google.github.io/googletest/advanced.html#assertion-placement
        [message, file, line]() -> void {
          GTEST_MESSAGE_AT_(file, line, "Impeller Validation Error",
                            ::testing::TestPartResult::kFatalFailure)
              << message;
        }();
        return true;
      });
}

References impeller::ImpellerValidationErrorsSetCallback(), and message.

◆ ~PlaygroundTest()

impeller::PlaygroundTest::~PlaygroundTest ( )

virtual

Reimplemented in impeller::interop::testing::PlaygroundTest.

Definition at line 39 of file playground_test.cc.

                                {
  ImpellerValidationErrorsSetCallback(nullptr);
}

References impeller::ImpellerValidationErrorsSetCallback().

Member Function Documentation

◆ GetBackend()

PlaygroundBackend impeller::PlaygroundTest::GetBackend ( ) const

Definition at line 180 of file playground_test.cc.

                                                   {
  return GetParam();
}

Referenced by impeller::interop::testing::PlaygroundTest::CreateContext(), impeller::interop::testing::PlaygroundTest::GetInteropContext(), GetWindowTitle(), and impeller::interop::testing::PlaygroundTest::OpenPlaygroundHere().

◆ GetGoldenDigestManager()

impeller::testing::GoldenDigestManager * impeller::PlaygroundTest::GetGoldenDigestManager ( ) const

overridevirtual

Reimplemented from impeller::Playground.

Definition at line 171 of file playground_test.cc.

          {
  return PlaygroundTestEnvironment::GetGoldenDigestManager();
}

◆ GetWindowTitle()

std::string impeller::PlaygroundTest::GetWindowTitle ( ) const

overridevirtual

Implements impeller::Playground.

Definition at line 201 of file playground_test.cc.

                                               {
  std::stringstream stream;
  stream << "Impeller Playground for '"
         << flutter::testing::GetCurrentTestName() << "' ";
  switch (GetBackend()) {
    case PlaygroundBackend::kMetal:
    case PlaygroundBackend::kMetalSDF:
      break;
    case PlaygroundBackend::kOpenGLES:
    case PlaygroundBackend::kOpenGLESSDF:
      if (GetSwitches().use_angle) {
        stream << " (Angle) ";
      }
      break;
    case PlaygroundBackend::kVulkan:
      if (GetSwitches().use_swiftshader) {
        stream << " (SwiftShader) ";
      }
      break;
  }
  stream << " (Press ESC to quit)";
  return stream.str();
}

References GetBackend(), flutter::testing::GetCurrentTestName(), impeller::Playground::GetSwitches(), impeller::kMetal, impeller::kMetalSDF, impeller::kOpenGLES, impeller::kOpenGLESSDF, and impeller::kVulkan.

◆ IsGoldenTestSuite()

bool impeller::PlaygroundTest::IsGoldenTestSuite ( ) const

protectedvirtual

This method is overridden on a test suite basis and establishes whether a given set of tests is intended to generate goldens.

The return value of this method is used to set the default value of |PlaygroundShouldWriteGoldenImage|, but an individual test is still allowed to enable a golden image by calling |SetEnableWriteGolden|.

Returns: false by default unless overridden in a subclass

Reimplemented in impeller::AiksPlaygroundWithGoldens, impeller::DlPlaygroundWithGoldens, and impeller::PlaygroundTestWithGoldens.

Definition at line 176 of file playground_test.cc.

                                             {
  return false;
}

Referenced by SetUp().

◆ OpenAssetAsMapping()

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

overridevirtual

Implements impeller::Playground.

Definition at line 185 of file playground_test.cc.

                                {
  return flutter::testing::OpenFixtureAsMapping(asset_name);
}

References flutter::testing::OpenFixtureAsMapping().

Referenced by impeller::interop::testing::PlaygroundTest::OpenAssetAsHPPMapping(), and impeller::interop::testing::PlaygroundTest::OpenAssetAsHPPTexture().

◆ OpenAssetAsRuntimeStage()

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

Definition at line 190 of file playground_test.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().

◆ SetUp()

void impeller::PlaygroundTest::SetUp ( )

override

Definition at line 43 of file playground_test.cc.

                           {
  if (!Playground::SupportsBackend(GetParam())) {
    GTEST_SKIP() << "Playground doesn't support this backend type.";
    return;
  }
 
  if (!Playground::ShouldOpenNewPlaygrounds()) {
    GTEST_SKIP() << "Skipping due to user action.";
    return;
  }
 
  SetEnableWriteGolden(IsGoldenTestSuite());
}

References IsGoldenTestSuite(), impeller::Playground::SetEnableWriteGolden(), impeller::Playground::ShouldOpenNewPlaygrounds(), and impeller::Playground::SupportsBackend().

Referenced by impeller::interop::testing::PlaygroundTest::SetUp().

◆ SetupTestEnvironment()

void impeller::PlaygroundTest::SetupTestEnvironment ( )

static

Definition at line 139 of file playground_test.cc.

                                          {
#ifdef ENABLE_VK_SWIFTSHADER
  // Make sure environment is set up for VK swiftshader
  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);
#endif
 
#ifdef APPLY_METAL_VALIDATION
  // https://developer.apple.com/documentation/metal/diagnosing_metal_programming_issues_early?language=objc
  // Enables all shader validation tests.
  setenv("MTL_SHADER_VALIDATION", "1", true);
  // Validates accesses to device and constant memory.
  setenv("MTL_SHADER_VALIDATION_GLOBAL_MEMORY", "1", true);
  // Validates accesses to threadgroup memory.
  setenv("MTL_SHADER_VALIDATION_THREADGROUP_MEMORY", "1", true);
  // Validates that texture references are not nil.
  setenv("MTL_SHADER_VALIDATION_TEXTURE_USAGE", "1", true);
  // Enables metal validation.
  setenv("METAL_DEBUG_ERROR_MODE", "0", true);
  // Enables metal validation.
  setenv("METAL_DEVICE_WRAPPER_TYPE", "1", true);
#endif
 
  ::testing::AddGlobalTestEnvironment(new PlaygroundTestEnvironment());
}

References flutter::testing::GetTestingAssetsPath().

Referenced by impeller::testing::ImpellerUnittestSetup().

◆ TearDown()

void impeller::PlaygroundTest::TearDown ( )

override

Definition at line 57 of file playground_test.cc.

                              {
  Playground::TearDownContextData();
}

References impeller::Playground::TearDownContextData().

Referenced by impeller::AiksPlayground::TearDown(), and impeller::interop::testing::PlaygroundTest::TearDown().

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

impeller/playground/playground_test.h
impeller/playground/playground_test.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PlaygroundTest()

◆ ~PlaygroundTest()

Member Function Documentation

◆ GetBackend()

◆ GetGoldenDigestManager()

◆ GetWindowTitle()

◆ IsGoldenTestSuite()

◆ OpenAssetAsMapping()

◆ OpenAssetAsRuntimeStage()

◆ SetUp()

◆ SetupTestEnvironment()

◆ TearDown()