impeller::Playground Class Reference

#include <playground.h>

Inheritance diagram for impeller::Playground:

Public Types
using	SinglePassCallback = std::function< bool(RenderPass &pass)>

Public Member Functions
	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 Renderer::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
virtual std::unique_ptr< fml::Mapping >	OpenAssetAsMapping (std::string asset_name) const =0
virtual std::string	GetWindowTitle () const =0
fml::Status	SetCapabilities (const std::shared_ptr< Capabilities > &capabilities)
bool	WillRenderSomething () const

Static Public Member Functions
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	ShouldKeepRendering () const
void	SetWindowSize (ISize size)

Protected Attributes
const PlaygroundSwitches	switches_

Detailed Description

Definition at line 50 of file playground.h.

Member Typedef Documentation

SinglePassCallback

using impeller::Playground::SinglePassCallback = std::function<bool(RenderPass& pass)>

Definition at line 52 of file playground.h.

Constructor & Destructor Documentation

Playground()

impeller::Playground::Playground ( PlaygroundSwitches  switches )

explicit

Definition at line 82 of file playground.cc.

                                                  : switches_(switches) {
  InitializeGLFWOnce();
  SetupSwiftshaderOnce(switches_.use_swiftshader);
}

~Playground()

impeller::Playground::~Playground ( )

virtualdefault

Member Function Documentation

CreateTextureCubeForFixture()

std::shared_ptr< Texture > impeller::Playground::CreateTextureCubeForFixture

(

std::array< const char *, 6 >

fixture_names

)

const

Definition at line 467 of file playground.cc.

                                                  {
  std::array<DecompressedImage, 6> images;
  for (size_t i = 0; i < fixture_names.size(); i++) {
    auto image = DecodeImageRGBA(
        LoadFixtureImageCompressed(OpenAssetAsMapping(fixture_names[i])));
    if (!image.has_value()) {
      return nullptr;
    }
    images[i] = image.value();
  }
 
  auto texture_descriptor = TextureDescriptor{};
  texture_descriptor.storage_mode = StorageMode::kHostVisible;
  texture_descriptor.type = TextureType::kTextureCube;
  texture_descriptor.format = PixelFormat::kR8G8B8A8UNormInt;
  texture_descriptor.size = images[0].GetSize();
  texture_descriptor.mip_count = 1u;
 
  auto texture = renderer_->GetContext()->GetResourceAllocator()->CreateTexture(
      texture_descriptor);
  if (!texture) {
    VALIDATION_LOG << "Could not allocate texture cube.";
    return nullptr;
  }
  texture->SetLabel("Texture cube");
 
  for (size_t i = 0; i < fixture_names.size(); i++) {
    auto uploaded =
        texture->SetContents(images[i].GetAllocation()->GetMapping(),
                             images[i].GetAllocation()->GetSize(), i);
    if (!uploaded) {
      VALIDATION_LOG << "Could not upload texture to device memory.";
      return nullptr;
    }
  }
 
  return texture;
}

CreateTextureForFixture()

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

Definition at line 454 of file playground.cc.

                                  {
  auto texture = CreateTextureForMapping(renderer_->GetContext(),
                                         OpenAssetAsMapping(fixture_name),
                                         enable_mipmapping);
  if (texture == nullptr) {
    return nullptr;
  }
  texture->SetLabel(fixture_name);
  return texture;
}

CreateTextureForMapping()

std::shared_ptr< Texture > impeller::Playground::CreateTextureForMapping ( const std::shared_ptr< Context > &  context, std::shared_ptr< fml::Mapping >  mapping, bool  enable_mipmapping = false  )

static

Definition at line 441 of file playground.cc.

                            {
  auto image = Playground::DecodeImageRGBA(
      Playground::LoadFixtureImageCompressed(std::move(mapping)));
  if (!image.has_value()) {
    return nullptr;
  }
  return CreateTextureForDecompressedImage(context, image.value(),
                                           enable_mipmapping);
}

DecodeImageRGBA()

std::optional< DecompressedImage > impeller::Playground::DecodeImageRGBA ( const std::shared_ptr< CompressedImage > &  compressed )

