GlobalRenderResources.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "RenderResource.h"
 
// A global white texture.
extern RENDERCORE_API FTexture* GWhiteTexture;
 
// A global white texture with an SRV.
extern RENDERCORE_API FTextureWithSRV* GWhiteTextureWithSRV;
 
// A global black texture.
extern RENDERCORE_API FTexture* GBlackTexture;
 
// A global black texture with an SRV.
extern RENDERCORE_API FTextureWithSRV* GBlackTextureWithSRV;
 
// A global black transparent texture.
extern RENDERCORE_API FTexture* GTransparentBlackTexture;
 
// A global black transparent texture with an SRV
extern RENDERCORE_API FTextureWithSRV* GTransparentBlackTextureWithSRV;
 
// A global dummy texture used for manual transition (Ex: when the VS is sampling produce in a previous pass, and needs a barrier)
UE_DEPRECATED(5.7, "This is no longer being used.")
extern RENDERCORE_API FTexture* GDummyTransitionTexture;
 
// An empty vertex buffer with a UAV
extern RENDERCORE_API FVertexBufferWithSRV* GEmptyVertexBufferWithUAV;
 
// An empty uint4 vertex buffer with a UAV
extern RENDERCORE_API FVertexBufferWithSRV* GEmptyVertexBufferUInt4WithUAV;
 
// An empty structured buffer with a UAV
extern RENDERCORE_API FVertexBufferWithSRV* GEmptyStructuredBufferWithUAV;
 
// An empty float4 structured buffer
extern RENDERCORE_API FVertexBufferWithSRV* GBlackFloat4StructuredBufferWithSRV;
 
// An empty float4 vertex buffer
extern RENDERCORE_API FVertexBufferWithSRV* GBlackFloat4VertexBufferWithSRV;
 
// An white vertex buffer with a SRV
extern RENDERCORE_API FVertexBufferWithSRV* GWhiteVertexBufferWithSRV;
 
// An black vertex buffer with a SRV
extern RENDERCORE_API FVertexBufferWithSRV* GBlackVertexBufferWithSRV;
 
// A white vertex buffer used with RenderGraph.
extern RENDERCORE_API FBufferWithRDG* GWhiteVertexBufferWithRDG;
 
// A global black array texture
extern RENDERCORE_API FTexture* GBlackArrayTexture;
 
// A global black volume texture.
extern RENDERCORE_API FTexture* GBlackVolumeTexture;
 
// A global black volume texture, with alpha=1.
extern RENDERCORE_API FTexture* GBlackAlpha1VolumeTexture;
 
// A global black texture<uint>
extern RENDERCORE_API FTexture* GBlackUintTexture;
 
// A global black volume texture<uint> 
extern RENDERCORE_API FTexture* GBlackUintVolumeTexture;
 
// A global white cube texture.
extern RENDERCORE_API FTexture* GWhiteTextureCube;
 
// A global black cube texture.
extern RENDERCORE_API FTexture* GBlackTextureCube;
 
// A global black cube depth texture.
extern RENDERCORE_API FTexture* GBlackTextureDepthCube;
 
// A global black cube array texture.
extern RENDERCORE_API FTexture* GBlackCubeArrayTexture;
 
// A global texture that has a different solid color in each mip-level.
extern RENDERCORE_API FTexture* GMipColorTexture;
 
extern RENDERCORE_API int32 GMipColorTextureMipLevels;
 
// 4: 8x8 cubemap resolution, shader needs to use the same value as preprocessing
extern RENDERCORE_API const uint32 GDiffuseConvolveMipLevel;
 
class FNullColorVertexBuffer : public FVertexBuffer
{
public:
    RENDERCORE_API FNullColorVertexBuffer();
    RENDERCORE_API ~FNullColorVertexBuffer();
 
    RENDERCORE_API virtual void InitRHI(FRHICommandListBase& RHICmdList) override;
    RENDERCORE_API virtual void ReleaseRHI() override;
 
    FShaderResourceViewRHIRef VertexBufferSRV;
};
 
extern RENDERCORE_API TGlobalResource<FNullColorVertexBuffer, FRenderResource::EInitPhase::Pre> GNullColorVertexBuffer;
 
class FNullVertexBuffer : public FVertexBuffer
{
public:
    RENDERCORE_API FNullVertexBuffer();
    RENDERCORE_API ~FNullVertexBuffer();
 
    RENDERCORE_API virtual void InitRHI(FRHICommandListBase& RHICmdList) override;
    RENDERCORE_API virtual void ReleaseRHI() override;
 
    FShaderResourceViewRHIRef VertexBufferSRV;
};
 
extern RENDERCORE_API TGlobalResource<FNullVertexBuffer, FRenderResource::EInitPhase::Pre> GNullVertexBuffer;
 
class FScreenSpaceVertexBuffer : public FVertexBuffer
{
public:
    RENDERCORE_API virtual void InitRHI(FRHICommandListBase& RHICmdList) override;
};
 
extern RENDERCORE_API TGlobalResource<FScreenSpaceVertexBuffer, FRenderResource::EInitPhase::Pre> GScreenSpaceVertexBuffer;
 
class FTileVertexDeclaration : public FRenderResource
{
public:
    RENDERCORE_API FTileVertexDeclaration();
    RENDERCORE_API virtual ~FTileVertexDeclaration();
 
    RENDERCORE_API virtual void InitRHI(FRHICommandListBase& RHICmdList) override;
    RENDERCORE_API virtual void ReleaseRHI() override;
 
