impeller::PlaygroundTest Class Reference

#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
RuntimeStage::Map	OpenAssetAsRuntimeStage (const char *asset_name) const
std::string	GetWindowTitle () const override
Public Member Functions inherited from impeller::Playground
	Playground (PlaygroundSwitches switches)
virtual	~Playground ()
void	SetupContext (PlaygroundBackend backend, const PlaygroundSwitches &switches)
void	SetupWindow ()
void	TeardownWindow ()
bool	IsPlaygroundEnabled () const
Point	GetCursorPosition () const
ISize	GetWindowSize () 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
bool	OpenPlaygroundHere (const RenderCallback &render_callback)
bool	OpenPlaygroundHere (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)
bool	WillRenderSomething () const
	Returns true if OpenPlaygroundHere will actually render anything.
GLProcAddressResolver	CreateGLProcAddressResolver () const
VKProcAddressResolver	CreateVKProcAddressResolver () const
void	SetGPUDisabled (bool disabled) const
	Mark the GPU as unavilable.

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)>
Static Public Member Functions inherited from impeller::Playground
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::Playground
void	SetWindowSize (ISize size)
Protected Attributes inherited from impeller::Playground
const PlaygroundSwitches	switches_

Detailed Description

Definition at line 21 of file playground_test.h.

Constructor & Destructor Documentation

PlaygroundTest()

impeller::PlaygroundTest::PlaygroundTest

(

)

Definition at line 13 of file playground_test.cc.

    : Playground(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 31 of file playground_test.cc.

                                {
  ImpellerValidationErrorsSetCallback(nullptr);
}

References impeller::ImpellerValidationErrorsSetCallback().

Member Function Documentation

GetBackend()

PlaygroundBackend impeller::PlaygroundTest::GetBackend

(

)

const

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

GetWindowTitle()

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

overridevirtual

Implements impeller::Playground.

Definition at line 100 of file playground_test.cc.

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

References GetBackend(), flutter::testing::GetCurrentTestName(), impeller::kMetal, impeller::kOpenGLES, impeller::kVulkan, impeller::Playground::switches_, impeller::PlaygroundSwitches::use_angle, and impeller::PlaygroundSwitches::use_swiftshader.

OpenAssetAsMapping()

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

overridevirtual

Implements impeller::Playground.

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

RuntimeStage::Map impeller::PlaygroundTest::OpenAssetAsRuntimeStage

(

const char *

asset_name

)

const

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

SetUp()

void impeller::PlaygroundTest::SetUp ( )

override

Definition at line 45 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;
  }
 
  // Test names that end with "WideGamut" will render with wide gamut support.
  std::string test_name = flutter::testing::GetCurrentTestName();
  PlaygroundSwitches switches = switches_;
  switches.enable_wide_gamut =
      test_name.find("WideGamut/") != std::string::npos;
 
  if (switches.enable_wide_gamut && (GetParam() != PlaygroundBackend::kMetal ||
                                     !DoesSupportWideGamutTests())) {
    GTEST_SKIP() << "This backend doesn't yet support wide gamut.";
    return;
  }
 
  switches.flags.antialiased_lines =
      test_name.find("ExperimentAntialiasLines/") != std::string::npos;
 
  SetupContext(GetParam(), switches);
  SetupWindow();
}

References impeller::Flags::antialiased_lines, impeller::PlaygroundSwitches::enable_wide_gamut, impeller::PlaygroundSwitches::flags, flutter::testing::GetCurrentTestName(), impeller::kMetal, impeller::Playground::SetupContext(), impeller::Playground::SetupWindow(), impeller::Playground::ShouldOpenNewPlaygrounds(), impeller::Playground::SupportsBackend(), and impeller::Playground::switches_.

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

TearDown()

void impeller::PlaygroundTest::TearDown ( )

override

Definition at line 79 of file playground_test.cc.

                              {
  TeardownWindow();
}

References impeller::Playground::TeardownWindow().

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