UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FVirtualTextureSpace Class Referencefinal

#include <VirtualTextureSpace.h>

+ Inheritance diagram for FVirtualTextureSpace:

Public Member Functions

 FVirtualTextureSpace (FVirtualTextureSystem *InSystem, uint8 InID, const FVTSpaceDescription &InDesc, uint32 InSizeNeeded)
 
virtual ~FVirtualTextureSpace ()
 
const FVTSpaceDescriptionGetDescription () const
 
uint32 GetPageTableWidth () const
 
uint32 GetPageTableHeight () const
 
uint8 GetDimensions () const
 
EVTPageTableFormat GetPageTableFormat () const
 
uint32 GetNumPageTableLayers () const
 
uint32 GetNumPageTableTextures () const
 
uint8 GetID () const
 
uint32 GetNumPageTableLevels () const
 
FVirtualTextureAllocatorGetAllocator ()
 
const FVirtualTextureAllocatorGetAllocator () const
 
FTexturePageMapGetPageMapForPageTableLayer (uint32 PageTableLayerIndex)
 
const FTexturePageMapGetPageMapForPageTableLayer (uint32 PageTableLayerIndex) const
 
virtual void InitRHI (FRHICommandListBase &RHICmdList) override
 
virtual void ReleaseRHI () override
 
uint32 AddRef ()
 
uint32 Release ()
 
uint32 GetRefCount () const
 
void SetReleasedFrame (uint32 InReleasedFrame)
 
uint32 GetReleasedFrame () const
 
uint32 GetSizeInBytes () const
 
uint32 AllocateVirtualTexture (FAllocatedVirtualTexture *VirtualTexture)
 
void FreeVirtualTexture (FAllocatedVirtualTexture *VirtualTexture)
 
FRHITextureReferenceGetPageTableTexture (uint32 PageTableIndex) const
 
FRHITextureReferenceGetPageTableIndirectionTexture () const
 
TRefCountPtr< IPooledRenderTargetGetPageTableIndirectionRenderTarget () const
 
void QueueUpdate (uint8 Layer, uint8 vLogSize, uint32 vAddress, uint8 vLevel, const FPhysicalTileLocation &pTileLocation)
 
void AllocateTextures (FRDGBuilder &GraphBuilder)
 
void FinalizeTextures (FRDGBuilder &GraphBuilder, FRDGExternalAccessQueue &ExternalAccessQueue)
 
void ApplyUpdates (FVirtualTextureSystem *System, FRDGBuilder &GraphBuilder, FRDGExternalAccessQueue &ExternalAccessQueue)
 
void QueueUpdateEntirePageTable ()
 
void DumpToConsole (bool verbose)
 
- Public Member Functions inherited from FRenderResource
RENDERCORE_API FRenderResource ()
 
RENDERCORE_API FRenderResource (ERHIFeatureLevel::Type InFeatureLevel)
 
RENDERCORE_API FRenderResource (const FRenderResource &)
 
RENDERCORE_API FRenderResource (FRenderResource &&)
 
RENDERCORE_API FRenderResourceoperator= (const FRenderResource &Other)
 
RENDERCORE_API FRenderResourceoperator= (FRenderResource &&Other)
 
virtual RENDERCORE_API ~FRenderResource ()
 
virtual RENDERCORE_API void InitResource (FRHICommandListBase &RHICmdList)
 
virtual RENDERCORE_API void ReleaseResource ()
 
RENDERCORE_API void UpdateRHI (FRHICommandListBase &RHICmdList)
 
virtual FString GetFriendlyName () const
 
bool IsInitialized () const
 
int32 GetListIndex () const
 
EInitPhase GetInitPhase () const
 
void SetOwnerName (FName InOwnerName)
 
FName GetOwnerName () const
 
void SetResourceName (FName InResourceName)
 
FName GetResourceName () const
 

Static Public Attributes

static const uint32 LayersPerPageTableTexture = IAllocatedVirtualTexture::LayersPerPageTableTexture
 

Additional Inherited Members

- Public Types inherited from FRenderResource
enum class  EInitPhase : uint8 { Pre , Default , MAX }
 
- Static Public Member Functions inherited from FRenderResource
static RENDERCORE_API void ReleaseRHIForAllResources ()
 
static RENDERCORE_API void InitPreRHIResources ()
 
static RENDERCORE_API void ChangeFeatureLevel (ERHIFeatureLevel::Type NewFeatureLevel)
 
static RENDERCORE_API FName SetScopeName (FName Name)
 
- Public Attributes inherited from FRenderResource
ERenderResourceState ResourceState = ERenderResourceState::Default
 
- Protected Member Functions inherited from FRenderResource
void SetFeatureLevel (const FStaticFeatureLevel InFeatureLevel)
 
const FStaticFeatureLevel GetFeatureLevel () const
 
bool HasValidFeatureLevel () const
 
template<typename T >
FBufferRHIRef CreateRHIBuffer (FRHICommandListBase &RHICmdList, T &InOutResourceObject, uint32 ResourceCount, EBufferUsageFlags InBufferUsageFlags, const TCHAR *InDebugName)
 
void SetInitPhase (EInitPhase InInitPhase)
 
- Static Protected Member Functions inherited from FRenderResource
static RENDERCORE_API FRHICommandListBaseGetImmediateCommandList ()
 

Constructor & Destructor Documentation

