OpenDX/src/dxvk/hud/dxvk_hud.h

#pragma once

#include "../dxvk_device.h"

#include "../util/util_env.h"

#include "dxvk_hud_config.h"
#include "dxvk_hud_devinfo.h"
#include "dxvk_hud_fps.h"
#include "dxvk_hud_renderer.h"
#include "dxvk_hud_stats.h"

namespace dxvk::hud {
  
  /**
   * \brief HUD uniform data
   * Shader data for the HUD.
   */
  struct HudUniformData {
    VkExtent2D surfaceSize;
  };
  
  /**
   * \brief DXVK HUD
   * 
   * Can be used by the presentation backend to
   * display performance and driver information.
   */
  class Hud : public RcObject {
    
  public:
    
    Hud(
      const Rc<DxvkDevice>& device,
      const HudConfig&      config);
    
    ~Hud();
    
    /**
     * \brief Renders the HUD
     * 
     * Recreates the render targets for the HUD
     * in case the surface size has changed.
     * \param [in] size Render target size
     */
    void render(VkExtent2D size);
    
    /**
     * \brief Rendered image
     * 
     * Returns the rendered image from
     * the previous call to \ref render.
     * \returns The image view
     */
    Rc<DxvkImageView> texture() const {
      return m_renderTargetView;
    }
    
    /**
     * \brief Creates the HUD
     * 
     * Creates and initializes the HUD if the
     * \c DXVK_HUD environment variable is set.
     * \param [in] device The DXVK device
     * \returns HUD object, if it was created.
     */
    static Rc<Hud> createHud(
      const Rc<DxvkDevice>& device);
    
  private:
    
    const HudConfig       m_config;
    
    const Rc<DxvkDevice>  m_device;
    const Rc<DxvkContext> m_context;
    
    HudRenderer           m_renderer;
    VkExtent2D            m_surfaceSize = { 0, 0 };
    
    Rc<DxvkBuffer>        m_uniformBuffer;
    Rc<DxvkImage>         m_renderTarget;
    Rc<DxvkImageView>     m_renderTargetView;
    DxvkRenderTargets     m_renderTargetInfo;
    
    HudDeviceInfo         m_hudDeviceInfo;
    HudFps                m_hudFramerate;
    HudStats              m_hudStats;
    
    void render();
    
    Rc<DxvkBuffer> createUniformBuffer();
    
    void updateUniformBuffer();
    void beginRenderPass(bool initFbo);
    void endRenderPass();
    
    void setupFramebuffer(VkExtent2D size);
    void setupConstantState();
    
  };
  
}