Flutter Impeller
impeller::interop::testing::PlaygroundTest Class Reference

#include <playground_test.h>

Inheritance diagram for impeller::interop::testing::PlaygroundTest:
impeller::PlaygroundTest impeller::Playground

Public Types

using InteropPlaygroundCallback = std::function< bool(const ScopedObject< Context > &context, const ScopedObject< Surface > &surface)>
 
- 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)>
 

Public Member Functions

 PlaygroundTest ()
 
 ~PlaygroundTest () override
 
 PlaygroundTest (const PlaygroundTest &)=delete
 
PlaygroundTestoperator= (const PlaygroundTest &)=delete
 
void SetUp () override
 
void TearDown () override
 
ScopedObject< ContextCreateContext () const
 
ScopedObject< ContextGetInteropContext ()
 
bool OpenPlaygroundHere (InteropPlaygroundCallback callback)
 
- Public Member Functions inherited from impeller::PlaygroundTest
 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. More...
 
std::shared_ptr< ContextGetContext () const
 
std::shared_ptr< ContextMakeContext () const
 
bool OpenPlaygroundHere (const RenderCallback &render_callback)
 
bool OpenPlaygroundHere (SinglePassCallback pass_callback)
 
std::shared_ptr< TextureCreateTextureForFixture (const char *fixture_name, bool enable_mipmapping=false) const
 
