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

#include <AllocatedVirtualTexture.h>

+ Inheritance diagram for FAllocatedVirtualTexture:

Public Member Functions

 FAllocatedVirtualTexture (FRHICommandListBase &RHICmdList, FVirtualTextureSystem *InSystem, uint32 InFrame, const FAllocatedVTDescription &InDesc, FVirtualTextureProducer *const *InProducers, uint32 InBlockWidthInTiles, uint32 InBlockHeightInTiles, uint32 InWidthInBlocks, uint32 InHeightInBlocks, uint32 InDepthInTiles)
 
virtual ~FAllocatedVirtualTexture ()
 
uint32 GetFrameAllocated () const
 
void AssignVirtualAddress (uint32 vAddress)
 
void LockOrUnlockTiles (FVirtualTextureSystem *InSystem, bool bLock) const
 
virtual uint32 GetPersistentHash () const override
 
virtual uint32 GetNumPageTableTextures () const override
 
virtual FRHITextureGetPageTableTexture (uint32 InPageTableIndex) const override
 
virtual FRHITextureGetPageTableIndirectionTexture () const override
 
virtual uint32 GetPhysicalTextureSize (uint32 InLayerIndex) const override
 
virtual FRHITextureGetPhysicalTexture (uint32 InLayerIndex) const override
 
virtual FRHIShaderResourceViewGetPhysicalTextureSRV (uint32 InLayerIndex, bool bSRGB) const override
 
virtual void GetPackedPageTableUniform (FUintVector4 *OutUniform) const override
 
virtual void GetPackedUniform (FUintVector4 *OutUniform, uint32 LayerIndex) const override
 
virtual void Destroy (FVirtualTextureSystem *InSystem) override
 
virtual bool TryMapLockedTiles (FVirtualTextureSystem *InSystem) const override
 
uint32 GetNumUniqueProducers () const
 
const FVirtualTextureProducerHandleGetUniqueProducerHandle (uint32 InProducerIndex) const
 
uint8 GetUniqueProducerMipBias (uint32 InProducerIndex) const
 
uint32 GetNumPageTableLayers () const
 
FVirtualTexturePhysicalSpaceGetPhysicalSpaceForPageTableLayer (uint32 InLayerIndex) const
 
uint32 GetProducerIndexForPageTableLayer (uint32 InLayerIndex) const
 
uint32 GetProducerTextureLayerMaskForPageTableLayer (uint32 InLayerIndex) const
 
uint32 GetProducerPhysicalGroupIndexForPageTableLayer (uint32 InLayerIndex) const
 
- Public Member Functions inherited from IAllocatedVirtualTexture
 IAllocatedVirtualTexture (const FAllocatedVTDescription &InDesc, uint32 InBlockWidthInTiles, uint32 InBlockHeightInTiles, uint32 InWidthInBlocks, uint32 InHeightInBlocks, uint32 InDepthInTiles)
 
virtual void DumpToConsole (bool bVerbose) const
 
const FAllocatedVTDescriptionGetDescription () const
 
const FVirtualTextureProducerHandleGetProducerHandle (uint32 InLayerIndex) const
 
uint32 GetVirtualTileSize () const
 
uint32 GetTileBorderSize () const
 
uint32 GetPhysicalTileSize () const
 
uint32 GetNumTextureLayers () const
 
uint8 GetDimensions () const
 
uint32 GetWidthInBlocks () const
 
uint32 GetHeightInBlocks () const
 
uint32 GetBlockWidthInTiles () const
 
uint32 GetBlockHeightInTiles () const
 
uint32 GetWidthInTiles () const
 
uint32 GetHeightInTiles () const
 
uint32 GetDepthInTiles () const
 
uint32 GetWidthInPixels () const
 
uint32 GetHeightInPixels () const
 
uint32 GetDepthInPixels () const
 
uint32 GetSpaceID () const
 
uint32 GetVirtualAddress () const
 
uint32 GetVirtualPageX () const
 
uint32 GetVirtualPageY () const
 
uint32 GetMaxLevel () const
 
EVTPageTableFormat GetPageTableFormat () const
 

Additional Inherited Members

- Static Public Attributes inherited from IAllocatedVirtualTexture
static const uint32 LayersPerPageTableTexture = 4u
 
- Protected Member Functions inherited from IAllocatedVirtualTexture
virtual ~IAllocatedVirtualTexture ()
 
- Protected Attributes inherited from IAllocatedVirtualTexture
FAllocatedVTDescription Description
 
uint32 BlockWidthInTiles
 
uint32 BlockHeightInTiles
 
uint32 WidthInBlocks
 
uint32 HeightInBlocks
 
uint32 DepthInTiles
 
uint32 FrameDeleted
 
int32 NumRefs
 
bool bIsWaitingToMap
 
EVTPageTableFormat PageTableFormat
 
uint32 SpaceID
 
