ImguiVideoMemoryRuntimeHUD.h

Go to the documentation of this file.

/**
* @file ImguiVideoMemoryRuntimeHUD.h
* @brief The ImguiVideoMemoryRuntimeHUD Class Definitions.
* @author Spices.
*/
 
#pragma once
#include "Core/Core.h"
#include "Slate/Imgui/ImguiUtils.h"
 
namespace Spices {
 
    /*
    * @brief The ImguiVideoMemoryRuntimeHUD Class.
    * This class defines how to render GPU Memory Statics HUD.
    */
    class ImguiVideoMemoryRuntimeHUD : public ImguiSlate
    {
    public:
 
        /**
        * @brief Constructor Function.
        * @param[in] panelName The Slate's name to show.
        * @param[in] frameInfo The Frame Date that in use.
        */
        ImguiVideoMemoryRuntimeHUD(
            const std::string& panelName ,
            FrameInfo&         frameInfo
        );
 
        /**
        * @brief Destructor Function.
        */
        virtual ~ImguiVideoMemoryRuntimeHUD() override = default;
 
        /**
        * @brief This interface is called On SlateSystem Update.
        * @param[in] ts TimeStep.
        */
        virtual void OnUpdate(TimeStep& ts) override {}
 
        /**
        * @brief This interface is called On SlateRenderer Render.
        */
        virtual void OnRender() override;
 
        /**
        * @brief This interface is called on global event function pointer execute.
        * @param[in] event Event.
        */
        virtual void OnEvent(Event& event) override {};
 
    private:
 
        /**
        * @brief Convert bytes to string(GB/MB/KB).
        * @param[in] bytes .
        * @return Returns string.
        */
        std::string ConvertBytestoString(uint64_t bytes);
 
        /**
        * @brief Convert memory flags to string.
        * @param[in] flag VkMemoryHeapFlags.
        * @return Returns string.
        */
        std::string ConvertMemoryFlagtoString(VkMemoryHeapFlags flag);
 
    };
}