mitiru::debug

Namespace catalog extracted from docs/API_CATALOG.md (24 types, 142 items).

Name	Kind	Items
ConsoleLogger	class	1
DebugPanel	class	4
FileLogger	class	3
IGpuTimer	class	5
NullGpuTimer	class	5
GpuProfileScope	class	6
GpuTimer	class	19
GpuTimerScope	class	6
IDebugOverlay	class	10
LogLevel	enum	5
ILogger	class	10
Log	class	3
NullDebugOverlay	class	9
NullLogger	class	1
ProfileSample	struct	5
FrameProfile	struct	3
MemoryStats	struct	4
SystemTiming	struct	2
ProfilerOverlay	class	13
LogSystemLevel	enum	7
SinkType	enum	3
SinkConfig	struct	3
LogSystem	class	6
TracyHelper	class	9

class ConsoleLogger : public ILogger 1

void log(LogLevel level, std::string_view category, std::string_view message) override

class DebugPanel 4

explicit DebugPanel(IDebugOverlay* overlay) noexcept

void draw(const Engine& engine)

void toggle() noexcept

[[nodiscard]] bool isVisible() const noexcept

class FileLogger : public ILogger 3

explicit FileLogger(const std::string& filePath, bool append = false)

[[nodiscard]] bool isOpen() const noexcept

void log(LogLevel level, std::string_view category, std::string_view message) override

class IGpuTimer 5

virtual ~IGpuTimer() = default

virtual void begin(std::string_view name) = 0

virtual void end(std::string_view name) = 0

[[nodiscard]] virtual std::map<std::string, float> getResults() const = 0

virtual void reset() = 0

class NullGpuTimer : public IGpuTimer 5

void begin(std::string_view name) override

void end(std::string_view) override

[[nodiscard]] std::map<std::string, float> getResults() const override

void reset() override

[[nodiscard]] std::size_t sectionCount() const noexcept

class GpuProfileScope 6

GpuProfileScope(IGpuTimer* timer, std::string_view name)

~GpuProfileScope()

GpuProfileScope(const GpuProfileScope&) = delete

GpuProfileScope& operator=(const GpuProfileScope&) = delete

GpuProfileScope(GpuProfileScope&&) = delete

GpuProfileScope& operator=(GpuProfileScope&&) = delete

class GpuTimer 19

enum `Pass : std::uint8_t` { Shadow, Main3D, PostProcess, UI2D, Count }

GpuTimer() noexcept

~GpuTimer()

GpuTimer(const GpuTimer&) = delete

GpuTimer& operator=(const GpuTimer&) = delete

GpuTimer(GpuTimer&&) = delete

GpuTimer& operator=(GpuTimer&&) = delete

bool init(ID3D11Device* device, ID3D11DeviceContext* context)

bool initGL()

bool initNull() noexcept

void shutdown()

void beginFrame()

void beginPass(Pass p)

void endPass(Pass p)

void resolve()

[[nodiscard]] float passMs(Pass p) const noexcept

[[nodiscard]] float totalGpuMs() const noexcept

[[nodiscard]] bool isInitialized() const noexcept

[[nodiscard]] static constexpr std::string_view passName(Pass p) noexcept

class GpuTimerScope 6

GpuTimerScope(GpuTimer& timer, GpuTimer::Pass pass) noexcept

~GpuTimerScope()

GpuTimerScope(const GpuTimerScope&) = delete

GpuTimerScope& operator=(const GpuTimerScope&) = delete

GpuTimerScope(GpuTimerScope&&) = delete

GpuTimerScope& operator=(GpuTimerScope&&) = delete

class IDebugOverlay 10

virtual ~IDebugOverlay() = default

virtual void beginFrame() = 0

virtual void endFrame() = 0

virtual void text(std::string_view label, std::string_view value) = 0

virtual bool slider(std::string_view label, float& value, float min, float max) = 0

virtual bool checkbox(std::string_view label, bool& value) = 0

virtual bool button(std::string_view label) = 0

virtual void separator() = 0

virtual bool beginWindow(std::string_view title) = 0

virtual void endWindow() = 0

enum LogLevel : std::uint8_t 5

Trace = 0

