redgpu/ezEngine: An open source C++ game engine.

Code/EnginePlugins/RenderDocPlugin/RenderDocSingleton.h

39 строк2 KB

Benjamin Thaut

HeaderChecker utility, removal of windows.h from ezFoundation public includes. Differentiate between public and internal headers in ezFoundation

14 июн 2019, 18:44

14 июн 2019, 18:444c5f645

#pragma once

#include <Foundation/Configuration/Plugin.h>
#include <Foundation/Configuration/Singleton.h>
#include <GameEngine/Interfaces/FrameCaptureInterface.h>
#include <RenderDocPlugin/RenderDocPluginDLL.h>

struct RENDERDOC_API_1_4_0;

/// \brief RenderDoc implementation of the ezFrameCaptureInterface interface
///
/// Adds support for capturing frames through RenderDoc.
/// When the plugin gets loaded, an ezRenderDoc instance is created and initialized.
/// It tries to find a RenderDoc DLL dynamically, so for initialization to succeed,
/// the DLL has to be available in some search directory (e.g. binary folder or PATH).
/// If an outdated RenderDoc DLL is found, initialization will fail and the plugin will be deactivated.
///
/// For interface documentation see \ref ezFrameCaptureInterface
class EZ_RENDERDOCPLUGIN_DLL ezRenderDoc : public ezFrameCaptureInterface
{
  EZ_DECLARE_SINGLETON_OF_INTERFACE(ezRenderDoc, ezFrameCaptureInterface);

public:
  ezRenderDoc();
  virtual ~ezRenderDoc();

  virtual bool IsInitialized() const override;
  virtual void SetAbsCaptureFilePathTemplate(const char* szFilePathTemplate) override;
  virtual const char* GetAbsCaptureFilePathTemplate() const override;
  virtual void StartFrameCapture(ezWindowHandle hWnd) override;
  virtual bool IsFrameCapturing() const override;
  virtual void EndFrameCaptureAndWriteOutput(ezWindowHandle hWnd) override;
  virtual void EndFrameCaptureAndDiscardResult(ezWindowHandle hWnd) override;
  virtual ezResult GetLastAbsCaptureFileName(ezStringBuilder& out_sFileName) const override;

private:
  RENDERDOC_API_1_4_0* m_pRenderDocAPI = nullptr;
  ezMinWindows::HMODULE m_HandleToFree = nullptr;
};