RenderDoc.h

Go to the documentation of this file.

#pragma once
#ifdef RENDERDOC_ENABLED
#include <renderdoc_app.h>
#endif
 
#include <string>
#include <vulkan/vulkan_core.h>
 
#include "GLFW/glfw3.h"
#ifdef WIN32
#include <windows.h>
#endif
 
class RenderDoc {
public:
    static RenderDoc& get();
 
    // Core functionality
    bool init();
    void startCapture(VkDevice device) const;
    void endCapture(VkDevice device) const;
    void triggerCapture();
    bool isCapturing() const;
    bool isConnected() const;
 
    // Capture management
    void setCaptureTitle(const std::string& title);
    void setCapturePath(const std::string& pathTemplate);
    void triggerMultiFrameCapture(uint32_t numFrames);
    // Status checking
    void printStatus() const;
    uint32_t getNumCaptures() const;
 
    // UI control
    void launchUI();
    void showUI();
 
    // Options
    void enableCallstacks(bool enable);
    void enableAPIValidation(bool enable);
    void enableOverlay(bool enable);
 
  private:
    RenderDoc() = default;
 
#ifdef RENDERDOC_ENABLED
    RENDERDOC_API_1_1_2* m_api = nullptr;  // Use 1.1.2 as base - compatible with newer versions
#endif
#ifdef WIN32
    HWND m_window = nullptr;
#endif
    bool m_available = false;
};