FMaterialCacheVirtualProducer Class Reference

#include <MaterialCacheVirtualProducer.h>

Inheritance diagram for FMaterialCacheVirtualProducer:

Public Member Functions
	FMaterialCacheVirtualProducer (FScene *Scene, FPrimitiveComponentId InPrimitiveComponentId, const FMaterialCacheTagLayout &TagLayout, const FVTProducerDescription &InProducerDesc)
virtual	~FMaterialCacheVirtualProducer () override=default
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
Public Member Functions inherited from IVirtualTexture
	IVirtualTexture ()
virtual	~IVirtualTexture ()
virtual uint32	GetLocalMipBias (uint8 vLevel, uint32 vAddress) const
virtual void	GatherProducePageDataTasks (FVirtualTextureProducerHandle const &ProducerHandle, FGraphEventArray &InOutTasks) const
virtual void	GatherProducePageDataTasks (uint64 RequestHandle, FGraphEventArray &InOutTasks) const
virtual void	DumpToConsole (bool verbose)
virtual void	OnRequestsCompleted ()

Public Attributes
FMaterialCacheVirtualFinalizer	Finalizer

Constructor & Destructor Documentation

FMaterialCacheVirtualProducer()

FMaterialCacheVirtualProducer::FMaterialCacheVirtualProducer	(	FScene *	Scene,
		FPrimitiveComponentId	InPrimitiveComponentId,
		const FMaterialCacheTagLayout &	TagLayout,
		const FVTProducerDescription &	InProducerDesc
	)

~FMaterialCacheVirtualProducer()

virtual FMaterialCacheVirtualProducer::~FMaterialCacheVirtualProducer ( )

overridevirtualdefault

IVirtualTexture

Member Function Documentation

IsPageStreamed()

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

overridevirtual

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

Implements IVirtualTexture.

ProducePageData()

IVirtualTextureFinalizer * FMaterialCacheVirtualProducer::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 FMaterialCacheVirtualProducer::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.

Member Data Documentation

Finalizer

FMaterialCacheVirtualFinalizer FMaterialCacheVirtualProducer::Finalizer

Single finalizer per producer

---

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

• Engine/Source/Runtime/Renderer/Internal/MaterialCache/MaterialCacheVirtualProducer.h
• Engine/Source/Runtime/Renderer/Private/MaterialCache/MaterialCacheVirtualProducer.cpp