◆ FVirtualTextureSpace()

FVirtualTextureSpace::FVirtualTextureSpace ( FVirtualTextureSystem InSystem,
uint8  InID,
const FVTSpaceDescription InDesc,
uint32  InSizeNeeded 
)

◆ ~FVirtualTextureSpace()

FVirtualTextureSpace::~FVirtualTextureSpace ( )
virtual

Member Function Documentation

◆ AddRef()

uint32 FVirtualTextureSpace::AddRef ( )
inline

◆ AllocateTextures()

void FVirtualTextureSpace::AllocateTextures ( FRDGBuilder GraphBuilder)

◆ AllocateVirtualTexture()

uint32 FVirtualTextureSpace::AllocateVirtualTexture ( FAllocatedVirtualTexture VirtualTexture)

◆ ApplyUpdates()

void FVirtualTextureSpace::ApplyUpdates ( FVirtualTextureSystem System,
FRDGBuilder GraphBuilder,
FRDGExternalAccessQueue ExternalAccessQueue 
)

◆ DumpToConsole()

void FVirtualTextureSpace::DumpToConsole ( bool  verbose)

◆ FinalizeTextures()

void FVirtualTextureSpace::FinalizeTextures ( FRDGBuilder GraphBuilder,
FRDGExternalAccessQueue ExternalAccessQueue 
)

◆ FreeVirtualTexture()

void FVirtualTextureSpace::FreeVirtualTexture ( FAllocatedVirtualTexture VirtualTexture)

◆ GetAllocator() [1/2]

FVirtualTextureAllocator & FVirtualTextureSpace::GetAllocator ( )
inline

◆ GetAllocator() [2/2]

const FVirtualTextureAllocator & FVirtualTextureSpace::GetAllocator ( ) const
inline

◆ GetDescription()

const FVTSpaceDescription & FVirtualTextureSpace::GetDescription ( ) const
inline

◆ GetDimensions()

uint8 FVirtualTextureSpace::GetDimensions ( ) const
inline

◆ GetID()

uint8 FVirtualTextureSpace::GetID ( ) const
inline

◆ GetNumPageTableLayers()

uint32 FVirtualTextureSpace::GetNumPageTableLayers ( ) const
inline

◆ GetNumPageTableLevels()

uint32 FVirtualTextureSpace::GetNumPageTableLevels ( ) const
inline

◆ GetNumPageTableTextures()

uint32 FVirtualTextureSpace::GetNumPageTableTextures ( ) const
inline

◆ GetPageMapForPageTableLayer() [1/2]

FTexturePageMap & FVirtualTextureSpace::GetPageMapForPageTableLayer ( uint32  PageTableLayerIndex)
inline

◆ GetPageMapForPageTableLayer() [2/2]

const FTexturePageMap & FVirtualTextureSpace::GetPageMapForPageTableLayer ( uint32  PageTableLayerIndex) const
inline

◆ GetPageTableFormat()

EVTPageTableFormat FVirtualTextureSpace::GetPageTableFormat ( ) const
inline

◆ GetPageTableHeight()

uint32 FVirtualTextureSpace::GetPageTableHeight ( ) const
inline

◆ GetPageTableIndirectionRenderTarget()

TRefCountPtr< IPooledRenderTarget > FVirtualTextureSpace::GetPageTableIndirectionRenderTarget ( ) const
inline

◆ GetPageTableIndirectionTexture()

FRHITextureReference * FVirtualTextureSpace::GetPageTableIndirectionTexture ( ) const
inline

◆ GetPageTableTexture()

FRHITextureReference * FVirtualTextureSpace::GetPageTableTexture ( uint32  PageTableIndex) const
inline

◆ GetPageTableWidth()

uint32 FVirtualTextureSpace::GetPageTableWidth ( ) const
inline

◆ GetRefCount()

uint32 FVirtualTextureSpace::GetRefCount ( ) const
inline

◆ GetReleasedFrame()

uint32 FVirtualTextureSpace::GetReleasedFrame ( ) const
inline

◆ GetSizeInBytes()

uint32 FVirtualTextureSpace::GetSizeInBytes ( ) const

◆ InitRHI()

void FVirtualTextureSpace::InitRHI ( FRHICommandListBase RHICmdList)
overridevirtual

Initializes the RHI resources used by this resource. Called when entering the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

Reimplemented from FRenderResource.

◆ QueueUpdate()

void FVirtualTextureSpace::QueueUpdate ( uint8  Layer,
uint8  vLogSize,
uint32  vAddress,
uint8  vLevel,
const FPhysicalTileLocation pTileLocation 
)

◆ QueueUpdateEntirePageTable()

void FVirtualTextureSpace::QueueUpdateEntirePageTable ( )

◆ Release()

uint32 FVirtualTextureSpace::Release ( )
inline

◆ ReleaseRHI()

void FVirtualTextureSpace::ReleaseRHI ( )
overridevirtual

Releases the RHI resources used by this resource. Called when leaving the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

Reimplemented from FRenderResource.

◆ SetReleasedFrame()

void FVirtualTextureSpace::SetReleasedFrame ( uint32  InReleasedFrame)
inline

Member Data Documentation

◆ LayersPerPageTableTexture

const uint32 FVirtualTextureSpace::LayersPerPageTableTexture = IAllocatedVirtualTexture::LayersPerPageTableTexture
static

The documentation for this class was generated from the following files: