UnrealEngineUWP/Engine/Source/Runtime/Renderer/Private/VT/VirtualTextureSpace.h

// Copyright Epic Games, Inc. All Rights Reserved.

#pragma once

#include "CoreMinimal.h"
#include "VirtualTextureShared.h"
#include "VirtualTexturePhysicalSpace.h"
#include "TexturePageMap.h"
#include "VirtualTextureAllocator.h"
#include "RendererInterface.h"
#include "VirtualTexturing.h"

class FAllocatedVirtualTexture;
class FVirtualTextureSystem;

struct FVTSpaceDescription
{
	uint32 TileSize = 0u;
	uint32 TileBorderSize = 0u;
	uint8 Dimensions = 0u;
	EVTPageTableFormat PageTableFormat = EVTPageTableFormat::UInt16;
	uint8 NumPageTableLayers = 0u;
	uint8 bPrivateSpace = false;
	uint32 MaxSpaceSize = VIRTUALTEXTURE_MAX_PAGETABLE_SIZE;
	uint32 IndirectionTextureSize = 0u;
};

inline bool operator==(const FVTSpaceDescription& Lhs, const FVTSpaceDescription& Rhs)
{
	return Lhs.Dimensions == Rhs.Dimensions &&
		Lhs.TileSize == Rhs.TileSize &&
		Lhs.TileBorderSize == Rhs.TileBorderSize &&
		Lhs.NumPageTableLayers == Rhs.NumPageTableLayers &&
		Lhs.PageTableFormat == Rhs.PageTableFormat &&
		Lhs.bPrivateSpace == Rhs.bPrivateSpace &&
		Lhs.MaxSpaceSize == Rhs.MaxSpaceSize &&
		Lhs.IndirectionTextureSize == Rhs.IndirectionTextureSize;
}
inline bool operator!=(const FVTSpaceDescription& Lhs, const FVTSpaceDescription& Rhs)
{
	return !operator==(Lhs, Rhs);
}

// Virtual memory address space mapped by a page table texture
class FVirtualTextureSpace final : public FRenderResource
{
public:
	static const uint32 LayersPerPageTableTexture = IAllocatedVirtualTexture::LayersPerPageTableTexture;

	FVirtualTextureSpace(FVirtualTextureSystem* InSystem, uint8 InID, const FVTSpaceDescription& InDesc, uint32 InSizeNeeded);
	virtual ~FVirtualTextureSpace();

	inline const FVTSpaceDescription& GetDescription() const { return Description; }
	inline uint32 GetPageTableWidth() const { return CachedPageTableWidth; }
	inline uint32 GetPageTableHeight() const { return CachedPageTableHeight; }
	inline uint8 GetDimensions() const { return Description.Dimensions; }
	inline EVTPageTableFormat GetPageTableFormat() const { return Description.PageTableFormat; }
	inline uint32 GetNumPageTableLayers() const { return Description.NumPageTableLayers; }
	inline uint32 GetNumPageTableTextures() const { return (Description.NumPageTableLayers + LayersPerPageTableTexture - 1u) / LayersPerPageTableTexture; }
	inline uint8 GetID() const { return ID; }

	inline uint32 GetNumPageTableLevels() const { return CachedNumPageTableLevels; }
	inline FVirtualTextureAllocator& GetAllocator() { return Allocator; }
	inline const FVirtualTextureAllocator& GetAllocator() const { return Allocator; }
	inline FTexturePageMap& GetPageMapForPageTableLayer(uint32 PageTableLayerIndex) { check(PageTableLayerIndex < Description.NumPageTableLayers); return PhysicalPageMap[PageTableLayerIndex]; }
	inline const FTexturePageMap& GetPageMapForPageTableLayer(uint32 PageTableLayerIndex) const { check(PageTableLayerIndex < Description.NumPageTableLayers); return PhysicalPageMap[PageTableLayerIndex]; }

	// FRenderResource interface
	virtual void		InitRHI() override;
	virtual void		ReleaseRHI() override;

	inline uint32 AddRef() { return ++NumRefs; }
	inline uint32 Release() { check(NumRefs > 0u); return --NumRefs; }
	inline uint32 GetRefCount() const { return NumRefs; }

	uint32 GetSizeInBytes() const;

	uint32 AllocateVirtualTexture(FAllocatedVirtualTexture* VirtualTexture);

	void FreeVirtualTexture(FAllocatedVirtualTexture* VirtualTexture);

	FRHITextureReference* GetPageTableTexture(uint32 PageTableIndex) const
	{
		check(PageTableIndex < GetNumPageTableTextures());
		return PageTable[PageTableIndex].TextureReferenceRHI.GetReference();
	}

	FRHITextureReference* GetPageTableIndirectionTexture() const
	{
		return PageTableIndirection.TextureReferenceRHI.GetReference();
	}

	void				QueueUpdate( uint8 Layer, uint8 vLogSize, uint32 vAddress, uint8 vLevel, const FPhysicalTileLocation& pTileLocation);
	void				AllocateTextures(FRDGBuilder& GraphBuilder);
	void				FinalizeTextures(FRDGBuilder& GraphBuilder);
	void				ApplyUpdates(FVirtualTextureSystem* System, FRDGBuilder& GraphBuilder);
	void				QueueUpdateEntirePageTable();

	void DumpToConsole(bool verbose);

#if WITH_EDITOR
	void SaveAllocatorDebugImage() const;
#endif // WITH_EDITOR

private:
	FUintPoint GetRequiredPageTableAllocationSize() const;

	static const uint32 TextureCapacity = (VIRTUALTEXTURE_SPACE_MAXLAYERS + LayersPerPageTableTexture - 1u) / LayersPerPageTableTexture;

	struct FTextureEntry
	{
		TRefCountPtr<IPooledRenderTarget> RenderTarget;
		FTextureReferenceRHIRef TextureReferenceRHI;
	};

	FVTSpaceDescription Description;
	
	FVirtualTextureAllocator Allocator;
	FTexturePageMap PhysicalPageMap[VIRTUALTEXTURE_SPACE_MAXLAYERS];

	FTextureEntry PageTable[TextureCapacity];
	TEnumAsByte<EPixelFormat> TexturePixelFormat[TextureCapacity];

	FTextureEntry PageTableIndirection;

	TArray<FPageTableUpdate> PageTableUpdates[VIRTUALTEXTURE_SPACE_MAXLAYERS];

	FBufferRHIRef UpdateBuffer;
	FShaderResourceViewRHIRef UpdateBufferSRV;

	uint32 NumRefs;

	uint8 ID;
	uint32 CachedPageTableWidth;
	uint32 CachedPageTableHeight;
	uint32 CachedNumPageTableLevels;
	bool bNeedToAllocatePageTable;
	bool bNeedToAllocatePageTableIndirection;
	bool bForceEntireUpdate;
};