ImguiRenderContent.h

Go to the documentation of this file.

#pragma once
 
#include "Render/IDynamicSceneResource.h"
#include "editor_lib_config.h"
 
#include "ThirdParty/DearImGui.h"
 
#include <Utility/Concurrent/TSPSCRingBuffer.h>
 
#include <array>
#include <cstddef>
#include <vector>
 
namespace ph::editor::render
{
 
class ImguiRenderContent : public IDynamicSceneResource
{
public:
    // All data required by IMGUI to render a frame.
    struct ImguiRenderData
    {
        ImDrawData               drawData;
        std::vector<ImDrawList>  drawListBuffer;
        std::vector<ImDrawList*> drawListPtrBuffer;
        ImGuiViewport            ownerViewportBuffer;
 
        void copyFrom(const ImDrawData& srcDrawData);
    };
 
    using SharedRenderData = TSPSCRingBuffer<
        ImguiRenderData, 
        config::NUM_RENDER_THREAD_BUFFERED_FRAMES + 1>;
 
public:
    ImguiRenderContent();
 
    void update(const RenderThreadUpdateContext& ctx) override;
    void createGHICommands(GHIThreadCaller& caller) override;
    void setupGHI(GHIThreadCaller& caller) override;
    void cleanupGHI(GHIThreadCaller& caller) override;
    EProcessOrder getProcessOrder() const override;
 
    /*
    Can only be called during render update and command generation (on main thread).
    */
    SharedRenderData& getSharedRenderData();
 
    void signifyNewRenderDataIsAvailable();
 
private:
    SharedRenderData m_sharedRenderData;
 
    int m_numAvailableRenderData;
};
 
inline EProcessOrder ImguiRenderContent::getProcessOrder() const
{
    return EProcessOrder::Overlay;
}
 
}// end namespace ph::editor::render