FVirtualTextureLevelRedirector Class Reference

#include <VirtualTextureLevelRedirector.h>

Inheritance diagram for FVirtualTextureLevelRedirector:

Public Member Functions
	FVirtualTextureLevelRedirector (IVirtualTexture *InVirtualTexture0, IVirtualTexture *InVirtualTexture1, int32 InTransitionLevel)
virtual	~FVirtualTextureLevelRedirector ()
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 IVirtualTextureFinalizer *	ProducePageData (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 one of two children depending on vLevel. We take ownership of the referenced IVirtualTexture objects meaning that they are destroyed when this object is destroyed.

Constructor & Destructor Documentation

FVirtualTextureLevelRedirector()

FVirtualTextureLevelRedirector::FVirtualTextureLevelRedirector	(	IVirtualTexture *	InVirtualTexture0,
		IVirtualTexture *	InVirtualTexture1,
		int32	InTransitionLevel
	)

~FVirtualTextureLevelRedirector()

FVirtualTextureLevelRedirector::~FVirtualTextureLevelRedirector ( )

virtual

Member Function Documentation

GatherProducePageDataTasks() [1/2]

void FVirtualTextureLevelRedirector::GatherProducePageDataTasks ( FVirtualTextureProducerHandle const &  ProducerHandle, FGraphEventArray &  InOutTasks  ) const

overridevirtual

Collect all task graph events.

Reimplemented from IVirtualTexture.

GatherProducePageDataTasks() [2/2]

void FVirtualTextureLevelRedirector::GatherProducePageDataTasks ( uint64  RequestHandle, FGraphEventArray &  InOutTasks  ) const

overridevirtual

Collect all task graph events related to a request.

Reimplemented from IVirtualTexture.

IsPageStreamed()

bool FVirtualTextureLevelRedirector::IsPageStreamed ( uint8  vLevel, uint32  vAddress  ) const

overridevirtual

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

Implements IVirtualTexture.

ProducePageData()

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

overridevirtual

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

RHICmdList	Used to write any commands required to generate the VT page data
FeatureLevel	The current RHI feature level
ProducerHandle	Handle to this producer
LayerMask	Mask 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
vLevel	The mipmap level of the data
vAddress	Bit-interleaved x,y page indexes
RequestHandle	opaque handle returned from 'RequestPageData'
TargetLayers	Array 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()

FVTRequestPageResult FVirtualTextureLevelRedirector::RequestPageData ( FRHICommandListBase &  RHICmdList, const FVirtualTextureProducerHandle &  ProducerHandle, uint8  LayerMask, uint8  vLevel, uint64  vAddress, EVTRequestPagePriority  Priority  )

overridevirtual

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

ProducerHandle	Handle to this producer, can be used as a UID for this producer for any internal caching mechanisms
LayerMask	Mask of requested layers
vLevel	The mipmap level of the data
vAddress	Bit-interleaved x,y page indexes
Priority	Priority 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 files:

• Engine/Source/Runtime/Engine/Private/VT/VirtualTextureLevelRedirector.h
• Engine/Source/Runtime/Engine/Private/VT/VirtualTextureLevelRedirector.cpp