src/ui/scenic/lib/gfx/gfx_system.h

// Copyright 2018 The Fuchsia 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 SRC_UI_SCENIC_LIB_GFX_GFX_SYSTEM_H_
#define SRC_UI_SCENIC_LIB_GFX_GFX_SYSTEM_H_

#include <memory>

#include <trace/event.h>

#include "src/ui/lib/escher/escher.h"
#include "src/ui/scenic/lib/gfx/engine/engine.h"
#include "src/ui/scenic/lib/gfx/engine/gfx_command_applier.h"
#include "src/ui/scenic/lib/gfx/resources/compositor/compositor.h"
#include "src/ui/scenic/lib/scenic/scenic.h"
#include "src/ui/scenic/lib/scenic/system.h"

namespace scenic_impl {
namespace gfx {

class Compositor;
class GfxSystem;
using GfxSystemWeakPtr = fxl::WeakPtr<GfxSystem>;

class GfxSystem : public System,
                  public Scenic::TakeScreenshotDelegateDeprecated,
                  public scheduling::SessionUpdater {
 public:
  static constexpr TypeId kTypeId = kGfx;
  static const char* kName;

  GfxSystem(SystemContext context, Engine* engine, escher::EscherWeakPtr escher, Sysmem* sysmem,
            display::DisplayManager* display_manager);

  GfxSystemWeakPtr GetWeakPtr() { return weak_factory_.GetWeakPtr(); }

  CommandDispatcherUniquePtr CreateCommandDispatcher(CommandDispatcherContext context) override;

  // TODO(fxb/40795): Remove this.
  // |Scenic::TakeScreenshotDelegateDeprecated|
  void TakeScreenshot(fuchsia::ui::scenic::Scenic::TakeScreenshotCallback callback) override;

  // |scheduling::SessionUpdater|
  virtual UpdateResults UpdateSessions(
      const std::unordered_set<scheduling::SessionId>& sessions_to_update,
      zx::time target_presentation_time, zx::time latched_time, uint64_t trace_id) override;

  // |scheduling::SessionUpdater|
  virtual void PrepareFrame(zx::time target_presentation_time, uint64_t trace_id) override;

  // For tests.
  SessionManager* session_manager() { return &session_manager_; }

  static escher::EscherUniquePtr CreateEscher(sys::ComponentContext* app_context);

 private:
  static VkBool32 HandleDebugReport(VkDebugReportFlagsEXT flags,
                                    VkDebugReportObjectTypeEXT objectType, uint64_t object,
                                    size_t location, int32_t messageCode, const char* pLayerPrefix,
                                    const char* pMessage, void* pUserData);

  void DumpSessionMapResources(std::ostream& output,
                               std::unordered_set<GlobalId, GlobalId::Hash>* visited_resources);

  display::DisplayManager* const display_manager_;

  Sysmem* const sysmem_;
  escher::EscherWeakPtr escher_;

  Engine* const engine_;
  SessionManager session_manager_;

  std::optional<CommandContext> command_context_;

  // Tracks the number of sessions returning ApplyUpdateResult::needs_render
  // and uses it for tracing.
  uint64_t needs_render_count_ = 0;
  uint64_t processed_needs_render_count_ = 0;

  fxl::WeakPtrFactory<GfxSystem> weak_factory_;  // must be last
};

}  // namespace gfx
}  // namespace scenic_impl

#endif  // SRC_UI_SCENIC_LIB_GFX_GFX_SYSTEM_H_