blob: f57ceb2c543a21dc162d3034bc3bd9681a8a51ec [file] [log] [blame]
// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef FLUTTER_IMPELLER_GOLDEN_TESTS_GOLDEN_PLAYGROUND_TEST_H_
#define FLUTTER_IMPELLER_GOLDEN_TESTS_GOLDEN_PLAYGROUND_TEST_H_
#include <memory>
#include "flutter/impeller/aiks/aiks_context.h"
#include "flutter/impeller/playground/playground.h"
#include "flutter/impeller/renderer/render_target.h"
#include "flutter/testing/testing.h"
#include "impeller/typographer/typographer_context.h"
#include "third_party/imgui/imgui.h"
#if FML_OS_MACOSX
#include "flutter/fml/platform/darwin/scoped_nsautorelease_pool.h"
#endif
namespace impeller {
class GoldenPlaygroundTest
: public ::testing::TestWithParam<PlaygroundBackend> {
public:
using AiksPlaygroundCallback =
std::function<std::optional<Picture>(AiksContext& renderer)>;
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);
static bool ImGuiBegin(const char* name,
bool* p_open,
ImGuiWindowFlags flags);
std::shared_ptr<Texture> CreateTextureForFixture(
const char* fixture_name,
bool enable_mipmapping = false) const;
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;
[[nodiscard]] fml::Status SetCapabilities(
const std::shared_ptr<Capabilities>& capabilities);
/// TODO(https://github.com/flutter/flutter/issues/139950): Remove this.
/// Returns true if `OpenPlaygroundHere` will actually render anything.
bool WillRenderSomething() const { return true; }
protected:
void SetWindowSize(ISize size);
private:
#if FML_OS_MACOSX
// This must be placed first so that the autorelease pool is not destroyed
// until the GoldenPlaygroundTestImpl has been destructed.
fml::ScopedNSAutoreleasePool autorelease_pool_;
#endif
std::shared_ptr<TypographerContext> typographer_context_;
struct GoldenPlaygroundTestImpl;
// This is only a shared_ptr so it can work with a forward declared type.
std::shared_ptr<GoldenPlaygroundTestImpl> pimpl_;
GoldenPlaygroundTest(const GoldenPlaygroundTest&) = delete;
GoldenPlaygroundTest& operator=(const GoldenPlaygroundTest&) = delete;
};
} // namespace impeller
#endif // FLUTTER_IMPELLER_GOLDEN_TESTS_GOLDEN_PLAYGROUND_TEST_H_