static

Definition at line 379 of file playground.cc.

                                                      {
  if (compressed == nullptr) {
    return std::nullopt;
  }
  // The decoded image is immediately converted into RGBA as that format is
  // known to be supported everywhere. For image sources that don't need 32
  // bit pixel strides, this is overkill. Since this is a test fixture we
  // aren't necessarily trying to eke out memory savings here and instead
  // favor simplicity.
  auto image = compressed->Decode().ConvertToRGBA();
  if (!image.IsValid()) {
    VALIDATION_LOG << "Could not decode image.";
    return std::nullopt;
  }
 
  return image;
}

GetContentScale()

Point impeller::Playground::GetContentScale

(

)

const

Definition at line 191 of file playground.cc.

                                        {
  return impl_->GetContentScale();
}

GetContext()

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

(

)

const

Definition at line 89 of file playground.cc.

                                                    {
  return context_;
}

GetCursorPosition()

Point impeller::Playground::GetCursorPosition

(

)

const

Definition at line 183 of file playground.cc.

                                          {
  return cursor_position_;
}

GetSecondsElapsed()

Scalar impeller::Playground::GetSecondsElapsed

(

)

const

Get the amount of time elapsed from the start of the playground's execution.

Definition at line 195 of file playground.cc.

                                           {
  return (fml::TimePoint::Now().ToEpochDelta() - start_time_).ToSecondsF();
}

GetWindowSize()

ISize impeller::Playground::GetWindowSize

(

)

const

Definition at line 187 of file playground.cc.

                                      {
  return window_size_;
}

GetWindowTitle()

virtual std::string impeller::Playground::GetWindowTitle ( ) const

pure virtual

Implemented in impeller::ComputePlaygroundTest, and impeller::PlaygroundTest.

IsPlaygroundEnabled()

bool impeller::Playground::IsPlaygroundEnabled

(

)

const

Definition at line 151 of file playground.cc.

                                           {
  return switches_.enable_playground;
}

LoadFixtureImageCompressed()

std::shared_ptr< CompressedImage > impeller::Playground::LoadFixtureImageCompressed ( std::shared_ptr< fml::Mapping >  mapping )

static

Definition at line 368 of file playground.cc.

                                       {
  auto compressed_image = CompressedImageSkia::Create(std::move(mapping));
  if (!compressed_image) {
    VALIDATION_LOG << "Could not create compressed image.";
    return nullptr;
  }
 
  return compressed_image;
}

MakeContext()

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

(

)

const

Definition at line 93 of file playground.cc.

                                                     {
  // Playgrounds are already making a context for each test, so we can just
  // return the `context_`.
  return context_;
}

OpenAssetAsMapping()

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

pure virtual

Implemented in impeller::ComputePlaygroundTest, and impeller::PlaygroundTest.

OpenPlaygroundHere() [1/2]

bool impeller::Playground::OpenPlaygroundHere

(

const Renderer::RenderCallback &

render_callback

)