    FVertexDeclarationRHIRef VertexDeclarationRHI;
};
 
extern RENDERCORE_API TGlobalResource<FTileVertexDeclaration, FRenderResource::EInitPhase::Pre> GTileVertexDeclaration;
 
class FCubeIndexBuffer : public FIndexBuffer
{
public:
    virtual void InitRHI(FRHICommandListBase& RHICmdList) override;
};
extern RENDERCORE_API TGlobalResource<FCubeIndexBuffer, FRenderResource::EInitPhase::Pre> GCubeIndexBuffer;
 
class FTwoTrianglesIndexBuffer : public FIndexBuffer
{
public:
    virtual void InitRHI(FRHICommandListBase& RHICmdList) override;
};
extern RENDERCORE_API TGlobalResource<FTwoTrianglesIndexBuffer, FRenderResource::EInitPhase::Pre> GTwoTrianglesIndexBuffer;
 
class FEmptyResourceCollection : public FRenderResource
{
public:
    FEmptyResourceCollection() = default;
    ~FEmptyResourceCollection() = default;
 
    RENDERCORE_API virtual void InitRHI(FRHICommandListBase& RHICmdList) override;
    RENDERCORE_API virtual void ReleaseRHI() override;
 
    FRHIResourceCollectionRef ResourceCollection;
};
 
extern RENDERCORE_API TGlobalResource<FEmptyResourceCollection, FRenderResource::EInitPhase::Pre> GEmptyResourceCollection;
 
// FGlobalDynamicVertexBuffer
 
template <typename BufferType>
class TDynamicBuffer;
 
using FDynamicVertexBuffer = TDynamicBuffer<FVertexBuffer>;
using FDynamicIndexBuffer  = TDynamicBuffer<FIndexBuffer>;
 
struct FGlobalDynamicVertexBufferAllocation
{
    uint8* Buffer = nullptr;
 
    FVertexBuffer* VertexBuffer = nullptr;
 
    uint32 VertexOffset = 0;
 
    inline bool IsValid() const
    {
        return Buffer != nullptr;
    }
};
 
class FGlobalDynamicVertexBuffer
{
public:
    using FAllocation = FGlobalDynamicVertexBufferAllocation;
 
    FGlobalDynamicVertexBuffer() = default;
 
    FGlobalDynamicVertexBuffer(FRHICommandListBase& InRHICmdList)
        : RHICmdList(&InRHICmdList)
    {}
 
    ~FGlobalDynamicVertexBuffer()
    {
        Commit();
    }
 
    void Init(FRHICommandListBase& InRHICmdList)
    {
        check(VertexBuffers.IsEmpty());
        RHICmdList = &InRHICmdList;
    }
 
    RENDERCORE_API FAllocation Allocate(uint32 SizeInBytes);
 
    RENDERCORE_API void Commit();
 
    UE_DEPRECATED(5.4, "Use GlobalDynamicBuffer::GarbageCollect instead.")
    void GarbageCollect() {}
 
    RENDERCORE_API bool IsRenderAlarmLoggingEnabled() const;
 
private:
    FRHICommandListBase* RHICmdList = nullptr;
    TArray<FDynamicVertexBuffer*> VertexBuffers;
};
 
struct FGlobalDynamicIndexBufferAllocation
{
    uint8* Buffer = nullptr;
 
    FIndexBuffer* IndexBuffer = nullptr;
 
    uint32 FirstIndex = 0;
 
    inline bool IsValid() const
    {
        return Buffer != nullptr;
    }
};
 
struct FGlobalDynamicIndexBufferAllocationEx : public FGlobalDynamicIndexBufferAllocation
{
    FGlobalDynamicIndexBufferAllocationEx(const FGlobalDynamicIndexBufferAllocation& InRef, uint32 InNumIndices, uint32 InIndexStride)
        : FGlobalDynamicIndexBufferAllocation(InRef)
        , NumIndices(InNumIndices)
        , IndexStride(InIndexStride)
    {}
 
    uint32 NumIndices = 0;
    uint32 IndexStride = 0;
    uint32 MaxUsedIndex = 0;
};
 
class FGlobalDynamicIndexBuffer
{
public:
    using FAllocation = FGlobalDynamicIndexBufferAllocation;
    using FAllocationEx = FGlobalDynamicIndexBufferAllocationEx;
 
    FGlobalDynamicIndexBuffer() = default;
 
    FGlobalDynamicIndexBuffer(FRHICommandListBase& InRHICmdList)
        : RHICmdList(&InRHICmdList)
    {}
 
    ~FGlobalDynamicIndexBuffer()
    {
        Commit();
    }
 
    void Init(FRHICommandListBase& InRHICmdList)
    {
        check(IndexBuffers16.IsEmpty() && IndexBuffers32.IsEmpty());
        RHICmdList = &InRHICmdList;
    }
 
    RENDERCORE_API FAllocation Allocate(uint32 NumIndices, uint32 IndexStride);
 
    template <typename IndexType>
    inline FAllocationEx Allocate(uint32 NumIndices)
    {
        return FAllocationEx(Allocate(NumIndices, sizeof(IndexType)), NumIndices, sizeof(IndexType));
    }
 
    RENDERCORE_API void Commit();
 
private:
    FRHICommandListBase* RHICmdList = nullptr;
    TArray<FDynamicIndexBuffer*> IndexBuffers16;
    TArray<FDynamicIndexBuffer*> IndexBuffers32;
};
 
namespace GlobalDynamicBuffer
{
    RENDERCORE_API void GarbageCollect();
}