std::shared_ptr< TextureCreateTextureCubeForFixture (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. More...
 
GLProcAddressResolver CreateGLProcAddressResolver () const
 

Additional Inherited Members

- Static Public Member Functions inherited from impeller::Playground
static bool ShouldOpenNewPlaygrounds ()
 
static std::shared_ptr< CompressedImageLoadFixtureImageCompressed (std::shared_ptr< fml::Mapping > mapping)
 
static std::optional< DecompressedImageDecodeImageRGBA (const std::shared_ptr< CompressedImage > &compressed)
 
static std::shared_ptr< TextureCreateTextureForMapping (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 16 of file playground_test.h.

Member Typedef Documentation

◆ InteropPlaygroundCallback

Definition at line 39 of file playground_test.h.

Constructor & Destructor Documentation

◆ PlaygroundTest() [1/2]

impeller::interop::testing::PlaygroundTest::PlaygroundTest ( )
default

◆ ~PlaygroundTest()

impeller::interop::testing::PlaygroundTest::~PlaygroundTest ( )
overridevirtualdefault

Reimplemented from impeller::PlaygroundTest.

◆ PlaygroundTest() [2/2]

impeller::interop::testing::PlaygroundTest::PlaygroundTest ( const PlaygroundTest )
delete

Member Function Documentation

◆ CreateContext()

ScopedObject< Context > impeller::interop::testing::PlaygroundTest::CreateContext ( ) const

Definition at line 23 of file playground_test.cc.

23  {
24  switch (GetBackend()) {
26  FML_CHECK(false) << "Metal not yet implemented.";
27  return nullptr;
29  Playground::GLProcAddressResolver playground_gl_proc_address_callback =
31  ImpellerProcAddressCallback gl_proc_address_callback =
32  [](const char* proc_name, void* user_data) -> void* {
33  return (*reinterpret_cast<Playground::GLProcAddressResolver*>(
34  user_data))(proc_name);
35  };
36  return Adopt<Context>(ImpellerContextCreateOpenGLESNew(
37  ImpellerGetVersion(), gl_proc_address_callback,
38  &playground_gl_proc_address_callback));
39  }
41  FML_CHECK(false) << "Vulkan not yet implemented.";
42  return nullptr;
43  }
44  FML_UNREACHABLE();
45 }

References impeller::Playground::CreateGLProcAddressResolver(), impeller::PlaygroundTest::GetBackend(), impeller::interop::ImpellerContextCreateOpenGLESNew(), impeller::interop::ImpellerGetVersion(), impeller::kMetal, impeller::kOpenGLES, and impeller::kVulkan.

◆ GetInteropContext()

ScopedObject< Context > impeller::interop::testing::PlaygroundTest::GetInteropContext ( )

Definition at line 62 of file playground_test.cc.

62  {
63  if (interop_context_) {
64  return interop_context_;
65  }
66  auto context = Create<Context>(GetContext(), nullptr);
67  if (!context) {
68  return nullptr;
69  }
70  interop_context_ = std::move(context);
71  return interop_context_;
72 }

References impeller::Playground::GetContext().

Referenced by OpenPlaygroundHere().

◆ OpenPlaygroundHere()

bool impeller::interop::testing::PlaygroundTest::OpenPlaygroundHere ( InteropPlaygroundCallback  callback)

Definition at line 47 of file playground_test.cc.

47  {
48  auto context = GetInteropContext();
49  if (!context) {
50  return false;
51  }
52  return Playground::OpenPlaygroundHere([&](RenderTarget& target) -> bool {
53  auto impeller_surface = std::make_shared<impeller::Surface>(target);
54  auto surface = Create<Surface>(*context.Get(), impeller_surface);
55  if (!surface) {
56  return false;
57  }
58  return callback(context, surface);
59  });
60 }

References GetInteropContext(), and impeller::Playground::OpenPlaygroundHere().

◆ operator=()

PlaygroundTest& impeller::interop::testing::PlaygroundTest::operator= ( const PlaygroundTest )
delete

◆ SetUp()

void impeller::interop::testing::PlaygroundTest::SetUp ( )
override

Definition at line 14 of file playground_test.cc.

14  {
16 }

References impeller::PlaygroundTest::SetUp().

◆ TearDown()

void impeller::interop::testing::PlaygroundTest::TearDown ( )
override

Definition at line 19 of file playground_test.cc.

References impeller::PlaygroundTest::TearDown().


The documentation for this class was generated from the following files:
impeller::PlaygroundBackend::kVulkan
@ kVulkan
impeller::interop::ImpellerContextCreateOpenGLESNew
IMPELLER_EXTERN_C ImpellerContext ImpellerContextCreateOpenGLESNew(uint32_t version, ImpellerProcAddressCallback gl_proc_address_callback, void *gl_proc_address_callback_user_data)
Definition: impeller.cc:73
impeller::interop::testing::PlaygroundTest::GetInteropContext
ScopedObject< Context > GetInteropContext()
Definition: playground_test.cc:62
impeller::PlaygroundBackend::kMetal
@ kMetal
impeller::interop::ImpellerGetVersion
IMPELLER_EXTERN_C uint32_t ImpellerGetVersion()
Definition: impeller.cc:68
impeller::PlaygroundTest::SetUp
void SetUp() override
Definition: playground_test.cc:45
impeller::Playground::OpenPlaygroundHere
bool OpenPlaygroundHere(const RenderCallback &render_callback)
Definition: playground.cc:197
impeller::PlaygroundTest::TearDown
void TearDown() override
Definition: playground_test.cc:76
impeller::Playground::CreateGLProcAddressResolver
GLProcAddressResolver CreateGLProcAddressResolver() const
Definition: playground.cc:516
impeller::PlaygroundBackend::kOpenGLES
@ kOpenGLES
impeller::Playground::GetContext
std::shared_ptr< Context > GetContext() const
Definition: playground.cc:90
ImpellerProcAddressCallback
void *IMPELLER_NULLABLE(* ImpellerProcAddressCallback)(const char *IMPELLER_NONNULL proc_name, void *IMPELLER_NULLABLE user_data)
Definition: impeller.h:104
impeller::Playground::GLProcAddressResolver
std::function< void *(const char *proc_name)> GLProcAddressResolver
Definition: playground.h:117
impeller::PlaygroundTest::GetBackend
PlaygroundBackend GetBackend() const
Definition: playground_test.cc:72