Definition at line 203 of file playground.cc.

                                                   {
  if (!switches_.enable_playground) {
    return true;
  }
 
  if (!render_callback) {
    return true;
  }
 
  if (!renderer_ || !renderer_->IsValid()) {
    return false;
  }
 
  IMGUI_CHECKVERSION();
  ImGui::CreateContext();
  fml::ScopedCleanupClosure destroy_imgui_context(
      []() { ImGui::DestroyContext(); });
  ImGui::StyleColorsDark();
 
  auto& io = ImGui::GetIO();
  io.IniFilename = nullptr;
  io.ConfigFlags |= ImGuiConfigFlags_DockingEnable;
  io.ConfigWindowsResizeFromEdges = true;
 
  auto window = reinterpret_cast<GLFWwindow*>(impl_->GetWindowHandle());
  if (!window) {
    return false;
  }
  ::glfwSetWindowTitle(window, GetWindowTitle().c_str());
  ::glfwSetWindowUserPointer(window, this);
  ::glfwSetWindowSizeCallback(
      window, [](GLFWwindow* window, int width, int height) -> void {
        auto playground =
            reinterpret_cast<Playground*>(::glfwGetWindowUserPointer(window));
        if (!playground) {
          return;
        }
        playground->SetWindowSize(ISize{width, height}.Max({}));
      });
  ::glfwSetKeyCallback(window, &PlaygroundKeyCallback);
  ::glfwSetCursorPosCallback(window, [](GLFWwindow* window, double x,
                                        double y) {
    reinterpret_cast<Playground*>(::glfwGetWindowUserPointer(window))
        ->SetCursorPosition({static_cast<Scalar>(x), static_cast<Scalar>(y)});
  });
 
  ImGui_ImplGlfw_InitForOther(window, true);
  fml::ScopedCleanupClosure shutdown_imgui([]() { ImGui_ImplGlfw_Shutdown(); });
 
  ImGui_ImplImpeller_Init(renderer_->GetContext());
  fml::ScopedCleanupClosure shutdown_imgui_impeller(
      []() { ImGui_ImplImpeller_Shutdown(); });
 
  ImGui::SetNextWindowPos({10, 10});
 
  ::glfwSetWindowSize(window, GetWindowSize().width, GetWindowSize().height);
  ::glfwSetWindowPos(window, 200, 100);
  ::glfwShowWindow(window);
 
  while (true) {
#if FML_OS_MACOSX
    fml::ScopedNSAutoreleasePool pool;
#endif
    ::glfwPollEvents();
 
    if (::glfwWindowShouldClose(window)) {
      return true;
    }
 
    ImGui_ImplGlfw_NewFrame();
 
    Renderer::RenderCallback wrapped_callback =
        [render_callback,
         &renderer = renderer_](RenderTarget& render_target) -> bool {
      ImGui::NewFrame();
      ImGui::DockSpaceOverViewport(ImGui::GetMainViewport(),
                                   ImGuiDockNodeFlags_PassthruCentralNode);
      bool result = render_callback(render_target);
      ImGui::Render();
 
      // Render ImGui overlay.
      {
        auto buffer = renderer->GetContext()->CreateCommandBuffer();
        if (!buffer) {
          return false;
        }
        buffer->SetLabel("ImGui Command Buffer");
 
        if (render_target.GetColorAttachments().empty()) {
          return false;
        }
 
        auto color0 = render_target.GetColorAttachments().find(0)->second;
        color0.load_action = LoadAction::kLoad;
        if (color0.resolve_texture) {
          color0.texture = color0.resolve_texture;
          color0.resolve_texture = nullptr;
          color0.store_action = StoreAction::kStore;
        }
        render_target.SetColorAttachment(color0, 0);
 
        render_target.SetStencilAttachment(std::nullopt);
        render_target.SetDepthAttachment(std::nullopt);
 
        auto pass = buffer->CreateRenderPass(render_target);
        if (!pass) {
          return false;
        }
        pass->SetLabel("ImGui Render Pass");
 
        ImGui_ImplImpeller_RenderDrawData(ImGui::GetDrawData(), *pass);
 
        pass->EncodeCommands();
        if (!renderer->GetContext()->GetCommandQueue()->Submit({buffer}).ok()) {
          return false;
        }
      }
 
      return result;
    };
 
    if (!renderer_->Render(impl_->AcquireSurfaceFrame(renderer_->GetContext()),
                           wrapped_callback)) {
      VALIDATION_LOG << "Could not render into the surface.";
      return false;
    }
 
    if (!ShouldKeepRendering()) {
      break;
    }
  }
 
  ::glfwHideWindow(window);
 
  return true;
}

OpenPlaygroundHere() [2/2]

bool impeller::Playground::OpenPlaygroundHere

(

SinglePassCallback

pass_callback

)

