UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FRuntimeVirtualTextureRenderResource Class Reference

Classes

struct  FResourceInitDesc
 

Public Member Functions

 FRuntimeVirtualTextureRenderResource ()
 
FVirtualTextureProducerHandle GetProducerHandle () const
 
IAllocatedVirtualTextureGetAllocatedVirtualTexture () const
 
void Init (IVirtualTexture *InProducer, FVTProducerDescription const &InProducerDesc, FResourceInitDesc const &InInitDesc)
 
void Release ()
 

Static Protected Member Functions

static bool FillVTDescriptions (FVirtualTextureProducerHandle const &InProducerHandle, FVTProducerDescription const &InProducerDesc, FResourceInitDesc const &InInitDesc, FAllocatedVTDescription &OutAllocatedVTDesc, FAdaptiveVTDescription &OutAdaptiveVTDesc)
 
static IAllocatedVirtualTextureAllocateVirtualTexture (FRHICommandListBase &RHICmdList, FAllocatedVTDescription const &InAllocatedVTDesc)
 
static void ReleaseVirtualTexture (IAllocatedVirtualTexture *InAllocatedVirtualTexture)
 
static IAdaptiveVirtualTextureAllocateAdaptiveVirtualTexture (FRHICommandListBase &RHICmdList, FAllocatedVTDescription const &InAllocatedVTDesc, FAdaptiveVTDescription const &InAdaptiveVTDesc)
 
static void ReleaseVirtualTexture (IAdaptiveVirtualTexture *InAdaptiveVirtualTexture)
 

Detailed Description

Container for render thread resources created for a URuntimeVirtualTexture object. Any access to the resources should be on the render thread only so that access is serialized with the Init()/Release() render thread tasks.

Constructor & Destructor Documentation

◆ FRuntimeVirtualTextureRenderResource()

FRuntimeVirtualTextureRenderResource::FRuntimeVirtualTextureRenderResource ( )
inline

Member Function Documentation

◆ AllocateAdaptiveVirtualTexture()

static IAdaptiveVirtualTexture * FRuntimeVirtualTextureRenderResource::AllocateAdaptiveVirtualTexture ( FRHICommandListBase RHICmdList,
FAllocatedVTDescription const &  InAllocatedVTDesc,
FAdaptiveVTDescription const &  InAdaptiveVTDesc 
)
inlinestaticprotected

Allocate an adaptive virtual texture in the virtual texture system.

◆ AllocateVirtualTexture()

static IAllocatedVirtualTexture * FRuntimeVirtualTextureRenderResource::AllocateVirtualTexture ( FRHICommandListBase RHICmdList,
FAllocatedVTDescription const &  InAllocatedVTDesc 
)
inlinestaticprotected

Allocate in the virtual texture system.

◆ FillVTDescriptions()

static bool FRuntimeVirtualTextureRenderResource::FillVTDescriptions ( FVirtualTextureProducerHandle const &  InProducerHandle,
FVTProducerDescription const &  InProducerDesc,
FResourceInitDesc const &  InInitDesc,
FAllocatedVTDescription OutAllocatedVTDesc,
FAdaptiveVTDescription OutAdaptiveVTDesc 
)
inlinestaticprotected

Fill the allocated VT descriptions from the producer description. Returns true if this should be allocated as an adaptive virtual texture.

◆ GetAllocatedVirtualTexture()

IAllocatedVirtualTexture * FRuntimeVirtualTextureRenderResource::GetAllocatedVirtualTexture ( ) const
inline

Getter for the virtual texture allocation.

◆ GetProducerHandle()

FVirtualTextureProducerHandle FRuntimeVirtualTextureRenderResource::GetProducerHandle ( ) const
inline

Getter for the virtual texture producer.

◆ Init()

void FRuntimeVirtualTextureRenderResource::Init ( IVirtualTexture InProducer,
FVTProducerDescription const &  InProducerDesc,
FResourceInitDesc const &  InInitDesc 
)
inline

Queues up render thread work to create resources and also releases any old resources.

◆ Release()

void FRuntimeVirtualTextureRenderResource::Release ( )
inline

Queues up render thread work to release resources.

◆ ReleaseVirtualTexture() [1/2]

static void FRuntimeVirtualTextureRenderResource::ReleaseVirtualTexture ( IAdaptiveVirtualTexture InAdaptiveVirtualTexture)
inlinestaticprotected

Release our adaptive virtual texture allocation.

◆ ReleaseVirtualTexture() [2/2]

static void FRuntimeVirtualTextureRenderResource::ReleaseVirtualTexture ( IAllocatedVirtualTexture InAllocatedVirtualTexture)
inlinestaticprotected

Release our virtual texture allocation.


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