GraphicsMemoryManager.h

Go to the documentation of this file.

#pragma once
 
#include <Common/primitive_type.h>
 
#include <cstddef>
#include <limits>
 
namespace ph::editor { class GHIThreadUpdateContext; }
 
namespace ph::editor::ghi
{
 
class GraphicsMemoryBlock;
class GraphicsArena;
 
class GraphicsMemoryManager
{
public:
    virtual ~GraphicsMemoryManager();
 
    virtual GraphicsMemoryBlock* allocHostBlock(uint32 numFramesToLive) = 0;
 
    virtual GraphicsMemoryBlock* allocCustomHostBlock(
        uint32 numFramesToLive, 
        std::size_t blockSize,
        std::size_t blockAlignment) = 0;
 
    virtual void onGHILoad() = 0;
 
    virtual void onGHIUnload() = 0;
 
    virtual void beginFrameUpdate(const GHIThreadUpdateContext& ctx) = 0;
 
    virtual void endFrameUpdate(const GHIThreadUpdateContext& ctx) = 0;
 
    // TODO: arena should guarantee always succeed (custom alloc if cannot fit)
    GraphicsArena newHostArena();
    GraphicsArena newRenderProducerHostArena();
 
public:
    static uint32 equivalentRenderFrameLifetime(uint32 numRenderFramesToLive)
    {
        /* GHI frame may end before render frame ends but can never restart until next render frame
        begins, so we need to increase the number of frames to live to cover for the case that GHI
        frame may end earlier than render frame. Adding 1 frame will suffice for this case, as that
        means the lifetime won't end until next render frame.
        */
        return numRenderFramesToLive + 1;
    }
};
 
}// end namespace ph::editor::ghi