uint32 MaxLevel
 
uint32 VirtualAddress
 
uint32 VirtualPageX
 
uint32 VirtualPageY
 

Constructor & Destructor Documentation

◆ FAllocatedVirtualTexture()

FAllocatedVirtualTexture::FAllocatedVirtualTexture ( FRHICommandListBase RHICmdList,
FVirtualTextureSystem InSystem,
uint32  InFrame,
const FAllocatedVTDescription InDesc,
FVirtualTextureProducer *const *  InProducers,
uint32  InBlockWidthInTiles,
uint32  InBlockHeightInTiles,
uint32  InWidthInBlocks,
uint32  InHeightInBlocks,
uint32  InDepthInTiles 
)

◆ ~FAllocatedVirtualTexture()

FAllocatedVirtualTexture::~FAllocatedVirtualTexture ( )
virtual

Member Function Documentation

◆ AssignVirtualAddress()

void FAllocatedVirtualTexture::AssignVirtualAddress ( uint32  vAddress)

◆ Destroy()

void FAllocatedVirtualTexture::Destroy ( FVirtualTextureSystem InSystem)
overridevirtual

◆ GetFrameAllocated()

uint32 FAllocatedVirtualTexture::GetFrameAllocated ( ) const
inline

◆ GetNumPageTableLayers()

uint32 FAllocatedVirtualTexture::GetNumPageTableLayers ( ) const
inline

◆ GetNumPageTableTextures()

uint32 FAllocatedVirtualTexture::GetNumPageTableTextures ( ) const
overridevirtual

◆ GetNumUniqueProducers()

uint32 FAllocatedVirtualTexture::GetNumUniqueProducers ( ) const
inline

◆ GetPackedPageTableUniform()

void FAllocatedVirtualTexture::GetPackedPageTableUniform ( FUintVector4 OutUniform) const
overridevirtual

Writes 2x FUintVector4

Implements IAllocatedVirtualTexture.

◆ GetPackedUniform()

void FAllocatedVirtualTexture::GetPackedUniform ( FUintVector4 OutUniform,
uint32  LayerIndex 
) const
overridevirtual

Writes 1x FUintVector4

Implements IAllocatedVirtualTexture.

◆ GetPageTableIndirectionTexture()

FRHITexture * FAllocatedVirtualTexture::GetPageTableIndirectionTexture ( ) const
overridevirtual

◆ GetPageTableTexture()

FRHITexture * FAllocatedVirtualTexture::GetPageTableTexture ( uint32  InPageTableIndex) const
overridevirtual

◆ GetPersistentHash()

virtual uint32 FAllocatedVirtualTexture::GetPersistentHash ( ) const
inlineoverridevirtual

◆ GetPhysicalSpaceForPageTableLayer()

FVirtualTexturePhysicalSpace * FAllocatedVirtualTexture::GetPhysicalSpaceForPageTableLayer ( uint32  InLayerIndex) const
inline

◆ GetPhysicalTexture()

FRHITexture * FAllocatedVirtualTexture::GetPhysicalTexture ( uint32  InLayerIndex) const
overridevirtual

◆ GetPhysicalTextureSize()

uint32 FAllocatedVirtualTexture::GetPhysicalTextureSize ( uint32  InLayerIndex) const
overridevirtual

◆ GetPhysicalTextureSRV()

FRHIShaderResourceView * FAllocatedVirtualTexture::GetPhysicalTextureSRV ( uint32  InLayerIndex,
bool  bSRGB 
) const
overridevirtual

◆ GetProducerIndexForPageTableLayer()

uint32 FAllocatedVirtualTexture::GetProducerIndexForPageTableLayer ( uint32  InLayerIndex) const
inline

◆ GetProducerPhysicalGroupIndexForPageTableLayer()

uint32 FAllocatedVirtualTexture::GetProducerPhysicalGroupIndexForPageTableLayer ( uint32  InLayerIndex) const
inline

◆ GetProducerTextureLayerMaskForPageTableLayer()

uint32 FAllocatedVirtualTexture::GetProducerTextureLayerMaskForPageTableLayer ( uint32  InLayerIndex) const
inline

◆ GetUniqueProducerHandle()

const FVirtualTextureProducerHandle & FAllocatedVirtualTexture::GetUniqueProducerHandle ( uint32  InProducerIndex) const
inline

◆ GetUniqueProducerMipBias()

uint8 FAllocatedVirtualTexture::GetUniqueProducerMipBias ( uint32  InProducerIndex) const
inline

◆ LockOrUnlockTiles()

void FAllocatedVirtualTexture::LockOrUnlockTiles ( FVirtualTextureSystem InSystem,
bool  bLock 
) const

◆ TryMapLockedTiles()

bool FAllocatedVirtualTexture::TryMapLockedTiles ( FVirtualTextureSystem InSystem) const
overridevirtual

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