Debug

Info

Warn

Error

class ILogger 10

virtual ~ILogger() = default

virtual void log(LogLevel level, std::string_view category, std::string_view message) = 0

virtual void setMinLevel(LogLevel level) noexcept

[[nodiscard]] LogLevel minLevel() const noexcept

[[nodiscard]] bool shouldLog(LogLevel level) const noexcept

void trace(std::string_view category, std::string_view msg)

void debug(std::string_view category, std::string_view msg)

void info(std::string_view category, std::string_view msg)

void warn(std::string_view category, std::string_view msg)

void error(std::string_view category, std::string_view msg)

class Log 3

[[nodiscard]] static ILogger& get() noexcept

static void setLogger(std::shared_ptr<ILogger> logger)

static void reset()

class NullDebugOverlay : public IDebugOverlay 9

void beginFrame() override

void endFrame() override

void text(std::string_view label, std::string_view value) override

bool slider(std::string_view label, float& value, float min, float max) override

bool checkbox(std::string_view label, bool& value) override

bool button(std::string_view label) override

void separator() override

bool beginWindow(std::string_view title) override

void endWindow() override

class NullLogger : public ILogger 1

void log(LogLevel , std::string_view , std::string_view ) override

struct ProfileSample 5

std::string name

float startTimeMs = 0.0f

float durationMs = 0.0f

int depth = 0

std::uint32_t color = 0xFFFFFFFF

struct FrameProfile 3

std::vector<ProfileSample> samples

float totalFrameMs = 0.0f

float gpuMs = 0.0f

struct MemoryStats 4

std::uint64_t allocated = 0

std::uint64_t freed = 0

std::uint64_t peak = 0

std::uint64_t current = 0

struct SystemTiming 2

std::string name

float durationMs = 0.0f

class ProfilerOverlay 13

explicit ProfilerOverlay(std::size_t historySize = 120) noexcept

void pushFrame(FrameProfile frame)

[[nodiscard]] std::vector<ProfileSample> getFlameGraphData() const

[[nodiscard]] const std::vector<float>& fpsHistory() const noexcept

[[nodiscard]] float averageFps() const noexcept

[[nodiscard]] float minFps() const noexcept

[[nodiscard]] float maxFps() const noexcept

void recordAllocation(std::uint64_t bytes) noexcept

void recordFree(std::uint64_t bytes) noexcept

[[nodiscard]] const MemoryStats& memoryStats() const noexcept

[[nodiscard]] const std::vector<SystemTiming>& systemTimings() const noexcept

[[nodiscard]] const FrameProfile& latestFrame() const noexcept

[[nodiscard]] std::size_t maxHistory() const noexcept

enum LogSystemLevel : std::uint8_t 7

Trace = 0

Debug

Info

Warn

Error

Critical

Off

enum SinkType : std::uint8_t 3

Console

File

Custom

struct SinkConfig 3

SinkType type = SinkType::Console

std::string filePath

std::shared_ptr<ILogger> customLogger

class LogSystem 6

static void init(const std::string& logFile = "", LogSystemLevel level = LogSystemLevel::Info)

static void setLevel(LogSystemLevel level)

static void flush()

static void addSink(const SinkConfig& config)

[[nodiscard]] static LogSystemLevel level() noexcept

static void shutdown()

class TracyHelper 9

[[nodiscard]] static constexpr bool isAvailable() noexcept

static void markFrame() noexcept

static void plotValue([[maybe_unused]] const char* name, [[maybe_unused]] double value) noexcept

static void plotValue([[maybe_unused]] const char* name, [[maybe_unused]] std::int64_t value) noexcept

static void message([[maybe_unused]] std::string_view text) noexcept

static void messageColor([[maybe_unused]] std::string_view text, [[maybe_unused]] std::uint32_t color) noexcept

static void setThreadName([[maybe_unused]] const char* name) noexcept

static void trackAlloc([[maybe_unused]] const void* ptr, [[maybe_unused]] std::size_t size) noexcept

static void trackFree([[maybe_unused]] const void* ptr) noexcept

---

Sourced from docs/API_CATALOG.md, auto-generated by tools/generate_api_catalog.py.