Definition at line 341 of file playground.cc.

                                                                    {
  return OpenPlaygroundHere(
      [context = GetContext(), &pass_callback](RenderTarget& render_target) {
        auto buffer = context->CreateCommandBuffer();
        if (!buffer) {
          return false;
        }
        buffer->SetLabel("Playground Command Buffer");
 
        auto pass = buffer->CreateRenderPass(render_target);
        if (!pass) {
          return false;
        }
        pass->SetLabel("Playground Render Pass");
 
        if (!pass_callback(*pass)) {
          return false;
        }
 
        pass->EncodeCommands();
        if (!context->GetCommandQueue()->Submit({buffer}).ok()) {
          return false;
        }
        return true;
      });
}

SetCapabilities()

fml::Status impeller::Playground::SetCapabilities

(

const std::shared_ptr< Capabilities > &

capabilities

)

Definition at line 515 of file playground.cc.

                                                     {
  return impl_->SetCapabilities(capabilities);
}

SetupContext()

void impeller::Playground::SetupContext	(	PlaygroundBackend	backend,
		const PlaygroundSwitches &	switches
	)

Definition at line 123 of file playground.cc.

                                                                  {
  FML_CHECK(SupportsBackend(backend));
 
  impl_ = PlaygroundImpl::Create(backend, switches);
  if (!impl_) {
    FML_LOG(WARNING) << "PlaygroundImpl::Create failed.";
    return;
  }
 
  context_ = impl_->GetContext();
}

SetupWindow()

void impeller::Playground::SetupWindow

(

)

Definition at line 136 of file playground.cc.

                             {
  if (!context_) {
    FML_LOG(WARNING) << "Asked to set up a window with no context (call "
                        "SetupContext first).";
    return;
  }
  auto renderer = std::make_unique<Renderer>(context_);
  if (!renderer->IsValid()) {
    return;
  }
  renderer_ = std::move(renderer);
 
  start_time_ = fml::TimePoint::Now().ToEpochDelta();
}

SetWindowSize()

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

protected

Definition at line 507 of file playground.cc.

                                         {
  window_size_ = size;
}

ShouldKeepRendering()

bool impeller::Playground::ShouldKeepRendering ( ) const

protectedvirtual

Definition at line 511 of file playground.cc.

                                           {
  return true;
}

ShouldOpenNewPlaygrounds()

bool impeller::Playground::ShouldOpenNewPlaygrounds ( )

static

Definition at line 166 of file playground.cc.

                                          {
  return gShouldOpenNewPlaygrounds;
}

SupportsBackend()

bool impeller::Playground::SupportsBackend ( PlaygroundBackend  backend )

static

Definition at line 99 of file playground.cc.

                                                          {
  switch (backend) {
    case PlaygroundBackend::kMetal:
#if IMPELLER_ENABLE_METAL
      return true;
#else   // IMPELLER_ENABLE_METAL
      return false;
#endif  // IMPELLER_ENABLE_METAL
    case PlaygroundBackend::kOpenGLES:
#if IMPELLER_ENABLE_OPENGLES
      return true;
#else   // IMPELLER_ENABLE_OPENGLES
      return false;
#endif  // IMPELLER_ENABLE_OPENGLES
    case PlaygroundBackend::kVulkan:
#if IMPELLER_ENABLE_VULKAN
      return PlaygroundImplVK::IsVulkanDriverPresent();
#else   // IMPELLER_ENABLE_VULKAN
      return false;
#endif  // IMPELLER_ENABLE_VULKAN
  }
  FML_UNREACHABLE();
}

TeardownWindow()

void impeller::Playground::TeardownWindow

(

)

Definition at line 155 of file playground.cc.

                                {
  if (context_) {
    context_->Shutdown();
  }
  context_.reset();
  renderer_.reset();
  impl_.reset();
}

WillRenderSomething()

bool impeller::Playground::WillRenderSomething

(

)

const

TODO(https://github.com/flutter/flutter/issues/139950): Remove this. Returns true if OpenPlaygroundHere will actually render anything.

Definition at line 520 of file playground.cc.

                                           {
  return switches_.enable_playground;
}

Member Data Documentation

switches_

const PlaygroundSwitches impeller::Playground::switches_

protected

Definition at line 120 of file playground.h.

---

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

• impeller/playground/playground.h
• impeller/playground/playground.cc