layer.h

#pragma once
 
#include "pixelbullet/core/event.h"
#include "pixelbullet/time/duration.h"
 
#include <cstdint>
#include <string>
 
namespace pixelbullet
{
enum class FrameTimingCategory : std::uint8_t
{
    FocusedSteadyState,
    PlatformActivity,
    Suspended
};
 
struct FrameTimingSample
{
    FrameTimingCategory category = FrameTimingCategory::FocusedSteadyState;
    bool presented = false;
    bool successful_present_interval_valid = false;
    bool swapchain_recreated = false;
    std::uint32_t window_move_callback_count = 0;
    std::uint32_t window_resize_callback_count = 0;
    std::uint32_t focus_callback_count = 0;
    double successful_present_interval_milliseconds = 0.0;
    double application_loop_interval_milliseconds = 0.0;
    double event_poll_and_input_milliseconds = 0.0;
    double layer_update_milliseconds = 0.0;
    double graphics_resource_update_milliseconds = 0.0;
    double render_preparation_milliseconds = 0.0;
    double swapchain_acquire_milliseconds = 0.0;
    double queue_submission_milliseconds = 0.0;
    double present_milliseconds = 0.0;
    double fence_wait_milliseconds = 0.0;
    double swapchain_recreation_milliseconds = 0.0;
    double device_idle_wait_milliseconds = 0.0;
 
    [[nodiscard]] constexpr bool operator==(const FrameTimingSample&) const noexcept = default;
};
 
enum class EventPhase
{
    Early,
    Normal
};
 
class UiFrameLayer
{
public:
    virtual ~UiFrameLayer() = default;
 
    virtual bool BeginUiFrame() = 0;
    virtual void CancelUiFrame() = 0;
};
 
class Layer
{
public:
    explicit Layer(const std::string& name = "layer");
    virtual ~Layer() = default;
 
    virtual void OnAttach()
    {
    }
    virtual void OnDetach()
    {
    }
    virtual void OnUpdate([[maybe_unused]] Duration ts)
    {
    }
    virtual void OnUiFrame()
    {
    }
    virtual void OnFrameTiming([[maybe_unused]] const FrameTimingSample& sample)
    {
    }
    virtual pixelbullet::core::EventResult OnEvent([[maybe_unused]] pixelbullet::core::Event& event)
    {
        return pixelbullet::core::EventResult::Ignored;
    }
    virtual EventPhase GetEventPhase() const
    {
        return EventPhase::Normal;
    }
 
    const std::string& GetName() const
    {
        return debug_name_;
    }
 
protected:
    std::string debug_name_;
};
} // namespace pixelbullet