UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FVirtualTextureAddressRedirect Class Reference
+ Inheritance diagram for FVirtualTextureAddressRedirect:

Public Member Functions

 FVirtualTextureAddressRedirect (IVirtualTexture *InVirtualTexture, FIntPoint InAddressOffset, int32 InLevelOffset)
 
virtual ~FVirtualTextureAddressRedirect ()
 
virtual bool IsPageStreamed (uint8 vLevel, uint32 vAddress) const override
 
virtual FVTRequestPageResult RequestPageData (FRHICommandListBase &RHICmdList, const FVirtualTextureProducerHandle &ProducerHandle, uint8 LayerMask, uint8 vLevel, uint64 vAddress, EVTRequestPagePriority Priority) override
 
virtual IVirtualTextureFinalizerProducePageData (FRHICommandListBase &RHICmdList, ERHIFeatureLevel::Type FeatureLevel, EVTProducePageFlags Flags, const FVirtualTextureProducerHandle &ProducerHandle, uint8 LayerMask, uint8 vLevel, uint64 vAddress, uint64 RequestHandle, const FVTProduceTargetLayer *TargetLayers) override
 
virtual void GatherProducePageDataTasks (FVirtualTextureProducerHandle const &ProducerHandle, FGraphEventArray &InOutTasks) const override
 
virtual void GatherProducePageDataTasks (uint64 RequestHandle, FGraphEventArray &InOutTasks) const override
 
- Public Member Functions inherited from IVirtualTexture
 IVirtualTexture ()
 
virtual ~IVirtualTexture ()
 
virtual uint32 GetLocalMipBias (uint8 vLevel, uint32 vAddress) const
 
virtual void DumpToConsole (bool verbose)
 
virtual void OnRequestsCompleted ()
 

Detailed Description

IVirtualTexture implementation that redirects requests to another IVirtualTexture after having modified vLevel and vAddress. Note that we expect vAddress values only in 32bit range from the VirtualTextureSystem, but we can expand into a genuine 64bit range here to feed our child producer.

Constructor & Destructor Documentation

◆ FVirtualTextureAddressRedirect()

FVirtualTextureAddressRedirect::FVirtualTextureAddressRedirect ( IVirtualTexture InVirtualTexture,
FIntPoint  InAddressOffset,
int32  InLevelOffset 
)
inline

◆ ~FVirtualTextureAddressRedirect()

virtual FVirtualTextureAddressRedirect::~FVirtualTextureAddressRedirect ( )
inlinevirtual

Member Function Documentation

◆ GatherProducePageDataTasks() [1/2]

virtual void FVirtualTextureAddressRedirect::GatherProducePageDataTasks ( FVirtualTextureProducerHandle const &  ProducerHandle,
FGraphEventArray InOutTasks 
) const
inlineoverridevirtual

Collect all task graph events.

Reimplemented from IVirtualTexture.

◆ GatherProducePageDataTasks() [2/2]

virtual void FVirtualTextureAddressRedirect::GatherProducePageDataTasks ( uint64  RequestHandle,
FGraphEventArray InOutTasks 
) const
inlineoverridevirtual

Collect all task graph events related to a request.

Reimplemented from IVirtualTexture.

◆ IsPageStreamed()

virtual bool FVirtualTextureAddressRedirect::IsPageStreamed ( uint8  vLevel,
uint32  vAddress 
) const
inlineoverridevirtual

Whether data for the given page is streamed (e.g. loading from disk).

Implements IVirtualTexture.

◆ ProducePageData()

virtual IVirtualTextureFinalizer * FVirtualTextureAddressRedirect::ProducePageData ( FRHICommandListBase RHICmdList,
ERHIFeatureLevel::Type  FeatureLevel,
EVTProducePageFlags  Flags,
const FVirtualTextureProducerHandle ProducerHandle,
uint8  LayerMask,
uint8  vLevel,
uint64  vAddress,
uint64  RequestHandle,
const FVTProduceTargetLayer TargetLayers 
)
inlineoverridevirtual

Upload page data to the cache, data must have been previously requested, and reported either 'Available' or 'Pending' The system will attempt to call RequestPageData/ProducePageData only once for a given vLevel/vAddress, with all the requested layers set in LayerMask, this is important for certain types of procedural producers that may generate multiple layers of VT data at the same time It's valid to produce 'Pending' page data, but in this case ProducePageData may block until data is ready Only called from render thread

Parameters
RHICmdListUsed to write any commands required to generate the VT page data
FeatureLevelThe current RHI feature level
ProducerHandleHandle to this producer
LayerMaskMask of requested layers; can be used to only produce data for these layers as an optimization, or ignored if all layers are logically produced together
vLevelThe mipmap level of the data
vAddressBit-interleaved x,y page indexes
RequestHandleopaque handle returned from 'RequestPageData'
TargetLayersArray of 'FVTProduceTargetLayer' structs, gives location where each layer should write data
Returns
a 'IVirtualTextureFinalizer' which must be finalized to complete the operation

Implements IVirtualTexture.

◆ RequestPageData()

virtual FVTRequestPageResult FVirtualTextureAddressRedirect::RequestPageData ( FRHICommandListBase RHICmdList,
const FVirtualTextureProducerHandle ProducerHandle,
uint8  LayerMask,
uint8  vLevel,
uint64  vAddress,
EVTRequestPagePriority  Priority 
)
inlineoverridevirtual

Makes a request for the given page data. For data sources that can generate data immediately, it's reasonable for this method to do nothing, and simply return 'Available' Only called from render thread

Parameters
ProducerHandleHandle to this producer, can be used as a UID for this producer for any internal caching mechanisms
LayerMaskMask of requested layers
vLevelThe mipmap level of the data
vAddressBit-interleaved x,y page indexes
PriorityPriority of the request, used to drive async IO/task priority needed to generate data for request
Returns
FVTRequestPageResult describing the availability of the request

Implements IVirtualTexture.


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