Program Listing for File GUIRendererSharedVars.ixx

↰ Return to documentation for file (Src/GraphicsEngineVulkan/renderer/GUIRendererSharedVars.ixx)

module;

#include <array>

export module kataglyphis.vulkan.gui_renderer_shared_vars;

export namespace Kataglyphis::VulkanRendererInternals::FrontendShared {
enum class RasterizationMode { Forward, Deferred };

// Passes bracketed by GPU timestamp pairs in VulkanRenderer::record_commands.
// "Main" is forward/deferred rasterization plus the optional ray-/path-tracing
// stage that post-processes the raster result; "Post" includes the GUI draw
// (ImGui renders inside the post render pass).
enum class GpuTimedPass : int { Clouds = 0, ShadowCascades, Main, Sky, Post, Count };

// Single source of truth for the pass count: bumping this table is the only
// edit needed to add a pass, and the static_asserts below catch every other
// table that must stay in step with it.
inline constexpr std::array GPU_TIMED_PASS_NAMES = std::to_array<const char *>({
    "Clouds (compute)",
    "Shadow cascades",
    "Main (raster/RT)",
    "Sky",
    "Post + GUI",
});
inline constexpr int GPU_TIMED_PASS_COUNT = static_cast<int>(GPU_TIMED_PASS_NAMES.size());

// Machine-readable identifiers for the same passes, used as JSON keys by the
// KATAGLYPHIS_GPU_TIMING_JSON export. Separate from the display names above:
// those may be reworded for the GUI at will, while these are diffed between
// runs by tooling and must stay stable.
inline constexpr std::array GPU_TIMED_PASS_EXPORT_NAMES = std::to_array<const char *>({
    "Clouds",
    "ShadowCascades",
    "Main",
    "Sky",
    "Post",
});

static_assert(GPU_TIMED_PASS_EXPORT_NAMES.size() == GPU_TIMED_PASS_NAMES.size(),
  "display and export name tables must stay parallel");
static_assert(
  static_cast<int>(GpuTimedPass::Count) == GPU_TIMED_PASS_COUNT, "GpuTimedPass::Count must track the pass name table");

struct GpuTimings
{
    // false when the graphics queue family reports timestampValidBits == 0.
    bool supported = false;
    std::array<float, GPU_TIMED_PASS_COUNT> pass_ms = [] {
        std::array<float, GPU_TIMED_PASS_COUNT> a{};
        a.fill(-1.0F);
        return a;
    }();
};
static_assert(std::tuple_size_v<decltype(GpuTimings::pass_ms)> == GPU_TIMED_PASS_NAMES.size(),
  "GpuTimings::pass_ms must have one slot per timed pass");

struct VisibilityStats
{
    unsigned int meshes_drawn = 0;
    unsigned int meshes_total = 0;
    unsigned int shadow_casters_drawn = 0;
    unsigned int shadow_casters_total = 0;
};

struct GUIRendererSharedVars
{
    RasterizationMode rasterizationMode = RasterizationMode::Forward;

    bool raytracing = false;
    bool pathTracing = false;

    bool shader_hot_reload_triggered = false;
    bool frustum_culling_enabled = true;

    // Per-pass GPU timings, written by the renderer, read by the GUI.
    GpuTimings gpuTimings;

    VisibilityStats visibility;

    // Path-tracing quality controls. Both were hardcoded in the kernel (8/8,
    // with stale comments claiming 64/32); changing either mid-run resets the
    // accumulation history - a mean over two different estimators is biased.
    int pathTracingSamplesPerPixel = 8;
    int pathTracingMaxBounces = 8;
};
}// namespace Kataglyphis::VulkanRendererInternals::FrontendShared