DynamicBufferAllocator.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*==============================================================================
DynamicBufferAllocator.h: Classes for allocating transient rendering data.
==============================================================================*/
 
#pragma once
 
#include "Containers/Array.h"
#include "HAL/PlatformMath.h"
#include "RHI.h"
#include "RHIUtilities.h"
#include "RenderResource.h"
#include "Async/Mutex.h"
 
struct FDynamicReadBufferPool;
 
struct FDynamicAllocReadBuffer : public FDynamicReadBuffer
{
    int32 AllocatedByteCount = 0;
    int32 NumFramesUnused = 0;
 
    TArray<FShaderResourceViewRHIRef> SubAllocations;
    
    UE_DEPRECATED(5.3, "Lock now requires a command list.")
    void Lock() { Lock(FRHICommandListImmediate::Get()); }
    
    UE_DEPRECATED(5.3, "Lock now requires a command list.")
    void Unlock() { Unlock(FRHICommandListImmediate::Get()); }
 
    void Lock(FRHICommandListBase& RHICmdList)
    {
        SubAllocations.Reset();
        FDynamicReadBuffer::Lock(RHICmdList);
    }
 
    void Unlock(FRHICommandListBase& RHICmdList)
    {
        FDynamicReadBuffer::Unlock(RHICmdList);
        AllocatedByteCount = 0;
        NumFramesUnused = 0;
    }
};
 
class FGlobalDynamicReadBuffer : public FRenderResource
{
public:
    struct FAllocation
    {
        uint8* Buffer;
        FDynamicAllocReadBuffer* ReadBuffer;
 
        FRHIShaderResourceView* SRV;
 
        FAllocation()
            : Buffer(NULL)
            , ReadBuffer(NULL)
        {
        }
 
        inline bool IsValid() const
        {
            return Buffer != NULL;
        }
    };
 
    RENDERCORE_API FGlobalDynamicReadBuffer();
    RENDERCORE_API ~FGlobalDynamicReadBuffer();
    
    RENDERCORE_API FAllocation AllocateHalf(uint32 Num);
    RENDERCORE_API FAllocation AllocateFloat(uint32 Num);
    RENDERCORE_API FAllocation AllocateInt32(uint32 Num);
    RENDERCORE_API FAllocation AllocateUInt32(uint32 Num);
 
    RENDERCORE_API void Commit(FRHICommandListImmediate& RHICmdList);
 
    UE_DEPRECATED(5.3, "Commit now requires a command list.")
    void Commit() { Commit(FRHICommandListImmediate::Get()); }
 
    RENDERCORE_API bool IsRenderAlarmLoggingEnabled() const;
 
protected:
    RENDERCORE_API virtual void InitRHI(FRHICommandListBase& RHICmdList) override;
    RENDERCORE_API virtual void ReleaseRHI() override;
    RENDERCORE_API void Cleanup();
    RENDERCORE_API void IncrementTotalAllocations(uint32 Num);
 
    template<EPixelFormat Format, typename Type>
    FAllocation AllocateInternal(FDynamicReadBufferPool* BufferPool, uint32 Num);
 
    UE::FMutex Mutex;
    FRHICommandListBase* RHICmdList = nullptr;
 
    FDynamicReadBufferPool* HalfBufferPool;
    FDynamicReadBufferPool* FloatBufferPool;
    FDynamicReadBufferPool* Int32BufferPool;
    FDynamicReadBufferPool* UInt32BufferPool;
 
    size_t TotalAllocatedSinceLastCommit;
};